Run Manboster in a container

This document aims to help you run Manboster in a container, making it easy to deploy and get.

Where is the container?

Manboster's container was automatically generated by GitHub Actions. It is published in ghcr.

The official container address is:

ghcr.io/manboster/manboster

Also, you can pull the repository down and build it manually.

How can I deploy it?

If you are using Docker or Podman singleton instance, you can just start onboard configuration first:

# If you are using Docker:
docker run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster onboard

# If you are using Podman:
podman run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster onboard

If there is no problem, you can continue your deployment with this command:

# If you are using Docker:
docker run -dit -v ./manboster-data:/app/manboster/ --restart=unless-stopped --name manboster-container ghcr.io/manboster/manboster

# If you are using Podman:
podman run -dit -v ./manboster-data:/app/manboster/ --restart=unless-stopped --name manboster-container ghcr.io/manboster/manboster

If you want to start Configuration TUI, run this after Manboster stopped or it will report running error:

# If you are using Docker:
docker stop manboster-container
docker run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster config

# If you are using Podman:
podman stop manboster-container
podman run --remove -it -v ./manboster-data:/app/manboster/ ghcr.io/manboster/manboster manboster config

Don't forget to get them up!

If you are using Docker Compose or Podman Compose, you can add this to your docker-compose.yml's services field:

services:
  manboster:
    image: ghcr.io/manboster/manboster
    container_name: manboster-container
    restart: unless-stopped
    volumes:
      - ./manboster-data:/app/manboster/
    stdin_open: true 
    tty: true

You can just start onboard configuration first:

# docker compose
docker compose run --rm manboster manboster onboard

# podman compose
podman compose run --rm manboster manboster onboard

If there is no problem, you can continue your deployment with this command:

# docker compose
docker compose up -d

# podman compose
podman compose up -d

If you want to start Configuration TUI, run this after Manboster stopped or it will report running error:

# docker compose
docker compose stop manboster
docker compose run --rm manboster manboster config

# podman compose 
podman compose stop manboster
podman compose run --rm manboster manboster config

Don't forget to get them up!