Kickstart
Table of contents:
About
An automated eZ publish configuration system
Configuration
...
Example kickstart.ini
...
Example kickstart.ini-dist
# Kickstart configuration for the setup wizard # # DESCRIPTION # # In this file, installation parameters for each step # in the setup wizard can be specified. For example, by # providing the database connection parameters here, the # corresponding graphical user interface asking for the # database parameters will have the input forms pre-filled # or be skipped, using the values provided here. # # USAGE # # Initialization: # # Copy this file as kickstart.ini to the root of your # eZ publish installation to enable this functionality. # # Installation Steps: # # For each step in the setup wizard asking for user input, # there exists a corresponding configuration block in this # file. The name of a configuration block is placed within # squared brackets. # # The available blocks are: # email_settings # database_choice # database_init # language_options # site_types # site_access # site_details # site_admin # security # registration # # Uncomment the blocks that you want kickstarted and # modify their parameter values as shown below. # # Parameter Values: # # Each parameter value is explained in details within a # configuration block. # # As a general convention, the following syntax is being # used to identify mandatory and optional parameters: # <string> - Angle brackets mean that this parameter value # is mandatory # [string] - Squared brackets mean that this parameter value # is optional # # "Continue" Parameter: # # The "Continue" parameter specifies whether a certain step # in the setup wizard should be skipped: # Continue=false - Show the interface, pre-filled with the # values defined in kickstart.ini. This is the # default behaviour if "Continue" is commented. # Continue=true - Do not show the interface, instead continue # to the next one and use the values defined # in the kickstart configuration file. # # TROUBLESHOOTING # # Remove all leading whitespaces from uncommented # configuration blocks or parameters - otherwise the # settings will not be read properly by eZ publish. # # Do not mix up optional parameter values and configuration # blocks, just because both use squared brackets! Optional # parameter values only appear after the equal (=) sign. #[email_settings] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Type=<email-type> ## Type of email handler ## <email-type>: ## - mta - Use Sendmail/MTA ## - smtp - Use SMTP #Type=mta ## Server=<hostname> ## Which server to use for SMTP #Server= ## User=<username> ## Which user to use for SMTP #User= ## Password=<hostname> ## Which password to use for SMTP #Password= #[database_choice] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Type=<database-system> ## Which database system to use ## <database-system>: ## - mysql - Use mysql ## - postgresql - Use postgresql ## other values are possible if provided by extension #Type=mysql #[database_init] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Server=<hostname> ## Which hostname has the database server #Server=localhost ## Database=<database> ## Which database to use #Database=ezp35test ## User=<username> ## Which user should be used in database #User=root ## Server=<password> ## Which password should be used for user #Password= ## Socket=<socket-path> ## Path to socket or empty for no socket #Socket= #[language_options] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Primary=<locale> ## The primary language for the site #Primary=eng-GB ## Languages[]=<locale> ## Additional languages #Languages[] ## EnableUnicode=true|false ## If set to true it will setup site using Unicode (utf-8) #EnableUnicode=true #[site_types] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Site_package=<identifier> ## Which site package to install, package identifier #Site_package=news_site #[site_access] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Access=<access-type> ## <access-type>: ## - url - Use url/path for matching ## - port - Use port for matching ## - hostname - Use hostname for matching #Access=url #[site_details] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Title=<string> ## The site title ## if not supplied it uses the site package name #Title=My cool new site ## URL=<url> ## The URL to use ## if not supplied it will generate it from the current url #URL= ## Access=<string> ## The access name to use for user site ## if not supplied it will use site identifier #Access=news ## AdminAccess=<string> ## The access name to use for admin site ## if not supplied it will use site identifier + _admin #AdminAccess=news_admin ## AccessPort=<number> ## The access port to use for user page #AccessPort=8080 ## AdminAccessPort=<number> ## The access port to use for admin page #AdminAccessPort=8081 ## AccessHostname=<url> ## The access hostname to use for user page #AccessHostname=news.test.com ## AdminAccessHostname=<url> ## The access hostname to use for admin page #AdminAccessHostname=news-admin.test.com ## Database=<databasename> ## The database name to use for site #Database=ezp39test ## DatabaseAction=<action> ## What to do with the database, can be one of: ## <action>: ## - ignore ## Try to add entries without cleaning up ## - remove ## Clean up entries and add new ones ## - skip ## Do not insert database schema + data #DatabaseAction=remove #[site_admin] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## FirstName=[string] ## The first name of the administrator user #FirstName=God ## LastName=[string] ## The first name of the administrator user #LastName=Like ## Email=[string] ## The email address of the administrator user #Email=[email protected] ## Password=[string] ## The password of the administrator user #Password=publish #[security] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true #[registration] ## Continue=<true|false> ## Whether this step should continue after reading the data #Continue=true ## Comments=<string> ## Comment string to add to registration email #Comments= ## Send=<boolean> ## Whether to send registration email or not #Send=false </pre>