An open API service indexing awesome lists of open source software.

https://github.com/airscripts/kuma

A simple Docker Compose implementation of famous Uptime Kuma.
https://github.com/airscripts/kuma

healthcheck kuma service

Last synced: about 3 hours ago
JSON representation

A simple Docker Compose implementation of famous Uptime Kuma.

Awesome Lists containing this project

README

          

# Kuma
A simple Docker Compose implementation of famous Uptime Kuma.

## Table of Contents
- [Installation](#installation)
- [Requirements](#requirements)
- [Usage](#usage)
- [Resources](#resources)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)

## Installation
Follow the steps below to make use of Kuma.

Clone this repository:
```bash
git clone https://github.com/airscripts/kuma.git
```

## Requirements
- Docker

## Usage
In order to use the stuff found in this repository run:
```bash
bash init.sh
```
This will initialize the required stuff for spinning up the service.

After that just run a simple:
```bash
docker compose up
```

And everything will be available at port 3001 of your localhost.

## Resources
- Docker: https://www.docker.com/
- Uptime Kuma: https://uptime.kuma.pet/

## Contributing
Contributions and suggestions about how to improve this project are welcome!
Please follow [our contribution guidelines](https://github.com/airscripts/kuma/blob/main/CONTRIBUTING.md).

## Support
If you want to support my work you can do it by following me, leaving a star, sharing my projects or also donating at the links below.
Choose what you find more suitable for you:


GitHub Sponsors
 

Kofi

## License
This repository is licensed under [GPL-3.0 License](https://github.com/airscripts/kuma/blob/main/LICENSE).