Add compose and README

This commit is contained in:
2025-04-17 11:32:50 +02:00
parent 20fc8b019e
commit e252992930
2 changed files with 29 additions and 0 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
dockup
---
# Quick start
Get the provided `compose.yaml`.
```bash
docker compose up -d
```
# Dependencies
This program needs [regctl](https://github.com/regclient/regclient.git).
It is shipped with container image by default.
# Configuration
Configuration options are available via environment variables:
- `DOCKUP_INTERVAL`: Time between refreshes (30 min by default)
- `DOCKUP_PORT`: Change default port - Do not set this option when running via Docker (Defaults to 8000)

12
compose.yaml Normal file
View File

@@ -0,0 +1,12 @@
---
name: dockup
services:
dockup:
image: registry.gitlab.com/ramiuslr/dockup:latest
container_name: dockup
restart: always
ports:
- 8000:8000
environment:
DOCKUP_INTERVAL: 5 # Defaults to 30
...