Donate to mrmarkuz

Uptime Kuma

Uptime Kuma 'a self-hosted monitoring tool'

The Uptime Kuma app announcement

Uptime Kuma is a community application from the mrmarkuz repository. Documentation and source can be found on GitHub.
Please see the excerpt from the readme.md

README.md
This is a template module for [NethServer 8](https://github.com/NethServer/ns8-core).
To start a new module from it:
 
1. Click on [Use this template](https://github.com/NethServer/ns8-uptime-kuma/generate).
   Name your repo with `ns8-` prefix (e.g. `ns8-mymodule`). 
   Do not end your module name with a number, like ~~`ns8-baaad2`~~!
 
1. Clone the repository, enter the cloned directory and
   [configure your GIT identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_your_identity)
 
1. Rename some references inside the repo:
   ```
   modulename=$(basename $(pwd) | sed 's/^ns8-//') &&
   git mv imageroot/systemd/user/uptime-kuma.service imageroot/systemd/user/${modulename}.service &&
   git mv imageroot/systemd/user/uptime-kuma-app.service imageroot/systemd/user/${modulename}-app.service && 
   git mv tests/uptime-kuma.robot tests/${modulename}.robot &&
   sed -i "s/uptime-kuma/${modulename}/g" $(find .github/ * -type f) &&
   git commit -a -m "Repository initialization"
   ```
 
1. Edit this `README.md` file, by replacing this section with your module
   description
 
1. Adjust `.github/workflows` to your needs. `clean-registry.yml` might
   need the proper list of image names to work correctly. Unused workflows
   can be disabled from the GitHub Actions interface.
 
1. Commit and push your local changes
 
## Install
 
Instantiate the module with:
 
    add-module ghcr.io/nethserver/uptime-kuma:latest 1
 
The output of the command will return the instance name.
Output example:
 
    {"module_id": "uptime-kuma1", "image_name": "uptime-kuma", "image_url": "ghcr.io/nethserver/uptime-kuma:latest"}
 
## Configure
 
Let's assume that the mattermost instance is named `uptime-kuma1`.
 
Launch `configure-module`, by setting the following parameters:
- `host`: a fully qualified domain name for the application
- `http2https`: enable or disable HTTP to HTTPS redirection (true/false)
- `lets_encrypt`: enable or disable Let's Encrypt certificate (true/false)
 
 
Example:
 
```
api-cli run configure-module --agent module/uptime-kuma1 --data - <<EOF
{
  "host": "uptime-kuma.domain.com",
  "http2https": true,
  "lets_encrypt": false
}
EOF
```
 
The above command will:
- start and configure the uptime-kuma instance
- configure a virtual host for trafik to access the instance
 
## Get the configuration
You can retrieve the configuration with
 
```
api-cli run get-configuration --agent module/uptime-kuma1
```
 
## Uninstall
 
To uninstall the instance:
 
    remove-module --no-preserve uptime-kuma1

.


  • ns8/applications/uptime-kuma.txt
  • Last modified: 14 months ago
  • by LayLow