+ 
-
+
@@ -8,19 +10,23 @@
+[Sponsor Me Using Github](https://github.com/sponsors/rajnandan1)
-
+[Buy Me a Coffee](https://www.buymeacoffee.com/rajnandan1)
diff --git a/scripts/startup.js b/build.js
similarity index 60%
rename from scripts/startup.js
rename to build.js
index 8e8042ebb..4329052fe 100644
--- a/scripts/startup.js
+++ b/build.js
@@ -1,29 +1,17 @@
-/*
-The startup js script will
-check if monitors.yaml exists
-if it does, it will read the file and parse it into a json array of objects
-each objects will have a name, url, method: required
-name of each of these objects need to be unique
-*/
-import * as dotenv from "dotenv";
-import fs from "fs-extra";
import yaml from "js-yaml";
-import { Cron } from "croner";
-import { FOLDER, FOLDER_MONITOR, FOLDER_SITE, API_TIMEOUT } from "./constants.js";
+import fs from "fs-extra";
+import axios from "axios";
import {
IsValidURL,
+ checkIfDuplicateExists,
+ getWordsStartingWithDollar,
IsValidHTTPMethod,
- LoadMonitorsPath,
- LoadSitePath,
ValidateIpAddress
-} from "./tool.js";
-import { GetAllGHLabels, CreateGHLabel } from "./github.js";
-import { Minuter } from "./cron-minute.js";
-import axios from "axios";
-import { Ninety } from "./ninety.js";
-let monitors = [];
-let site = {};
-const envSecrets = [];
+} from "./src/lib/server/tool.js";
+import { API_TIMEOUT, AnalyticsProviders } from "./src/lib/server/constants.js";
+
+const configPathFolder = "./config";
+const databaseFolder = process.argv[2] || "./database";
const defaultEval = `(function (statusCode, responseTime, responseData) {
let statusCodeShort = Math.floor(statusCode/100);
if(statusCode == 429 || (statusCodeShort >=2 && statusCodeShort <= 3)) {
@@ -37,37 +25,34 @@ const defaultEval = `(function (statusCode, responseTime, responseData) {
latency: responseTime,
}
})`;
-
-function checkIfDuplicateExists(arr) {
- return new Set(arr).size !== arr.length;
-}
-function getWordsStartingWithDollar(text) {
- const regex = /\$\w+/g;
- const wordsArray = text.match(regex);
- return wordsArray || [];
-}
-if (!fs.existsSync(FOLDER)) {
- fs.mkdirSync(FOLDER);
- console.log(".kener folder created successfully!");
-}
-
-const Startup = async () => {
+async function Build() {
+ console.log("Building Kener...");
+ let site = {};
+ let monitors = [];
try {
- const fileContent = fs.readFileSync(LoadMonitorsPath(), "utf8");
- site = yaml.load(fs.readFileSync(LoadSitePath(), "utf8"));
- monitors = yaml.load(fileContent);
+ site = yaml.load(fs.readFileSync(configPathFolder + "/site.yaml", "utf8"));
+ monitors = yaml.load(fs.readFileSync(configPathFolder + "/monitors.yaml", "utf8"));
} catch (error) {
console.log(error);
process.exit(1);
}
- // Use the 'monitors' array of JSON objects as needed
- //check if each object has name, url, method
- //if not, exit with error
- //if yes, check if name is unique
+ if (
+ site.github === undefined ||
+ site.github.owner === undefined ||
+ site.github.repo === undefined
+ ) {
+ console.log("github owner and repo are required");
+ process.exit(1);
+ }
+
+ const FOLDER_DB = databaseFolder;
+ const FOLDER_SITE = FOLDER_DB + "/site.json";
+ const FOLDER_MONITOR = FOLDER_DB + "/monitors.json";
for (let i = 0; i < monitors.length; i++) {
const monitor = monitors[i];
+
let name = monitor.name;
let tag = monitor.tag;
let hasAPI = monitor.api !== undefined && monitor.api !== null;
@@ -143,6 +128,7 @@ const Startup = async () => {
let evaluator = monitor.api.eval;
let body = monitor.api.body;
let timeout = monitor.api.timeout;
+ let hideURLForGet = !!monitor.api.hideURLForGet;
//url
if (!!url) {
if (!IsValidURL(url)) {
@@ -168,7 +154,7 @@ const Startup = async () => {
try {
JSON.parse(JSON.stringify(headers));
} catch (error) {
- console.log("headers are not valid. Quiting");
+ console.log("headers are not valid. Quitting");
process.exit(1);
}
}
@@ -213,9 +199,10 @@ const Startup = async () => {
}
//add a description to the monitor if it is website using api.url and method = GET and headers == undefined
- //call the it to see if recevied content-type is text/html
+ //call the it to see if received content-type is text/html
//if yes, append to description
if (
+ !hideURLForGet &&
(headers === undefined || headers === null) &&
url !== undefined &&
method === "GET"
@@ -240,8 +227,8 @@ const Startup = async () => {
}
}
- monitors[i].path0Day = `${FOLDER}/${folderName}.0day.utc.json`;
- monitors[i].path90Day = `${FOLDER}/${folderName}.90day.utc.json`;
+ monitors[i].path0Day = `${FOLDER_DB}/${folderName}.0day.utc.json`;
+ monitors[i].path90Day = `${FOLDER_DB}/${folderName}.90day.utc.json`;
monitors[i].hasAPI = hasAPI;
//secrets can be in url/body/headers
@@ -260,16 +247,34 @@ const Startup = async () => {
}
}
}
- if (
- site.github === undefined ||
- site.github.owner === undefined ||
- site.github.repo === undefined
- ) {
- console.log("github owner and repo are required");
- process.exit(1);
- }
+
if (site.github.incidentSince === undefined || site.github.incidentSince === null) {
- site.github.incidentSince = 48;
+ site.github.incidentSince = 720;
+ }
+ if (site.siteName === undefined) {
+ site.siteName = site.title;
+ }
+ if (!!site.analytics) {
+ const providers = {};
+
+ for (let i = 0; i < site.analytics.length; i++) {
+ const element = site.analytics[i];
+ if (!!AnalyticsProviders[element.type]) {
+ if (providers[element.type] === undefined) {
+ providers[element.type] = {};
+ providers[element.type].measurementIds = [];
+ providers[element.type].script = AnalyticsProviders[element.type];
+ }
+ providers[element.type].measurementIds.push(element.id);
+ }
+ }
+ site.analytics = providers;
+ }
+ if (!!!site.font || !!!site.font.cssSrc || !!!site.font.family) {
+ site.font = {
+ cssSrc: "https://fonts.googleapis.com/css2?family=Albert+Sans:ital,wght@0,100..900;1,100..900&display=swap",
+ family: "Albert Sans"
+ };
}
if (checkIfDuplicateExists(monitors.map((monitor) => monitor.folderName)) === true) {
console.log("duplicate monitor detected");
@@ -290,107 +295,6 @@ const Startup = async () => {
console.log(error);
process.exit(1);
}
+}
- if (!!site.github && !!site.github.owner && !!site.github.repo) {
- const ghowner = site.github.owner;
- const ghrepo = site.github.repo;
- const ghlabels = await GetAllGHLabels(ghowner, ghrepo);
- const tagsAndDescription = monitors.map((monitor) => {
- return { tag: monitor.tag, description: monitor.name };
- });
- //add incident label if does not exist
-
- if (ghlabels.indexOf("incident") === -1) {
- await CreateGHLabel(ghowner, ghrepo, "incident", "Status of the site");
- }
- if (ghlabels.indexOf("resolved") === -1) {
- await CreateGHLabel(ghowner, ghrepo, "resolved", "Incident is resolved", "65dba6");
- }
- if (ghlabels.indexOf("identified") === -1) {
- await CreateGHLabel(ghowner, ghrepo, "identified", "Incident is Identified", "EBE3D5");
- }
- if (ghlabels.indexOf("investigating") === -1) {
- await CreateGHLabel(
- ghowner,
- ghrepo,
- "investigating",
- "Incident is investigated",
- "D4E2D4"
- );
- }
- if (ghlabels.indexOf("incident-degraded") === -1) {
- await CreateGHLabel(
- ghowner,
- ghrepo,
- "incident-degraded",
- "Status is degraded of the site",
- "f5ba60"
- );
- }
- if (ghlabels.indexOf("incident-down") === -1) {
- await CreateGHLabel(
- ghowner,
- ghrepo,
- "incident-down",
- "Status is down of the site",
- "ea3462"
- );
- }
- //add tags if does not exist
- for (let i = 0; i < tagsAndDescription.length; i++) {
- const tag = tagsAndDescription[i].tag;
- const description = tagsAndDescription[i].description;
- if (ghlabels.indexOf(tag) === -1) {
- await CreateGHLabel(ghowner, ghrepo, tag, description);
- }
- }
- }
-
- // init monitors
- for (let i = 0; i < monitors.length; i++) {
- const monitor = monitors[i];
- if (!fs.existsSync(monitor.path0Day)) {
- fs.ensureFileSync(monitor.path0Day);
- fs.writeFileSync(monitor.path0Day, JSON.stringify({}));
- }
- if (!fs.existsSync(monitor.path90Day)) {
- fs.ensureFileSync(monitor.path90Day);
- fs.writeFileSync(monitor.path90Day, JSON.stringify({}));
- }
-
- console.log("Initial Fetch for ", monitor.name);
- await Minuter(envSecrets, monitor, site.github);
- await Ninety(monitor);
- }
-
- //trigger minute cron
-
- for (let i = 0; i < monitors.length; i++) {
- const monitor = monitors[i];
-
- let cronExpession = "* * * * *";
- if (monitor.cron !== undefined && monitor.cron !== null) {
- cronExpession = monitor.cron;
- }
- console.log("Staring " + cronExpession + " Cron for ", monitor.name);
- Cron(cronExpession, async () => {
- await Minuter(envSecrets, monitor, site.github);
- });
- }
-
- //pre compute 90 day data at 1 minute interval
- Cron(
- "* * * * *",
- async () => {
- for (let i = 0; i < monitors.length; i++) {
- const monitor = monitors[i];
- Ninety(monitor);
- }
- },
- {
- protect: true
- }
- );
-};
-
-export { Startup };
+Build();
diff --git a/config/monitors.example.yaml b/config/monitors.example.yaml
index 219c783d6..f6819498e 100644
--- a/config/monitors.example.yaml
+++ b/config/monitors.example.yaml
@@ -1,17 +1,10 @@
-- name: Google Search
- description: Search the world's information, including webpages, images, videos and more.
- tag: "google-search"
- image: "/google.png"
+- name: OkBookmarks
+ description: A free bookmark manager that lets you save and search your bookmarks in the cloud.
+ tag: "okbookmarks"
+ image: "https://okbookmarks.com/assets/img/extension_icon128.png"
api:
method: GET
- url: https://www.google.com/webhp
-- name: Svelte Website
- description: Cybernetically enhanced web apps
- tag: "svelte-website"
- api:
- method: GET
- url: https://svelte.dev/
- image: "/svelte.svg"
+ url: https://okbookmarks.com
- name: Earth
description: Our blue planet
tag: "earth"
diff --git a/config/site.example.yaml b/config/site.example.yaml
index fa73fdcd2..fe5e0a623 100644
--- a/config/site.example.yaml
+++ b/config/site.example.yaml
@@ -1,10 +1,13 @@
-title: "Kener"
+title: "Kener - Open-Source and Modern looking Node.js Status Page for Effortless Incident Management"
+siteName: "Kener.ing"
home: "/"
logo: "/logo.png"
+siteURL: "https://kener.ing"
+favicon: "/logo96.png"
github:
owner: "rajnandan1"
repo: "kener"
- incidentSince: 48
+ incidentSince: 720
metaTags:
description: "Kener: Open-source modern looking Node.js status page tool, designed to make service monitoring and incident handling a breeze. It offers a sleek and user-friendly interface that simplifies tracking service outages and improves how we communicate during incidents. And the best part? Kener integrates seamlessly with GitHub, making incident management a team effort—making it easier for us to track and fix issues together in a collaborative and friendly environment."
keywords: "Node.js status page, Incident management tool, Service monitoring, Service outage tracking, Real-time status updates, GitHub integration for incidents, Open-source status page, Node.js monitoring application, Service reliability, User-friendly incident management, Collaborative incident resolution, Seamless outage communication, Service disruption tracker, Real-time incident alerts, Node.js status reporting"
@@ -21,11 +24,15 @@ metaTags:
twitter:description: "Kener: Open-source Node.js status page tool, designed to make service monitoring and incident handling a breeze. It offers a sleek and user-friendly interface that simplifies tracking service outages and improves how we communicate during incidents. And the best part? Kener integrates seamlessly with GitHub, making incident management a team effort—making it easier for us to track and fix issues together in a collaborative and friendly environment."
nav:
- name: "Documentation"
- url: "/docs"
+ url: "/docs/home"
- name: "Github"
+ iconURL: "/github.svg"
url: "https://github.com/rajnandan1/kener"
+ - name: "Buy me a coffee"
+ iconURL: "/buymeacoffee.svg"
+ url: "https://buymeacoffee.com/rajnandan1"
hero:
- title: Kener is a Open-Source Status Page System
+ title: Kener is a Modern Open-Source Status Page System
subtitle: Let your users know what's going on.
footerHTML: |
Made using
@@ -41,4 +48,8 @@ i18n:
zh-CN: "中文"
ja: "日本語"
vi: "Tiếng Việt"
-theme: dark
+pattern: "squares"
+analytics:
+ - id: "G-Q3MLRXCBFT"
+ type: "GA"
+
diff --git a/config/static/.kener b/config/static/.kener
deleted file mode 100644
index 53d195994..000000000
--- a/config/static/.kener
+++ /dev/null
@@ -1 +0,0 @@
-I am Empty File
\ No newline at end of file
diff --git a/database/.kener b/database/.kener
new file mode 100644
index 000000000..251d0a516
--- /dev/null
+++ b/database/.kener
@@ -0,0 +1 @@
+database folder
\ No newline at end of file
diff --git a/db/.kener b/db/.kener
new file mode 100644
index 000000000..d0ddae9a0
--- /dev/null
+++ b/db/.kener
@@ -0,0 +1 @@
+.kener
\ No newline at end of file
diff --git a/dev.js b/dev.js
deleted file mode 100644
index 20d9bdc3b..000000000
--- a/dev.js
+++ /dev/null
@@ -1,2 +0,0 @@
-import { Startup } from "./scripts/startup.js";
-Startup();
diff --git a/docker-compose.yml b/docker-compose.yml
index 3628d4387..d33da656c 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,13 +1,16 @@
version: '3.7'
services:
kener:
- image: rajnandan1/kener:latest # assuming this is final namespace/image
- container_name: kener
+ image: rajnandan1/kener:release-candidate-0.0.16 # assuming this is final namespace/image
+ container_name: kener-rc
+ #env_file: .env #uncomment this, if you are using .env file
environment:
- TZ=Etc/GMT
#- GH_TOKEN=
#- API_TOKEN=
- #- API_IP
+ #- API_IP=
+ #- API_IP_REGEX=
+ #- KENER_BASE_PATH=
# If running on a LINUX HOST and not podman rootless these MUST BE SET
# run "id $user" from command line and replace numbers below with output from command
@@ -17,15 +20,8 @@ services:
### Most likely DO NOT need to change anything below this ###
#- PORT=3000 Port app listens on IN CONTAINER
-
- ### If any of the below are changed make sure the bound volume is correct as well ###
- #- CONFIG_DIR=/config
- #- PUBLIC_KENER_FOLDER=/config/static
- #- MONITOR_YAML_PATH=/config/monitors.yaml
- #- SITE_YAML_PATH=/config/site.yaml
- #- KENER_BASE_PATH=/status
-
ports:
- '3000:3000/tcp'
volumes:
- - '/host/path/to/config:/config:rw'
+ - './database:/app/database:rw'
+ - './config:/app/config'
diff --git a/docker/root/etc/s6-overlay/s6-rc.d/svc-app/run b/docker/root/etc/s6-overlay/s6-rc.d/svc-app/run
index 6a00a2096..ff7586f96 100755
--- a/docker/root/etc/s6-overlay/s6-rc.d/svc-app/run
+++ b/docker/root/etc/s6-overlay/s6-rc.d/svc-app/run
@@ -3,5 +3,12 @@
echo -e "\nApp is starting!"
export NODE_ENV=production
cd /app || exit
-exec \
- s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/prod.js
+
+# Run build first
+s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/build.js && (
+ # Run startup and main in parallel
+ s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/src/lib/server/startup.js &
+ s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/main.js &
+ # Wait for both processes
+ wait
+)
\ No newline at end of file
diff --git a/docs/categorize-guide.md b/docs/categorize-guide.md
new file mode 100644
index 000000000..54c0b23ac
--- /dev/null
+++ b/docs/categorize-guide.md
@@ -0,0 +1,45 @@
+---
+title: Categorize Monitors Guide | Kener
+description: Categorize Monitors in Kener
+---
+
+# Categorize Monitors
+
+Let us add a category to our monitors.
+
+## Sample monitors.yaml
+
+```yaml
+- name: OkBookmarks
+ description: A free bookmark manager that lets you save and search your bookmarks in the cloud.
+ tag: "okbookmarks"
+ image: "https://okbookmarks.com/assets/img/extension_icon128.png"
+ api:
+ method: GET
+ url: https://okbookmarks.com
+- name: Earth
+ description: Our blue planet
+ tag: "earth"
+ defaultStatus: "UP"
+ image: "/earth.png"
+ category: "Hello"
+- name: Frogment
+ description: A free openAPI spec editor and linter that breaks down your spec into fragments to make editing easier and more intuitive. Visit https://www.frogment.com
+ tag: "frogment"
+ image: "/frogment.png"
+ api:
+ method: GET
+ url: https://www.frogment.com
+```
+
+## Sample site.yaml
+
+```yaml
+#...
+categories:
+ - name: Hello
+ description: Say Hello to the world
+#...
+```
+
+The above will have OkBookmarks and Frogment under home. Earth will be under Hello category.
diff --git a/docs/changelogs.md b/docs/changelogs.md
new file mode 100644
index 000000000..75543bda6
--- /dev/null
+++ b/docs/changelogs.md
@@ -0,0 +1,42 @@
+---
+title: Changelogs | Kener
+description: Changelogs for Kener
+---
+
+# Changelogs
+
+## v0.0.16
+
+
+
+ 
+
+ 
+ 
+ 
++
![]({monitor.image.startsWith("/"))
{/if}
+
+ @@ -151,7 +161,7 @@
+ 
+