Skip to content

krane/statuspage

Repository files navigation

The status page for Krane deployments

Status Page

Installing

You can run the Krane status page pointing to any Krane instance using the below command

docker run -d --name krane-statupage \
    -e KRANE_ENDPOINT=https://krane.example.com \
    -e KRANE_TOKEN=changeme \
    -p 3000:3000 ghcr.io/krane/statuspage

Deploying

You can deploy the Krane status page using Krane since its packaged up into a Docker image.

An example deployment configuration is shown below

deployment.json

{
  "name": "krane-statuspage",
  "image": "krane/statuspage",
  "secure": true,
  "alias": ["status.example.com"],
  "registry": {
    "url": "ghcr.io"
  },
  "secrets": {
    "KRANE_ENDPOINT": "https://krane.example.com",
    "KRANE_TOKEN": "@KRANE_TOKEN"
  }
}

Contributing

The Krane status page is written in Typescript using next.js.

The @krane/common library is used to interface with the Krane API.

This project is an open-source initiative, contributions and enhancement proposals are welcomed and appreciated.

About

Status page for monitoring Krane deployments

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages