Running the Bot Libre Community Edition docker containers on Amazon AWS (Draft)

This forum post will go over how to run the Bot Libre Community Edition containers from AWS using Docker Compose on any machine.

Required Software:

• AWS Command Line Interface
  • Installation instructions: https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html
  • If unzip is not installed, install with the following command:
    • sudo yum install unzip
  • Check that the AWS CLI is working by using the following command:
    • $ aws --version
  • The AWS CLI must also be configured with your AWS Access Key ID and Secret Access Key.
    • Configuration instructions: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html
• Docker
  • Installation instructions: https://docs.docker.com/engine/install/
  • Check that Docker is working by using the following command:
    • $ sudo docker version
• Docker Compose
  • Installation instructions: https://docs.docker.com/compose/install/#install-compose
  • Check that Compose is working by using the following command:
    • $ sudo docker-compose version

Firewall:

Before starting up the server, make sure to set up your firewall correctly for Bot Libre.

Bot Libre Community Edition requires the following ports to be open:

22 – SSH
80 – HTTP
443 – HTTPS
25 – SMTP
465 – SMTPS
110 – POP3
995 – POP3S
143 – IMAP
993 – IMAPS
6665 – IRC

The procedure for how to set up the firewall depends on the firewall you are using. For example, an Amazon EC2 instance would use security groups. For a typical Linux server, iptables can be used.

AWS Marketplace Product Subscription

You will gain access to the Bot Libre Community Edition container registry by subscribing on the AWS Marketplace.

1. Go to https://aws.amazon.com/marketplace.
2. Search for Bot Libre Community Edition, and filter for container products.
   https://aws.amazon.com/marketplace/pp/B08FXT93P9
3. Click on "Continue to Subscribe".
4. Read the Terms and Conditions, and click on "Accept Terms".
5. After your request has been processed, click on "Continue to Configuration".
6. Select the latest version, and click on "Continue to Launch".

Deploying the Containers

1. Run the following command in your AWS instance, with ${USER} being your profile username (if you're unsure, you can check it by running the whoami command):
   • $ sudo usermod -aG docker ${USER}
2. Log out of your instance before logging back in. Then, log in to the Bot Libre Community Edition container registry using the following command:
   • $ aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 117940112483.dkr.ecr.us-east-1.amazonaws.com
3. Download our docker-compose.yml configuration file from our GitHub. This can be done with the following command:
   • $ wget https://raw.githubusercontent.com/BotLibre/BotLibre/master/botlibre-web/aws%20marketplace/docker-compose.yml
4. Build and create the containers with the following command:
   • $ docker-compose up --no-start
5. To start the containers, run the following command:
   • $ docker-compose start
6. Open the home page on a web browser (this is the same IP address as the server where the Docker commands are run). This will take up to 3 minutes to load. If you are starting the container for the first time, a random admin password will be generated.
   
   • If you are unsure about your server's public IP address, you can use the following command:
     • $ curl ifconfig.me

Retrieving the Admin Password

1. Once the page has been loaded on a web browser, use the following command to retrieve the default admin password:
   • $ sudo docker-compose logs | grep "ADMIN PASSWORD"
2. Log in to Bot Libre on your web browser by using the username "admin" and the password you have just retrieved.
   • We recommend that you update your admin password after logging in. This is because if the logs have been erased, then you will no longer be able to access the default admin password.