Installation and Deployment

Owned by Nithin Jois (Unlicensed)
Last updated: Jun 22, 2018
2 min read

Deploying Orchestron v5

Step-by-step guide

  1. Install Docker on the machine where Orchestron is to be deployed.
    1. If you are on Linux or MacOS, running the command below as a privileged user should install the latest version of docker. (OR) click here[https://docs.docker.com/install/] to follow the official installation instructions
      1. wget -qO- https://get.docker.com | sh
    2. If you are on Windows, follow the instructions in the link below.
      1. https://docs.docker.com/docker-for-windows/install/
  2. Install Docker Compose on the machine where Orchestron is to be deployed.
    1. Instructions to install Docker compose can be found here[https://docs.docker.com/compose/install/#install-compose].
  3. Get the docker-compose.yml file from Orchestron GitHub.
    1. You can either clone the repository to the machine. (OR)
    2. Run 'wget https://raw.githubusercontent.com/we45/orchestron-community/master/docker-compose.yml' .
  4. Make the necessary changes in the compose file(docker-compose.yml).
    1. Here are the list of the Environment Variables that need to be edited in the docker-compose.yml file.
      1. MYSQL_ROOT_PASSWORD - MySQL Database Password for Root User. If necessary, changes can be made to the docker-compose.yml file and a non-root User can be used instead.
      2. MINIO_ACCESS_KEY - Minio Access Key should be a minimum of 3 characters in length.
      3. MINIO_SECRET_KEY - Minio Secret Key should be a minimum of 8 characters in length.
      4. ENC_KEY - Encryption Key is used to Encrypt Jira and Email Configuration Parameters.
      5. JWT_SECRET_KEY - JWT Secret Key to Generate JWT tokens.
      6. ADMIN_USER_EMAIL - Administrator Email ID.
      7. ADMIN_USER_PASS - Administrator Password.
    2. The parameter 'API_URL' will be the Server IP or the machine IP. The format will be 'http://<server_ip>
      1. If you are on MacOS or Linux, the machine IP can be found by running 'ifconfig'
      2. If you are on Windows, the machine IP can be found by running 'ipconfig'
    3. Paths of volumes exposed (used for persistent storage) can also be changed if necessary.
  5. Once the changes have been made, you can start Orchestron by running the following command.
    1. docker-compose up -d


Image of an example compose file is shown below: