Step 1: Clone the repository

git clone [email protected]:DrDroidLab/PlayBooks.git

Step 2: Install the docker containers

docker-compose -f deploy.docker-compose.yaml up -d

This command pulls publicly available images for redis, postgres, and the playbooks backend and web services.

Step 3: Verify the containers

The Playbooks platform should now be available on port 80 on localhost. Proceed to sign up.

Step 4: Create User

Sign up with name, email & password and then login using the same.

Building Using Source Code

If the preference is to build using source code and not use publicly available images, use the following command. This command builds the images locally and runs them in containers.

docker-compose -f playbooks.docker-compose.yaml up -d

Using an External Postgres Database

To use a custom postgres database instead of installing it on the fly, create an env file in the root directory. Include the credentials of the database in this file, and the system will use that external database. Following fields must be added to it.

POSTGRES_DB=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_HOST=
POSTGRES_PORT=

Machine Specifications

For installing playbooks on a computer, start with a machine that has 2 CPUs and 8GB of RAM. Depending on the load and the number of playbooks running and their frequency, it may be necessary to upgrade the machine.