From 8c61591c8a26dfcbc179b2d2e9df61e140b6d939 Mon Sep 17 00:00:00 2001 From: Michele Cereda Date: Sun, 2 Jun 2024 22:42:48 +0200 Subject: [PATCH] chore(kb): start article about uptime kuma --- knowledge base/monitoring.md | 58 ++++++++++++++++++++++++++++ knowledge base/self-hosting.md | 28 +++++++++----- knowledge base/uptime kuma.md | 70 ++++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+), 9 deletions(-) create mode 100644 knowledge base/monitoring.md create mode 100644 knowledge base/uptime kuma.md diff --git a/knowledge base/monitoring.md b/knowledge base/monitoring.md new file mode 100644 index 0000000..946beae --- /dev/null +++ b/knowledge base/monitoring.md @@ -0,0 +1,58 @@ +# Monitoring + +TODO + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + + + + + + + +## Further readings + +- [Uptime Kuma] + +### Sources + + + + + +[uptime kuma]: uptime%20kuma.md + + + + diff --git a/knowledge base/self-hosting.md b/knowledge base/self-hosting.md index 544f376..6936659 100644 --- a/knowledge base/self-hosting.md +++ b/knowledge base/self-hosting.md @@ -9,15 +9,17 @@ The _art_ of hosting and managing applications on one's own servers instead of c ## Software -| Name | Description | Alternatives | -| ---------------- | -------------------------- | --------------------------------- | -| [Baikal] | CalDAV and CardDAV server | [Radicale](https://radicale.org/) | -| [Gitea] | Git server | [Gitlab] | -| [Gitlab] | Git server | [Gitea] | -| [Home Assistant] | Home automation platform | | -| [NextCloud] | File sharing platform | [OwnCloud](https://owncloud.com/) | -| [Paperless-ngx] | Document management system | | -| [PhotoPrism] | Google Photos replacement | | +| Name | Description | Alternatives | +| ---------------- | -------------------------- | ------------------------------- | +| [Baikal] | CalDAV and CardDAV server | [Radicale] | +| [Gitea] | Git server | [Gitlab] | +| [Gitlab] | Git server | [Gitea] | +| [Home Assistant] | Home automation platform | | +| [NextCloud] | File sharing platform | [OwnCloud] | +| [Paperless-ngx] | Document management system | | +| [PhotoPrism] | Google Photos replacement | | +| [Uptime Kuma] | Status page | [Gatus], [Statping-ng], [Vigil] | +| [OpenMediaVault] | NAS solution | [TrueNAS] | ## Further readings @@ -36,10 +38,18 @@ The _art_ of hosting and managing applications on one's own servers instead of c [gitea]: gitea.md [gitlab]: gitlab/README.md [nextcloud]: nextcloud.md +[openmediavault]: openmediavault.md [paperless-ngx]: paperless-ngx.md [photoprism]: photoprism.md +[uptime kuma]: uptime%20kuma.md [awesome-selfhosted]: https://awesome-selfhosted.net/ +[gatus]: https://github.com/TwiN/gatus [home assistant]: https://www.home-assistant.io/ +[owncloud]: https://owncloud.com/ +[radicale]: https://radicale.org/ [service as a software substitute]: https://www.gnu.org/philosophy/who-does-that-server-really-serve.html +[statping-ng]: https://statping-ng.github.io/ +[truenas]: https://www.truenas.com/ +[vigil]: https://github.com/valeriansaliou/vigil diff --git a/knowledge base/uptime kuma.md b/knowledge base/uptime kuma.md new file mode 100644 index 0000000..24e763f --- /dev/null +++ b/knowledge base/uptime kuma.md @@ -0,0 +1,70 @@ +# Uptime Kuma + +TODO + +Fancy and easy-to-use self-hosted monitoring tool. + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +Only **one** user as of 2024-06-01. + +
+ Installation and configuration + +```sh +docker pull 'louislam/uptime-kuma:1' +``` + +
+ +
+ Usage + +```sh +# Start. +docker run -d --restart 'always' --name 'uptime-kuma' -p '3001:3001' -v 'uptime-kuma:/app/data' 'louislam/uptime-kuma:1' + +# Password reset. +docker exec -it 'uptime-kuma' npm run reset-password +``` + +
+ + + +## Further readings + +- [Website] +- [Github] +- [Documentation] +- [`uptime-kuma-api`][uptime-kuma-api] + +### Sources + + + + + + + +[documentation]: https://github.com/louislam/uptime-kuma/wiki +[github]: https://github.com/louislam/uptime-kuma +[uptime-kuma-api]: https://github.com/lucasheld/uptime-kuma-api +[website]: https://uptime.kuma.pet/ + +