Skip to main content

Docker Compose Setup

To simplify the deployment and management of the API and its dependencies, Docker Compose is used. The docker-compose.yml file defines the services and their configurations.

docker-compose.yml

version: '3.1'

services:
  mariadb:
    image: mariadb
    restart: always
    environment:
      MARIADB_ROOT_PASSWORD: ${DB_ROOT_PASS}
    networks:
      - backend

  adminer:
    image: adminer
    restart: always
    environment:
      ADMINER_DEFAULT_SERVER: mariadb
    depends_on:
      - mariadb
    networks:
      - backend
      - frontend
    ports:
      - 8080:${ADMINER_PORT}

  backend:
    build: ./backend
    depends_on:
      - mariadb
    volumes:
      - ./backend/app.js:/app/app.js
      - cthulhu-backend:/CTHULHU
    environment:
      DB_HOST: mariadb
      DB_USER: ${DB_USER}
      DB_MAIN: ${DB_MAIN}
      DB_PASS: ${DB_ROOT_PASS}
    networks:
      - backend
      - frontend
    ports:
      - 5000:${BACKEND_PORT}

networks:
  backend:
  frontend:

volumes:
  cthulhu-backend:

The docker-compose.yml file defines three services: mariadb, adminer, and backend.

mariadb Service

  • Image: mariadb
  • Restart: always
  • Environment Variables:
    • MARIADB_ROOT_PASSWORD: The root password for the MariaDB instance (specified in .env file).
  • Networks: backend

The mariadb service runs a MariaDB database server. It uses the specified root password and is connected to the backend network.

adminer Service

  • Image: adminer
  • Restart: always
  • Environment Variables:
    • ADMINER_DEFAULT_SERVER: The hostname of the

MariaDB service (mariadb).

  • Depends On: mariadb
  • Networks: backend, frontend
  • Ports:
    • 8080:${ADMINER_PORT}: Maps the container's port 8080 to the specified ADMINER_PORT (specified in .env file).

The adminer service provides a web-based database management interface. It depends on the mariadb service and is connected to both the backend and frontend networks. The specified port is exposed for accessing the Adminer interface.

backend Service

  • Build: ./backend
  • Depends On: mariadb
  • Volumes:
    • ./backend/app.js:/app/app.js: Mounts the local app.js file into the container's /app/app.js.
    • cthulhu-backend:/CTHULHU: Mounts the named volume cthulhu-backend to /CTHULHU.
  • Environment Variables:
    • DB_HOST: The hostname of the MariaDB service (mariadb).
    • DB_USER: The database user (root).
    • DB_MAIN: The main database name (CTHULHU).
    • DB_PASS: The database user's password (specified in .env file).
  • Networks: backend, frontend
  • Ports:
    • 5000:${BACKEND_PORT}: Maps the container's port 5000 to the specified BACKEND_PORT (specified in .env file).

The backend service builds the API using the source code located in the ./backend directory. It depends on the mariadb service and mounts the local app.js file and the cthulhu-backend named volume. The environment variables define the database connection details. It is connected to both the backend and frontend networks, and the specified port is exposed for accessing the API.

.env File

DB_ROOT_PASS=toor
DB_USER=root
DB_MAIN=CTHULHU
BACKEND_PORT=5000
ADMINER_PORT=8080

The .env file contains environment variable definitions used by the Docker Compose configuration. It includes the following variables:

  • DB_ROOT_PASS: The root password for the MariaDB instance.
  • DB_USER: The database user (default: root).
  • DB_MAIN: The main database name (default: CTHULHU).
  • BACKEND_PORT: The port on which the API will listen (default: 5000).
  • ADMINER_PORT: The port on which Adminer will be accessible (default: 8080).

Make sure to adjust these values as needed for your specific deployment.

Back to top