Get started

Docker installation

Run AstroGuide from GHCR with one consistent port: 2502.

AstroGuide uses port 2502 on the Docker host and 2502 inside the container. The normal Compose file is published on all host interfaces, so another device on the LAN opens http://<server-ip>:2502.

Copy-ready Docker Compose

services:
  astroguide:
    image: ghcr.io/lucas-lepajollec/astroguide:latest
    ports:
      - "2502:2502"
    restart: unless-stopped

Save this as docker-compose.yml, then run:

docker compose pull
docker compose up -d --force-recreate
docker compose ps

The container must become healthy. The image already runs Nginx as a non-root user, includes its own health check on port 2502, and persists no server-side data. The Compose file does not need to repeat those image-level settings.

Use the repository file

git clone https://github.com/lucas-lepajollec/AstroGuide.git
cd AstroGuide
docker compose up -d

The default image is ghcr.io/lucas-lepajollec/astroguide:latest. For a fixed deployment, replace latest directly in the Compose image: line with a version, digest, or sha-<commit> tag.

Build from source

docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build

The overlay builds astroguide:local without changing port 2502.

Stop or remove

docker compose stop
docker compose down

No application data is lost because AstroGuide has no persistent server-side volume. See Updates and Uninstallation.