mirror/kener
1
0
Fork 0
mirror of https://github.com/rajnandan1/kener.git synced 2026-05-04 17:50:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Raj Nandan Sharma
2024-01-24 22:42:06 +05:30
parent cbcdebb06f
commit 321b053538
1 changed files with 46 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs.md
+46 -47
View File
@@ -2,60 +2,16 @@
# Quick Start
Kener has been tested from Node18.
# Install using Docker
[Dockerhub](https://hub.docker.com/r/rajnandan1/kener)
```
docker.io/rajnandan1/kener:latest
```
[Github Packages](https://github.com/rajnandan1/kener/pkgs/container/kener)
```
ghcr.io/rajnandan1/kener:latest
```
You should mount a host directory to persist your configuration and expose the web port. Environmental variables [found below](#environment-variable) can be passed with `-e` An example `docker run` command:
```shell
docker 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](docker-compose.yml)
### Using PUID and PGID
If you are
* running on a **linux host** (ie unraid) and
* **not** using [rootless containers with Podman](https://developers.redhat.com/blog/2020/09/25/rootless-containers-with-podman-the-basics#why_podman_)
then you must set the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-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:
```shell
docker run -d ... -e "PUID=1000" -e "PGID=1000" ... rajnandan1/kener
```
or substitute them in [docker-compose.yml](/docker-compose.yml)
# Install Locally
Kener has been tested from Node18. It should work with Node 16 and above. It uses [SvelteKit](https://kit.svelte.dev/) and [shadcn-svelte](https://www.shadcn-svelte.com/)
## Clone the repository
```bash
```shell
git clone https://github.com/rajnandan1/kener.git
cd kener
```
## Install Dependencies
```bash
```shell
npm install
```
@@ -151,6 +107,49 @@ export SITE_YAML_PATH=/your/path/site.yaml
npm run serve -- --monitors /your/path/monitors.yaml --site /your/path/site.yaml
```
## Install using Docker
[Dockerhub](https://hub.docker.com/r/rajnandan1/kener)
```
docker.io/rajnandan1/kener:latest
```
[Github Packages](https://github.com/rajnandan1/kener/pkgs/container/kener)
```
ghcr.io/rajnandan1/kener:latest
```
You should mount a host directory to persist your configuration and expose the web port. Environmental variables [found below](#environment-variable) can be passed with `-e` An example `docker run` command:
```shell
docker 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](docker-compose.yml)
### Using PUID and PGID
If you are
* running on a **linux host** (ie unraid) and
* **not** using [rootless containers with Podman](https://developers.redhat.com/blog/2020/09/25/rootless-containers-with-podman-the-basics#why_podman_)
then you must set the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-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:
```shell
docker run -d ... -e "PUID=1000" -e "PGID=1000" ... rajnandan1/kener
```
or substitute them in [docker-compose.yml](/docker-compose.yml)
## Github Setup
Kener uses github for incident management. Issues created in github using certain tags go to kener as incidents.
### Step 1: Github Repositiory and Add to site.yaml