Skip to content

bcc-code/bcc-media-dashboard

Repository files navigation

BCC Media dashboard

A simple operations dashboard for important statuses.

Running locally

mix setup
mix phx.server

Then open http://localhost:4000.

Deployment

Built as a Docker image, configured at runtime via environment variables.

Build

docker build -t bccm-dashboard .

Run

docker run -p 4000:4000 \
  -e SECRET_KEY_BASE="$(mix phx.gen.secret)" \
  -e PHX_HOST=localhost \
  -e SEMAPHORE_TOKEN=... \
  -e GATUS_URL=... \
  bccm-dashboard

If you have an env file you can pass it into the command.

docker run -p 4000:4000 \
  --env-file .env.docker \
  -e SECRET_KEY_BASE="$(mix phx.gen.secret)" \
  -e PHX_HOST=localhost \
  bccm-dashboard

Environment variables

Variable Default Notes
SECRET_KEY_BASE Required in prod. Generate with mix phx.gen.secret. Used to sign sessions.
PHX_HOST example.com Public hostname; used for URL generation. Set this for any real deploy.
PORT 4000 HTTP port the app listens on.
SEMAPHORE_TOKEN API token for the Semaphore CI integration. Without it, the section shows an error.
SEMAPHORE_ORG bccmedia Semaphore organization slug.
SEMAPHORE_REFRESH_MS 60000 Poll interval in milliseconds.
SEMAPHORE_WINDOW_DAYS 7 Days of pipeline history to fetch.
SEMAPHORE_MAX_PROJECTS 12 Max projects to display.
SEMAPHORE_MAX_PIPELINES 16 Max pipeline dots per project.
GATUS_URL Base URL of your Gatus instance (e.g. https://status.example.com). Without it, the Service health section shows an error.
GATUS_TOKEN Optional bearer token if your Gatus API requires auth.
GATUS_REFRESH_MS 30000 Poll interval in milliseconds.
GATUS_MAX_ENDPOINTS 24 Max endpoints to display.
GATUS_GROUPS Comma-separated Gatus group names to display. Empty = show every endpoint.
DNS_CLUSTER_QUERY DNS query for DNSCluster (only set if clustering nodes).

If SEMAPHORE_TOKEN or GATUS_URL is missing or invalid, the dashboard still renders and the affected section surfaces the fetch error instead — useful while bootstrapping the deploy.

About

[BCC Media] A simple operations dashboard for important statuses.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors