askbe/livecompose repository overview

⁠LiveCompose

LiveCompose is a lightweight API designed to simplify the management of Docker Compose services. It enables seamless updates through webhooks, making it an ideal tool for continuous integration workflows.

⁠Key Features

• Service Updates: Update all or specific services in your Docker Compose file via simple API calls.
• Environment Variable Management: Modify environment variables in the .env file directly through the API.
• Real-Time Logs: Access service logs in real-time for monitoring and debugging.
• Unique Project ID Generation: Each project is assigned a unique ID for easy management.

⁠Security

• HTTPS Only: Ensure all API calls are made over HTTPS to protect sensitive data.
• Reverse Proxy Recommended: Set up a reverse proxy (e.g., Nginx or Traefik) for SSL termination.
• IP Restrictions: Implement IP restrictions in your reverse proxy to control access to the API.

⁠Configuration

LiveCompose can be configured using the following environment variables:

• ASK_LiveCompose__BasePath: The base path where the application looks for Docker Compose files. Default value is /projects.
• ASK_LiveCompose__Key: A specific key used for generating unique project IDs. It is crucial to change this value for production deployments to enhance security.

⁠Usage

Deploy LiveCompose easily with Docker:

⁠Example Command

docker run -d \
  --name livecompose \
  --restart unless-stopped \
  -e ASK_LiveCompose__BasePath=/projects \
  -e ASK_LiveCompose__Key=1234567890abcdefgh \  # Change this for production
  -v /opt/compose-projects:/projects \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -p 9000:8080 \
  askbe/livecompose:0.0.3

⁠Docker Compose

Alternatively, use Docker Compose with the following configuration:

services:
  livecompose:
    image: askbe/livecompose:0.0.3
    restart: unless-stopped
    environment:
      - ASK_LiveCompose__BasePath=/projects
      - ASK_LiveCompose__Key=1234567890abcdefgh  # Change this for production
    volumes:
      - /opt/compose-projects:/projects
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 9000:8080

⁠License

This project is licensed under the LGPL-3.0 License or later.