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-WINDOWS to create params.yml in the same folder.
The parameters are explained below:
General
| Value | Notes |
|---|---|
installPath | Absolute path to the folder you wish to install Jadu into. |
packagePath | Absolute path to installation package zip file (e.g. D:\Users\Me\21.0.2\jadui.zip) |
System
| Value | Notes |
|---|---|
iis_user | IIS user to own installation files. We recommend leaving this set at the default. |
iis_guest | IIS guest user to allow permission for the temp folders. We recommend leaving this set at the default. |
service_user_name | Jadu Service username for a user that will be created by the installer and used to run the scheduled tasks. This will be created by the installer, we recommend jadu_svc |
service_user_password | Jadu Service user password, that will be used for the created user |
jadu_iis_admin_username | Jadu IIS Administrator service username for a user that will be created by the installer and used to run elevated scheduled tasks |
jadu_iis_admin_password | Jadu IIS Administrator service user password, that will be used for the created user |
Server
| Value | Notes |
|---|---|
| host | Host name of the Server, this should be the site's domain e.g. mysite.com |
| application_pool | Name of the application pool, which should match the above |
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 datanbase 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 the above 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.
## 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.
Updating php.ini
Post installation we have to update the following php configurations assuming the install path was D:\inetpub\wwwroot\jadu
| Configuration | Proposed value |
|---|---|
| include_path | D:\inetpub\wwwroot\jadu\jadu |
| error_log | D:\inetpub\wwwroot\jadu\logs\php_log |
| session.save_path | D:\inetpub\wwwroot\jadu\var\sessions |
| upload_tmp_dir | D:\inetpub\wwwroot\jadu\var\tmp |
Setting up the IIS site
The site requires SSL and hence you have to import your SSL certificate to the IIS and update the binding of the site so that you will be able to access the site using the right domain name from the browser.
After successful installation you will be able to visit the site [hostname]/jadu and start setting up the application.
Adding the task rescheduler
On ONE of your web nodes (ONLY) use the Windows Task Scheduler to add a daily task for a quiet local time in the day (e.g. 04:00am), to run the following command (where F:\inetpub\wwwroot\jadu is your root Jadu installation directory):
F:\inetpub\wwwroot\jadu\var\scheduled_tasks\run_rescheduler.bat
Please check that the path to the PHP executable is correct within the above .bat file when setting up this process.
Configuring SMTP
Windows Server 2025 does not provide an option for a local SMTP server. Instead, open up config/mail.xml from the root of the jadu install, and configure this to point to your own mail server.
Clear the cache by deleting the contents of the var/cache subdirectory (but leaving the folder in place).
Troubleshooting
Write access for SQL Server
SQLSTATE [42000, 5123]: [Microsoft][ODBC Driver 17 for SQL Server][SQL Server]CREATE FILE encountered operating system error 3(The system cannot find the path specified.) while attempting to open or create the physical file 'D:\MSSQL-JADU\DATA\jadudb_log.ldf'. SQLSTATE [42000, 1802]: [Microsoft][ODBC Driver 17 for SQL Server][SQL Server]CREATE DATABASE failed. Some file names listed could not be created. Check related errors.
Assuming the full path and file name are correct and actually exist, this error is caused by SQL Server being unable to either access or write to the specified path.
This may be caused by:
- Unknown drive letter.
- The account you specified for your SQL Server service does not have write permissions on the specified folder or part of it.
- Lack of trust between domains.
Password character encoding
[WARNING] SQLSTATE [IMSSP, -47]: An error occurred translating the connection string to UTF-16: No mapping for the Unicode character exists in the target multi-byte code page.
If you encounter this error, ensure that database account values are UTF-8 compatible and the installation should then proceed.