A fully open-source status page for Gatus backend
|
Some checks failed
Build and Push Image / build-and-push (push) Failing after 5m31s
Reviewed-on: #67 |
||
|---|---|---|
| .forgejo | ||
| .vscode | ||
| assets | ||
| chart | ||
| ci | ||
| src | ||
| .dockerignore | ||
| .gitignore | ||
| Dockerfile | ||
| README.md | ||
| renovate.json | ||
252-status
252-status, a fully open-source status page for Gatus backend. Nuxt edition.
Features
- Use Gatus as your backend
- Fully responsive
- Dark mode support
- Brand-free footer
- All 100 scores in Lighthouse test
- OpenTelemetry tracing with Tempo support
- Multiple API endpoint fallback support
- Kubernetes-ready with Helm charts
Stack
- Framework: Nuxt 3
- UI: Shadcn Vue + Radix Vue
- CSS: Tailwind + custom-made OKLCH color palettes
- State Management: VueUse
- Observability: OpenTelemetry + Tempo
Getting Started
First, install dependencies:
pnpm install
Then, run the development server:
pnpm dev
Open http://localhost:3000 with your browser to see the result.
Environment Variables
# Required
GATUS_API_BASE="https://status-1.example.com | https://status-2.example.com"
# Optional
NUXT_PUBLIC_SITE_TITLE="Status"
NUXT_PUBLIC_SITE_DESC="A status page"
NUXT_PUBLIC_SITE_LOGO="example.com"
NUXT_PUBLIC_SITE_BACK_TITLE=""
NUXT_PUBLIC_SITE_BACK_URL=""
TEMPO_URL="https://telemetry.example.com/v1/traces"
Deployment
Docker
docker build -t status-tracker .
docker run -p 8080:8080 status-tracker
Kubernetes (Helm)
helm install status-tracker ./chart
Custom values can be provided:
# values.yaml
tracing:
enabled: true
tempo:
url: "https://telemetry.example.com/v1/traces"
Gratitude
Primarily based on sts, in addition to the following projects:
- Gatus for the backend
- Nuxt for the framework
- Shadcn Vue for the UI components
- Radix Vue for the UI primitives
- Tailwind CSS for the styling
- VueUse for the composables
- OpenTelemetry for observability
