Installing the On-Premise Console (Linux)

This Article Applies to:

  • Avast Business On-Premise Console

Installing the Console

Installing the On-Premise Console in operating systems besides Windows requires working, up-to-date installations of both Docker and Docker Compose, as well as a Docker account.

The following commands are intended to be run from a terminal shell with root permissions if they start with "#" or from a user shell if they start with "$". To gain root permissions you will either need to change users to root or prepend “sudo” before all commands you run while installing Docker, Docker Compose and running any of the commands below.

  1. Create a directory to hold the docker-compose configuration files by running the following commands:
    • Cd /home
    • Mkdir /home/<user>/opdservice
    • Cd /home/<user>/opdservice
    • Mkdir /home/<user>/opdservice/dockercontainers
    • Cd /home/<user>/opdservice/dockercontainers
    • Mkdir /home/<user>/opdservice/dockercontainers/business-console
    • Cd /home/<user>/opdservice/dockercontainers/business-console
  2. Use the following command to generate the docker-compose.yml and .env files: git clone https://github.com/avast/management-console-config.git.
    • You may have to install the git command: #yum -y install git.
    • The .env file is hidden.
  3. Use a plain text editor such as vi/vim or gedit to edit the .env file.
  4. Set the AFB_HOSTNAME property to match your device’s DNS hostname, which is the IP address of the server with the .yml and .env files. Save your changes.
    • We recommend changing AFB_LOG_DIR and AFB_SEC_DIR values to locations that are not user-specific, and both your current user and the Docker service can access. If you create a user specifically to manage Docker containers, a static path to that user’s /home directory will work.
    • If desired, you can also edit your database username and password or the ports the Console will use for communication.
    • If your device’s IP address changes after you have set the AFB_HOSTNAME property, you will need to edit the .env file with the new device IP address and complete steps 3 and 4 again.
  5. Use the plain text editor to edit the .yml file.
  6. Change the entry under services/server/image from: “avastsoftware/management-console-beta:${AFB_VERSION}” to “docker.int.avast.com/avast/business-console/on-premise:${AFB_VERSION}”.
    • At present, the .yml file provided may be configured to attempt to connect the Docker Console from external port 443 to internal port 8443. This may not work. If it does not, locate the line “${AFB_WEB_PORT]:8443” and change it to “${AFB_WEB_PORT]:443”.

Running the Console

  1. Run the following command to create the database and start the On-Premise Console: $docker-compose up -d.
    • If this command creates an error “Docker-compose: command not found…”, run the following commands:
      • #curl -L https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
      • #chmod +x /usr/local/bin/docker-compose
      • #ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
    • Verify the Docker version with the following command: docker-compose --version. After verifying the version, repeat step 1.
  2. Once the command completes, run: docker-compose ps.
  3. Once the application has started, you can access the On-Premise Console via a web browser. Open a browser and navigate to https://<hostname>:<port number> where <hostname> is the name or IP address of the device and <port number> is the port number set in the .env file.