Get started

Quick installation

Run AstroGuide from the published image or the repository Compose file.

For an immediate instance, publish the image on host port 2502:

docker run -d \
  --name astroguide \
  -p 2502:2502 \
  ghcr.io/lucas-lepajollec/astroguide:latest

AstroGuide is then available at http://127.0.0.1:2502 on the host and http://<host-ip>:2502 from the LAN.

The repository Compose file is the supported Docker path. It pulls GHCR and keeps port 2502 consistent:

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

For a recoverable deployment, replace latest in the Compose image: line with a version, digest, or immutable sha- tag. To build the current checkout instead, see Docker installation.

No environment variables

AstroGuide requires no API key, JWT secret or .env file.