Get started
Requirements
Software, ports and decisions to prepare before installation.
Recommended Docker installation
- Docker Engine and Docker Compose v2;
- command-line access with permission to run containers;
- TCP port
2502available on the host, or another host port of your choice; - no persistent data to provision: AstroGuide does not write an application volume.
Development from source
- Node.js
22.x; - npm 10 or later, using the repository lockfile;
npm ci --include=optional: some native dependencies are optional but useful during builds.
Decisions to make
| Question | Recommended choice |
|---|---|
| How should I install it? | GHCR image for an instance; local Compose to validate a checkout |
| Which port? | 2502 by default; change only the left-hand host value |
| Remote access? | local network or reverse proxy; AstroGuide has no authentication |
| Public demo? | use the official URL instead of exposing your own instance |
Check Docker Compose
docker version
docker compose version