Configuration wizard

Configuration Wizard

Once all the containers are started, we can navigate to the IP address of the server. This will prompt us with the initial installation wizard.

Tip

Best to use the Server IP address. Localhost is not configured correctly.

Step 1. Go To the Report-Engine installation wizzard

Open your web browser and navigate to http://<your-server-ip>. You will be greeted with the installation wizard to configure the Report-Engine application.

Step 2. Application Details

1. Provide the base URL on which the application will listen on.
2. The timezone is important for scheduling reports.
3. Select the application locale (currently only English is supported).

Step 3. Database Configuration

1. Provide the database host details (IP/FQDN).
2. Provide the port where the database is listening on.
3. Provide the database name that can be used for the Report-Engine Application.
4. Provide the username for the given database.
5. Provide the password for the given user.

Watch out!

Currently only PostgreSQL is supported.

Tip

When using the default provided PostgreSQL container, you don’t have to change the values in this step. (Password can be found/changed in the docker-compose.yml)

Step 4. Redis Caching Configuration

1. Provide the Redis host details (IP/FQDN).
2. Provide the port where the Redis instance is listening on.
3. Optional - Provide the password for the Redis instance.

Tip

When using the default provided Redis container, you don’t have to change the values in this step.

Step 5. Mail Server Configuration

1. Provide Mail service to use.
2. Provide the SMTP host details (IP/FQDN).
3. Provide the SMTP Port.
4. Provide the encryption type (None/SSL/TLS).
5. Optional - Provide the username if the SMTP server requires authentication.
6. Optional - Provide the password if the SMTP server requires authentication.
7. Provide the From Address that will be used for report scheduling.
8. Porvide the From Name that will be displayed for report scheduling.

Watch out!

Currently only SMTP is supported as Mail service.

Step 6. Admin User Creation

Last but not least, we can create the initial user account to access the Report-Engine Application.

1. Provide the full name of the administrator user.
2. Provide the email address of the administrator user.
3. Provide a secure password.
4. Repeat the secure password.

Step 7. Finish Installation

The installation is now finished, click on “Go to Admin Panel” to get started.

Step 8. Get started

To get started with the Report-Engine application, login with the initial user you have created in step 5.