Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

An little software to accept an ping on a server for uptime kuma.
https://github.com/jjideenschmiede/uptime-kuma-ping-service

docker docker-image golang uptime-kuma

Last synced: 5 days ago
JSON representation

An little software to accept an ping on a server for uptime kuma.

Host: GitHub
URL: https://github.com/jjideenschmiede/uptime-kuma-ping-service
Owner: jjideenschmiede
Created: 2021-11-29T12:56:51.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2021-11-29T15:43:01.000Z (about 3 years ago)
Last Synced: 2024-11-15T04:36:21.633Z (about 2 months ago)
Topics: docker, docker-image, golang, uptime-kuma
Language: Go
Homepage:
Size: 11.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Uptime Kuma Ping 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-ping-service/actions/workflows/go.yml/badge.svg)](https://github.com/jjideenschmiede/uptime-kuma-ping-service/actions/workflows/go.yml) [![Docker Image CI](https://github.com/jjideenschmiede/uptime-kuma-ping-service/actions/workflows/docker-image.yml/badge.svg)](https://github.com/jjideenschmiede/uptime-kuma-ping-service/actions/workflows/docker-image.yml) [![Docker Hub](https://img.shields.io/docker/pulls/jjdevelopment/uptime-kuma-ping-service.svg)](https://hub.docker.com/r/jjdevelopment/uptime-kuma-ping-service)

This Docker is to get an ping from an [Uptime Kuma](https://github.com/louislam/uptime-kuma) service. 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 |
|-----------------------|:-------------:|
| ENABLE_SSL | false |
| CERTIFICATE_CRT_NAME | default |
| CERTIFICATE_KEY_NAME | default |

If the ENABLE_SSL is set to true, then the certificate names must be stored. These must be stored in the volume mapping. Below are the instructions for SSL.

## Launch Docker Container

To start the container properly, here is a small template. A volume mapping is only required if the application is to be operated with SSL.

### With SSL

```console
docker run -d --restart always --name uptime-kuma-ping-service -e ENABLE_SSL='true' -e CERTIFICATE_CRT_NAME='...fullchain.pem' -e CERTIFICATE_KEY_NAME='...key.pem' -v /var/lib/certificates:/go/src/app/files/certificates -p 443:443 jjdevelopment/uptime-kuma-ping-service:latest
```

### Without SSL

```console
docker run -d --restart always --name uptime-kuma-ping-service -p 80:443 jjdevelopment/uptime-kuma-ping-service:latest
```

Now the container can be started, so that your Uptime Kuma can connect to your server and check the service directly. So you know directly if Docker is still running on the server.

Click [here](https://hub.docker.com/r/jjdevelopment/uptime-kuma-ping-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-ping-service/issues).