periodicator/README.md

26 lines
630 B
Markdown
Raw Normal View History

# Periodicator
A thing that do some things periodically.
Initially created for periodic issues (or tasks) creation in Gitlab.
## Installing
There are several ways to install Periodicator.
### Using binary release
Head over releases page, grab your binary and configure your system to start binary using cron.
### Using Docker image
2021-09-27 18:03:17 +05:00
Compose a configuration file (read below) and add this to your cron:
```shell
2021-11-21 17:41:00 +05:00
docker run --rm -v ./config.yaml:/periodicator.yaml pztrn/periodicator:latest
2021-09-27 18:03:17 +05:00
```
## Configuring
2021-09-27 18:03:17 +05:00
See config.example.yaml file in repository's root with configuration file structure and parameters description.