Skip to main content

Docker Installation

Prerequisites​

Before installation, ensure you have:

  • Read the System Requirements
  • Docker installed on your system
  • Set up PostgreSQL and Kafka (either in docker or on your local machine)

Steps​

Step 1: Set up PostgreSQL and Kafka containers in Docker (if not already running)​

version: '3.8'

services:
  postgres:
    image: postgres:15
    environment:
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: admin
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

  kafka:
    image: bitnami/kafka:3
    environment:
      KAFKA_BROKER_ID: 1
      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
      ALLOW_PLAINTEXT_LISTENER: yes
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
      KAFKA_LISTENERS: PLAINTEXT://0.0.0.0:9092
      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT
    ports:
      - "9092:9092"
    depends_on:
      - zookeeper

  zookeeper:
    image: bitnami/zookeeper:3
    environment:
      ALLOW_ANONYMOUS_LOGIN: yes
    ports:
      - "2181:2181"

volumes:
  postgres_data:

Step 2.1 Using Pre-built Images​

# Pull the backend image
docker pull ghcr.io/owlistic-notes/owlistic:latest

# Pull the frontend image
docker pull ghcr.io/owlistic-notes/owlistic-app:latest
# Run the backend
docker run -d \
  --name owlistic \
  -p 8080:8080 \
  -e APP_PORT=8080 \
  -e DB_HOST=postgres \
  -e DB_PORT=5432 \
  -e DB_USER=admin \
  -e DB_PASSWORD=admin \
  -e DB_NAME=postgres \
  -e KAFKA_BROKER=kafka:9092 \
  ghcr.io/owlistic-notes/owlistic:latest

# Run the frontend
docker run -d \
  --name owlistic-app \
  -p 80:80 \
  ghcr.io/owlistic-notes/owlistic-app:latest

Note: The above commands assume you have PostgreSQL and Kafka running and accessible respectively at postgres:5432 and kafka:9092.

Step 2.2: Building from Source​


# Build the backend image
docker build -t owlistic:latest .

# Build the frontend image
docker build -t owlistic-app:latest .

# Run the backend container
docker run -d \
  --name owlistic \
  -p 8080:8080 \
  -e APP_PORT=8080 \
  -e DB_HOST=postgres \
  -e DB_PORT=5432 \
  -e DB_NAME=owlistic \
  -e DB_USER=admin \
  -e DB_PASSWORD=admin \
  -e KAFKA_BROKER=kafka:9092 \
  owlistic

# Run the frontend container
docker run -d \
  --name owlistic-app \
  -p 80:80 \
  owlistic-app

Note: The above commands assume you have PostgreSQL and Kafka running and accessible respectively at postgres:5432 and kafka:9092.

Post-Installation​

After installation:

  • The backend should be running on port 8080
  • The frontend should be accessible on port 80
  • Visit http://your-server to access the web interface

Troubleshooting​

If you encounter any issues during installation, please refer to the Troubleshooting section for assistance.