Automated installation of eZ Publish

5.X=

Installing eZ Platform?

This page covers install of eZ Publish 5.x (includi= ng community versions like v2014.11), for eZ Platform= see INSTALL.md bundled with t= he installation.

Depending on the target system, please refer to either "Installing eZ P= ublish on a Linux/UNIX based system" or "Installing eZ Publish on Windows" for infor= mation other steps needed to do an installation, the step below is to be do= ne before executing the setup wizard.

C= onfiguring the kickstart system

The behavior of the automated installation is controlled by the "k= ickstart.ini" configuration file. This file makes it possible to spe= cify parameters for each installation step of the web based setup wizard. F= or example, by providing the database connection parameters, the correspond= ing setup wizard step will have the input forms pre-filled. It is also poss= ible to instruct the wizard to skip certain steps.

Initialization

Create a copy of the "ezpublish_legacy/kickstart.ini-= dist" file (located in the root of your eZ Publish installation) and= make sure that the copy is named "ezpublish_legacy/kick= start.ini" (located in the root of eZ Publish).

The following example shows how this can be done on a Linux/UNIX based s= ystem:

Navigate into the eZ Publish directory:
=20
```
$ cd /path/to/ezpublish_legacy/
```
=20
Copy and rename the configuration file:
=20
```
$ cp kickstart.ini-dist kickstart.ini
```
=20

Security issues<= /h4>
The web server must have read access to the "`kickstart.ini`"= file during the installation process. This might become a security problem= at a later stage if the file contains usernames, passwords, etc. To preven= t this from happening, it is recommended to do one of the following:

Remove the file when the installation has completed.

Use rewrite rules to make sure that it is not readable from outside.

Configurati= on blocks

The "kickstart.ini" file contains a configuration block for= every step of the setup wizard. The block names are encapsulated by square= brackets. The following list shows an overview of the available blocks.

[email_settings]
[database_choice]
[database_init]
[language_options]
[site_types]
[site_access]
[site_details]
[site_admin]
[security]
[registration]

In the default kickstart file, everything is commented out. The blocks a= nd the corresponding settings have to be uncommented in order to take effec= t. This can be done by removing the hash ("#") characters from the start of= the lines that you should be activated. Make sure that there are no leadin= g whitespace characters at the start of the lines.

Package selection

If you want configure the package to install, in [site_types].Site= _package, please ensure you set a valid package identifier.
Valid values are

ezdemo_site

ezdemo_site_clean

If setting an invalid package identifier, unexpected issues can occur.&n= bsp;

Configu= ration parameters

Each parameter takes a text string as an input value. Some parameters ar= e able to handle an array of strings. The following examples demonstrate th= e two parameter types.

Single parameter:

=20
Server=3Dwww.example.com
=20

Array parameter:

=20
Title[] Title[news]=3DThe news site Title[forums]=3DThe forum site
=20

Docume= ntation and examples

The "kickstart.ini" file contains documentation in the file= itself. Please refer to the embedded instructions and examples for a detai= led explanation of the steps. The following table shows how the examples / = inline instructions deal with required and optional parameters.

Syntax

Description

<value>

Angle brackets indicate that the parameter va= lue is required, example:
#= Server=3D<hostname>

[value]

Squared brackets indicate that the parameter = value is optional, example:
#FirstName=3D[string]

A parameter will only take effect if it has been uncommented. Remove the= leading hash ("#") and make sure that there ar no whitespace characters at= the start of the lines that include the uncommented parameters.

Skipping steps
A step can be skipped by uncommenting and setting the "Continue" parameter to "true". This parameter can be used for each= step / block. The following table shows the outcome for the different conf= igurations of the "Continue" parameter.
Assignment Result Continue=3Dfalse The step will be shown and the input values w= ill be pre-filled with the values (if any) defined in the "kickstart.ini" c= onfiguration file. This is the same as when the "Continue" par= ameter is missing or if it has been commented out. Continue=3Dtrue The system will automatically use the values = defined in the kickstart file and thus the step will not be shown. However,= if something goes wrong (missing or wrong values, etc.), the step will be = shown.

Assignment	Result
`Continue=3Dfalse`	The step will be shown and the input values w= ill be pre-filled with the values (if any) defined in the "kickstart.ini" c= onfiguration file. This is the same as when the "`Continue`" par= ameter is missing or if it has been commented out.
`Continue=3Dtrue`	The system will automatically use the values = defined in the kickstart file and thus the step will not be shown. However,= if something goes wrong (missing or wrong values, etc.), the step will be = shown.