Install Imperum (On-Premises)¶

Introduction¶

This guide will walk you through the installation (On-Premises) process of Imperum using the provided Bash script. Imperum is a platform that provides functionalities for managing and orchestrating workflows. The installation script automates the setup process, making it easier for users to deploy Imperum on their systems.

Requirements¶

Before you begin, ensure that you have the following prerequisites installed on your system:

Getting Started¶

Starting Imperum for the first time¶

To start Imperum, open a terminal and navigate to the folder where you extracted the zip file. Then run the following command:

./imperum install

An interactive setup will start and ask you for the required information. After the required information is provided, Imperum will download all required docker images, setup the database and start itself. The first start can take a few minutes.

Upon successful installation, you can access Imperum at the specified host URL and exposed port.

After the installation you have to copy the license file to the imperum-core/license.lic file.

Configuration Options¶

Custom SSL Certificate: If you choose to use a custom SSL certificate, provide the key and certificate files and update ssl_certificate.key and ssl_certificate.crt in the imperum.conf file.
Additional Configuration:

Parameter	Description	Example Value
`project_name`	Name of the project.	`default`
`default_user_email`	Email address of the default user.	`admin@imperum.io`
`host_url`	Base URL for the project.	`https://localhost`
`ssl_certificate_key`	File path to the SSL/TLS private key.	`./imperum-frontend/nginx-selfsigned.key`
`ssl_certificate_crt`	File path to the SSL/TLS certificate.	`./imperum-frontend/nginx-selfsigned.crt`
`bind_address`	IP address on which the project is exposed.	`0.0.0.0`
`bind_port`	Port on which the project is exposed.	`443`
`agent_host`	Host for the agent component of the project.	`localhost`
`agent_port`	Port for the agent component of the project.	`8009`
`gunicorn_workers`	Number of gunicorn workers.	`2`

Stop Imperum¶

./imperum stop

Start Imperum¶

./imperum start

To get more information about the available commands, run ./imperum --help.

Troubleshooting¶

Initial Login Details To access the admin account, use the email admin@imperum.io. Obtain the default password for this user by executing the command ./imperum default-password
Logs: If you encounter issues, check the installation logs in the install.log file for details.
Reinstallation: To reinstall Imperum, execute the command ./imperum uninstall followed by ./imperum install again. Be cautious when using the uninstall command, as it will permanently erase all your data without providing any warning.