Docker Compose Deployment

This section assumes you have read and configured your Docker installation as detailed here.

The default ports for each service are:

  • backend: 5000:50100-50800

  • frontend: 8080

  • database: 5434

Note

Make sure your database is configured to listen to all addresses to work with the containers. The most common error an improperly configured database throws are

psql: could not connect to server: Connection refused
Is the server running on host 10.254.254.254 and accepting
TCP/IP connections on port 5432?

Docker Compose without a script

This section of the documentation details how to use Augur’s Docker Compose configuration to get the full stack up and running as fast as possible without the recommended helper script.

Warning

Don’t forget to provide your external database credentials in the docker_env.txt file. Additionally an .env file is needed for the *.yml files’ environment variables. Don’t forget to set the variables specified in these files namely AUGUR_DB_TYPE and AUGUR_DB_HOST.

Example docker_env.txt: .. code:

AUGUR_GITHUB_API_KEY=your_key_here
AUGUR_DB_SCHEMA_BUILD=0
AUGUR_DB_HOST=xx.xxx.xxx.xxx
AUGUR_DB_NAME=augur
AUGUR_DB_PORT=5432
AUGUR_DB_USER=augur
AUGUR_DB_PASSWORD=somePassword

To run Augur without the database container:

docker-compose -f docker-compose.yml up

To run Augur with the database container:

docker-compose -f docker-compose.yml -f database-compose.yml up

If you want to use the test_data image with the data preloaded, change the image line of database-compose.yml to:

image: augurlabs/augur:test_data

Or you can set it dynamically in the .env file.

Stopping the containers

To stop the containers, run docker-compose down --remove-orphans. The flag is necessary to stop the database container if you used one; run the command again to delete them.

Once you’ve got your container up and running, checkout out how to use them