https://github.com/jjideenschmiede/uptime-kuma-push-service

An little docker container to send an heartbeat to uptime kuma.
https://github.com/jjideenschmiede/uptime-kuma-push-service

docker docker-image golang uptime-kuma

Last synced: about 2 months ago
JSON representation

An little docker container to send an heartbeat to uptime kuma.

• Host: GitHub
• URL: https://github.com/jjideenschmiede/uptime-kuma-push-service
• Owner: jjideenschmiede
• License: mit
• Created: 2021-11-25T09:09:02.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-26T19:27:45.000Z (about 3 years ago)
• Last Synced: 2024-10-12T06:42:23.354Z (3 months ago)
• Topics: docker, docker-image, golang, uptime-kuma
• Language: Go
• Homepage: https://github.com/louislam/uptime-kuma/blob/master/README.md
• Size: 24.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Uptime Kuma Push Service

[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/jjideenschmiede/uptime-kuma-push-service.svg)](https://golang.org/) [![Go](https://github.com/jjideenschmiede/uptime-kuma-push-service/actions/workflows/go.yml/badge.svg)](https://github.com/jjideenschmiede/uptime-kuma-server-push/actions/workflows/go.yml) [![Docker Image CI](https://github.com/jjideenschmiede/uptime-kuma-push-service/actions/workflows/docker-image.yml/badge.svg)](https://github.com/jjideenschmiede/uptime-kuma-server-push/actions/workflows/docker-image.yml) [![Docker Hub](https://img.shields.io/docker/pulls/jjdevelopment/uptime-kuma-push-service.svg)](https://hub.docker.com/r/jjdevelopment/uptime-kuma-push-service)

This Docker image is for sending a heartbeat to an [Uptime Kuma](https://github.com/louislam/uptime-kuma) server. Here you will find a little introduction on how to use it.

The whole thing is brought to run in a Docker container. For this, a few variables from the Dockerfile are needed, if they are not stored, then they have a default value stored. You can find the variables here.

| Variable | Default value |

|----------|:-------------:|

| URL      | default       |

| MSG      | OK            |

| URL      | * * * * *     |

The URL must be stored. The other values can be used directly as default values. The milliseconds for the ping are calculated directly during the execution of the software.

## Launch Docker Container

To start the container properly, here is a small template. No volumes need to be mapped and no port is needed, because the software does not need to be accessed directly.

```console

docker run -d --restart always --name uptime-kuma-push-service -e URL='https://uptime-kuma.test.de/api/push/M4KzP0tSTB' jjdevelopment/uptime-kuma-push-service

```

Now the container can be started, so that the service can access your Uptime Kuma service and you always know if your servers in the office or at home are still running.

If you want to run the docker image on a raspberry pi, you have to clone the repository once and create a docker image with the command `docker image build -t jjdevelopment/uptime-kuma-server-push .`.

Click [here](https://hub.docker.com/r/jjdevelopment/uptime-kuma-push-service) to go directly to the Docker HUB.

## Contribute

If you want to help with development, or have found a bug, open a [new issue](https://github.com/jjideenschmiede/uptime-kuma-push-service/issues).