Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/4thel00z/uptimed

🌎 The poor 👨‍🦱 man's dyndns. 🦍 It calls an endpoint under your control regularly and comes with a systemd service template. Plays well with: https://github.com/4thel00z/webhookd
https://github.com/4thel00z/uptimed

dyndns go ping reverse-dns systemd uptime

Last synced: about 1 month ago
JSON representation

🌎 The poor 👨‍🦱 man's dyndns. 🦍 It calls an endpoint under your control regularly and comes with a systemd service template. Plays well with: https://github.com/4thel00z/webhookd

Awesome Lists containing this project

README

        

# uptimed

This is uptimed. The poor man's dyndns.
It calls a webserver under your control regularly and comes with a service template.

## Installation

You can also check out the repository and build it with a uptodate golang toolchain, like so:

```
go install github.com/4thel00z/uptimed@latest
# This will create the service template for you
env INTERVAL=30 USER=other_username URL=https://your.service make service > /tmp/uptimed.service
```

### Systemd integration

If you want systemd integration populate your `.env` with the following:

```
# domain of your service
export URL=https://your.service?someidentifier=youcanlookforinthelog
# in seconds
export INTERVAL=30
```

There is an `.env.example` you can copy over to .env.
Also make sure to run the `service` make target (it will print the .service file for you on stdout):

```
mv .env.example .env
vim .env
source .env
make service
```

## How does it work

The url to be called can be configured using the `-url` flag or the `UPTIMED_URL` environment variable.
The sleeping interval defaults to 30 seconds and can be set via the `-interval` flag.
These are populated in the service file for you, as can be seen in the installation section

## License

This project is licensed under the GPL-3 license.