Skip to main content

​
Requirements

​
Hardware

  1. At least 2GB of memory
  2. Minimum 3GB of storage for container images and application data

​
Software

  1. Any operating system that can run Docker. We have tested on Ubuntu 22.04LTS
  2. Docker
  3. The tarball containing the Cymph installation script

​
Steps

The steps below refer to a command line based installation in an Ubuntu 22.04 machine. The same steps apply for MacOS.
  1. Extract the tarball and go to the cymph folder
$ tar zxvf cymph_onprem.tgz
$ cd cymph/
  1. Configure the .env file
$ sudo ./env.sh
This step will ask you certain questions:
  • The e-mail of the on-prem administrator user (default is [email protected])
  • The IP address where the Web application will listen to (default localhost)
  • The port where the Web application will listen to (default 8080)
  • If SSL mode is required for Postgres (default is no)
  • If e-mail service should be enabled. The default answer is no. In case the answer is yes, you will be prompted for additional configuration
  1. Run docker compose
$ sudo docker compose up -d
This command will run the containerized services in the background. If you have already composed the solution, then run sudo docker compose start If you see a message like this:
The requested image’s platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
feel free to ignore it. Once docker compose is complete, you should see the following on your terminal: Docker Up The setup procedure also performs certain initialisation steps:
  • Creates an on-prem administration account with default credentials
  • Populates the instance with playbook contents. The playbooks will belong to the on-prem administration account
  1. Open your browser and navigate to the Cymph application
    • The URL should be http://<ip_address>:<port> as configured in step 2. If you have not specified your own addresses and ports, the default URL is http://localhost:8080
  2. Enter the default on-prem administration credentials and click on Log In button
    • E-mail: the email you provided on step 2 (or [email protected] if no e-mail was provided)
    • Password: admin
Onprem First Login
  1. You will be asked to change your password
    • Enter the current password, which is admin
    • Enter your new password that meets the password criteria.
    • Click on Update to change the password
    • After changing your password, you will be redirected to the login screen
  2. Login with the updated credentials and you are ready!
After you are done with the installation, you will be able to login as an on-prem administration. From that account you will be able to: