Documentation
Everything you need to install, configure and contribute.
All documentation lives in the GitHub repository as versioned Markdown files. Click any card below to open the relevant guide directly on GitHub.
Getting Started
Everything you need to get MyAstroBoard up and running.
Installation Guide
Step-by-step Docker installation on Linux, including directory structure, volume setup, and first-run checklist.
Quick Start
Minimal steps to get your first SkyTonight calculation running. Configure your location and observe results within minutes.
Update Guide
How to pull the latest Docker image and apply updates without losing your configuration or observation data.
Reverse Proxy & HTTPS
Configure Nginx or Traefik as a reverse proxy with HTTPS termination. Recommended for any internet-exposed instance.
Feature Documentation
Deep dives into core features and their architecture.
SkyTonight Architecture
Full documentation of the SkyTonight engine: catalog pipeline, AstroScore formula, scheduler behavior, and data model.
Plan My Night
How to build, manage, and export your observation timeline. API endpoints, data structure, and usage guide.
API Endpoints Reference
Complete inventory of all REST API endpoints, authentication requirements, request/response formats, and examples.
Cache System
Architecture of the selective-refresh background cache, per-job TTLs, execution metrics, and how to monitor cache health.
Visual Tour
Annotated screenshots of every tab and feature. The best starting point to understand what MyAstroBoard looks like in practice.
Translation Guide
How to add a new language or improve existing translations. All you need is a JSON file following the established key structure.
Contributing
Join the community and help shape MyAstroBoard.
Contribution Guidelines
Coding standards, branch workflow, commit conventions, and how to submit a pull request.
Release Process
How versioning works, how releases are tagged and published, and how Docker images are built via GitHub Actions CI/CD.
Roadmap
Planned features and improvements. Open to community input via GitHub Issues and Discussions.
GitHub Issues
Report bugs, request features, and track known issues. The primary support and feedback channel for the project.
Start building
Ready to deploy your own instance?
The Installation Guide has everything you need to go from zero to a running SkyTonight calculation in under 10 minutes.