There is a folder called /config. Inside which there is a site.yaml file. You can modify this file to have your own branding.
1linktitle: "Kener"
2linkhome: "/"
3linklogo: "/logo.svg"
4linkgithub:
5link owner: "rajnandan1"
6link repo: "kener"
7link incidentSince: 72
8linkmetaTags:
9link description: "Your description"
10link keywords: "keyword1, keyword2"
11linknav:
12link - name: "Documentation"
13link url: "/docs"
14linkhero:
15link title: Kener is a Open-Source Status Page System
16link subtitle: Let your users know what's going on.
This translates to
1link<title>Your Title</title>
It can be set using theme in site.yaml
1linktheme: dark
1linktheme: light
Can be light or dark. Defaults to light
Location when someone clicks on the your brand in the top nav bar
1link...
2linkhome: "https://www.example.com
3link...
URL of the logo that will be shown in the nav bar. You can also add your logo in the static folder
1link...
2linklogo: "https://www.example.com/logo.png
3link...
It can be set by modifying the <head> tag in src/app.html file.
Example add a png called logo.png file in static/ and then
1link...
2link<link rel="icon" href="/logo.png" />
3link...
For incident kener uses github comments. Create an empty github repo and add them to site.yaml
1linkgithub:
2link owner: "username"
3link repo: "repository"
4link incidentSince: 72
incidentSince is in hours. It means if an issue is created before 72 hours then kener would not honor it. Default is 24
Meta tags are nothing but html <meta>. You can use them for SEO purposes
1linkmetaTags:
2link description: "Your description"
3link keywords: "keyword1, keyword2"
4link og:image: "https://example.com/og.png"
will become
1link<head>
2link <meta name="description" content="Your description" />
3link <meta name="keywords" content="keyword1, keyword2" />
4link <meta name="og:image" content="https://example.com/og.png" />
5link</head>
You can set this to generate SiteMaps
1linksiteURL: https://kener.ing
Sitemaps urls will be https://kener.ing/sitemap.xml
Use hero to add a banner to your kener page
1linkhero:
2link title: Kener is a Open-Source Status Page System
3link subtitle: Let your users know what's going on.
You can add more links to your navbar.
1linknav:
2link - name: "Home"
3link url: "/home"
You can define categories for your monitors. Each category can have a description. The monitors can be grouped by categories.
name=home will be shown in the home page. Categories are shown in the order they are defined in the yaml file. A dropdown will appear in the nav bar to select the category.
1linkcategories:
2link - name: API
3link description: "Kener provides a simple API for you to use to update your status page."
4link - name: home
5link description: "loroem ipsum lorem ipsum"
To set the base path of your kener instance you can set the KENER_BASE_PATH environment variable. This will be used to prefix all the routes in the application. The env variable should not have a trailing slash and should start with /
It should be present during both build and run time. If you are using docker you will have to do your own build and set this env variable during docker build
Please also adjust files in static folder by prefixing them with the base path. For example if you set KENER_BASE_PATH=/status then the logo should be /status/logo.png
You can include any script in the app.html file like google analytics etc
You can add custom css in static/kener.css