https://github.com/batonogov/gron
A simple and flexible task scheduler in a Docker container that supports both standard cron syntax and simplified intervals.
https://github.com/batonogov/gron
cron docker gron
Last synced: 2 months ago
JSON representation
A simple and flexible task scheduler in a Docker container that supports both standard cron syntax and simplified intervals.
- Host: GitHub
- URL: https://github.com/batonogov/gron
- Owner: batonogov
- License: mit
- Created: 2024-12-01T04:10:48.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-28T16:39:18.000Z (3 months ago)
- Last Synced: 2025-02-28T21:17:57.628Z (3 months ago)
- Topics: cron, docker, gron
- Language: Go
- Homepage:
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gron - Docker Cron Scheduler
A simple and flexible task scheduler in a Docker container that supports both standard cron syntax and simplified intervals.
## Features
- Standard cron syntax support
- Simplified interval syntax (`@every`)
- Script execution from mounted directory
- Easy configuration via environment variables
## Usage
### Using Docker Image
```bash
docker run --rm \
-v ./scripts/:/scripts/ \
-e 'TASK_1=*/1 * * * * /scripts/test_script1.sh' \
-e 'TASK_2=@every 10s /scripts/test_script2.sh' \
-e 'TASK_3=@hourly /scripts/test_script3.sh' \
ghcr.io/batonogov/gron:latest
```
### Using Binary in Your Dockerfile
You can download and use pre-built binaries in your own Docker images. Binaries are available for multiple platforms:
- Linux (amd64, arm64)
- macOS (Intel, Apple Silicon)
Example Dockerfile:
```dockerfile
FROM ubuntu:latest
# Download gron binary for linux/amd64
ADD https://github.com/batonogov/gron/releases/download/v0.2.2/gron-linux-amd64 /usr/local/bin/gron
# Make it executable
RUN chmod +x /usr/local/bin/gron
# Your configuration
COPY ./scripts /scripts
ENV TASK_1="*/5 * * * * /scripts/backup.sh"
# Run gron
CMD ["/usr/local/bin/gron"]
```
### Command Structure
```bash
docker run [docker-options] \
-v '/path/to/scripts:/scripts' \
-e 'TASK_NAME=schedule command' \
ghcr.io/batonogov/gron:latest
```
### Supported Schedule Formats
1. Standard cron syntax:
- `*/1 * * * *` - every minute
- `0 */2 * * *` - every 2 hours
- `0 0 * * *` - daily at midnight
2. Simplified syntax with @every:
- `@every 30s` - every 30 seconds
- `@every 1h` - every hour
- `@every 1d` - every day
## Mounting Scripts
Scripts must be mounted into the container using a volume. It's recommended to use the `/scripts/` directory:
```bash
-v ./local/scripts:/scripts
```
## Environment Variables
Tasks are configured through environment variables with the `TASK_` prefix:
- `TASK_1` - first task
- `TASK_2` - second task
- etc.
Format: `TASK_NAME=schedule command`
## Configuration Examples
### Multiple Tasks with Different Schedules
```bash
docker run --rm \
-v ./scripts/:/scripts/ \
-e 'TASK_1=/5 /scripts/backup.sh' \
-e 'TASK_2=@every 1h /scripts/health_check.sh' \
-e 'TASK_3=@daily /scripts/daily_report.sh' \
ghcr.io/batonogov/gron:latest
```
## License
MIT