Docker Compose Deployment

Table of Contents

• Prerequisites
• Setting Up the Project
  • Set Environment Variables for Docker Compose
• Running the Containers
  • Create External Docker Network
  • Run Multi-Docker Compose files
• Usage
  • Access APIs
  • Access MailHog
• Destroying the Containers
• Other Docs
• References

Prerequisites

Before you begin, ensure you have the following installed & running properly on your server:

• Docker Desktop
• WSL (Windows Subsystem for Linux) if the server OS is Windows

Setting Up the Project

Set Environment Variables for Docker Compose

The docker-compose.yml file requires proper environment variables set before execution.

Following the .env.example file, create another file .env in the same directory, and set proper values. DO NOT expose them!

Running the Containers

Create External Docker Network

Create an external network to share between different compose files: -

docker network create ridesharing-shared-net

Run Multi-Docker Compose files

Open Terminal from project /docker directory and run the following command to run all containers in detached mode:

docker compose -f docker-compose.postgres.yml -f docker-compose.rabbitmq.yml -f docker-compose.redis.yml -f docker-compose.dev.yml -f docker-compose.nginx.yml up -d

Usage

Access APIs

• Access RideSharing Customer API through http://localhost:5000/customer-api/. GET http://localhost:5000/customer-api returns RideSharing.CustomerAPI is running message.

• Access RideSharing Authentication API through http://localhost:5000/auth-api/. GET http://localhost:5000/auth-api/ returns RideSharing.AuthenticationAPI is running message.

Access MailHog

• Access Local MailHog Server through http://localhost:8025(only for dev env).

Destroying the Containers

Run the following command to destroy all containers:

docker compose
  -f docker-compose.postgres.yml
  -f docker-compose.rabbitmq.yml
  -f docker-compose.redis.yml
  -f docker-compose.dev.yml
  -f docker-compose.nginx.yml down

Other Docs

Head to other deployment readme files: -

• RabbitMQ
• Redis with Management GUI
• PostgreSQL with PgAdmin
• Keycloak with Nginx & Postgres

References

To learn more about each of these topics, head to the following documentations:-

• Keycloak documentation
• Docker documentation
• Nginx documentation