Skip to content

OpenStatusPage/OpenStatusPage

Repository files navigation

OpenStatusPage

An open source, self hosted status page and monitoring system with options for redundancy and scaleable deployments

Quickstart

Either run the docker command below direclty or use docker-compose to set up a container.
Then navigate to http://localhost:8181 and you should see the default status page after a moment.
You can log into the dashboard by using the link on the bottom left of the page or by clicking here.

Docker

docker run -it -p 8181:80 -v data:/data ghcr.io/openstatuspage/openstatuspage \
  --Storage:Driver="sqlite" \
  --Storage:ConnectionString="Data Source=/data/local.db" \
  --ApiKey="9a3dcef7-e0bc-4e30-98bc-b325f5866490" \
  --Tags="demo" \
  --Endpoint="http://localhost:8181"

Docker Compose docker-compose.yml

version: "3"
services:
  openstatuspage:
    image: 'ghcr.io/openstatuspage/openstatuspage'
    restart: unless-stopped
    ports:
     - "8181:80"

    environment:
      "Storage__Driver": "sqlite"
      "Storage__ConnectionString": "Data Source=/data/local.db"
      "ApiKey": "9a3dcef7-e0bc-4e30-98bc-b325f5866490"
      "Tags": "demo"
      "Endpoint": "http://localhost:8181"
      
    volumes:
      - ./data:/data

Required paramters:

  • --Storage:Driver string Selected database driver. Available values are SQLite and PostgreSQL
  • --Storage:ConnectionString string Connection string used by the database driver.
  • --ApiKey GUID Api key used for authentication within the cluster. Generate one at guidgenerator.com
  • --Endpoint URL Public endpoint where the instance is reachable e.g. https://demo-host-1.example.org

Optional paramters:

  • --Connect URL Connect instances togheter as cluster e.g. https://demo-host-2.example.org
  • --Id GUID Unique Id that identifies an instance. Autogenerated on start if not provided.
  • --Tags value,value;value Tags to assign instance groups. Allows to control what monitors are run on what servers.
  • --Timeout Number Maximum connection timeout in milliseconds. Also determines how fast the cluster detects member failures. Default is 2500
  • --Bind URL Local network listen bind. Not needed when run inside docker e.g. for listening on all ips http://0.0.0.0
  • --CERTIFICATEPFX file Path to SSL certificate file in .pfx format to use HTTPS
  • --CERTIFICATEPASSWORD string Password for the --CERTIFICATEPFX if required
  • --TRUSTPROXIES true/false Choose to trust proxy servers. Should be enabled when running behind a webserver like nginx.
  • --PORTVARIABLE string Name of the envorionment variable that contains the port to bind to. Default is port

About

An open source, self hosted status page and monitoring system with options for redundancy and scaleable deployments

Resources

License

Stars

Watchers

Forks

Languages