linkDeployment

1linkexport NODE_ENV=production

2linknpm i

3linknpm run build

4linknpm run serve

It also needs 2 yaml files to work

• site.yaml: Contains information about the site
• monitors.yaml: Contains your monitors and their related specifications

By default these are present in config/. However you can use different location either passing them as argument or having the path as enviorment variable

linkAdd as Environment variables

1linkexport MONITOR_YAML_PATH=/your/path/monitors.yaml

2linkexport SITE_YAML_PATH=/your/path/site.yaml

linkAdd as argument to prod.js

1linknpm run serve -- --monitors /your/path/monitors.yaml --site /your/path/site.yaml

linkInstall using Docker

Dockerhub

1linkdocker.io/rajnandan1/kener:latest

Github Packages

1linkghcr.io/rajnandan1/kener:latest

You should mount a host directory to persist your configuration and expose the web port. Environmental variables can be passed with -e An example docker run command:

Make sure you have a /static folder inside your config folder

1linkdocker run -d -v /path/on/host/config:/config -p 3000:3000 -e "GH_TOKEN=1234" rajnandan1/kener

Or use Docker Compose with the example docker-compose.yaml

linkUsing PUID and PGID

If you are

• running on a linux host (ie unraid) and
• not using rootless containers with Podman

then you must set the environmental variables PUID and PGID. in the container in order for it to generate files/folders your normal user can interact it.

Run these commands from your terminal

• id -u -- prints UID for PUID
• id -g -- prints GID for PGID

Then add to your docker command like so:

1linkdocker run -d ... -e "PUID=1000" -e "PGID=1000" ... rajnandan1/kener

or substitute them in docker-compose.yml