Installing
Creating your parameters file
The installer uses the the values provided in params.yml
to configure the application when installing. If no params.yml file exists, the command will prompt for every configuration.
Two example params.yml are distributed with the installer:
params.yml-WINDOWSparams.yml-LINUX
Copy the params.yml-LINUX to create params.yml in the same folder.
The parameters are explained below:
General
| Value | Notes |
|---|---|
installPath | Absolute path to the directory you wish to install Jadu into, typically /var/www/jadu |
packagePath | Absolute path to installation package zip file (e.g. /home/me/21.0.2/jadui.zip) |
System
| Value | Notes |
|---|---|
user | System user to own installation files, typically jadu. |
group | System user group to own installation files, typically jadu-www |
Server
| Value | Notes |
|---|---|
| host | Host name of the Server |
| host_alias | Host name alias of the Server |
| tls_chain | Absolute path of the TLS chain file. this will be used in setting up the secure site |
| tls_key | Absolute path of the TLS key file. this will be used in setting up the secure site |
| tls_cert | Absolute path of the TLS cert file. this will be used in setting up the secure site |
Database
| Value | Notes |
|---|---|
| name | database name |
| driver | database driver |
| hostname | database hostname |
| port | database port |
You will also need to specify usernames and passwords for the database users. We recommend using jadu, jaduGU and jaduGM here.
Usernames and passwords must consist only of letters and digits (A–Z, a–z, 0–9). Special characters, spaces, and symbols are not permitted. This will prevent possible issues with the post installation actions.
Check your setup
Before you install it is highly recommended to run the check-setup command.
$ php installer.phar check-setup
Running this command will check for some mandatory modules, make sure all the checks pass. If any of the checks fails then you will not be able to proceed with installation unless the failure is fixed.
When checking a load balanced environment's application-only server, you must manually update the necessary database configuration in params.yml for connecting to the external database server to ensure checks pass. Refer to the database section for your plaform in params.yml
Run the installer
To install the application use the install command:
$ php installer.phar install
If you want verbose debugging messages to be shown during the installation then you can use -v, -vv or -vvv options.
After successful installation you will be able to visit the site [hostname]/jadu and start setting up the application.