Update docs
This commit is contained in:
18
README.md
18
README.md
@@ -7,9 +7,23 @@ Get the provided `compose.yaml`.
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
# Dependencies
|
||||
# Requirements
|
||||
This program needs [regctl](https://github.com/regclient/regclient.git).
|
||||
It is shipped with container image by default.
|
||||
It is shipped with container image by default, however you'll need to install it by yourself if running script directly.
|
||||
|
||||
Install required *Python* libraries if running directly from script:
|
||||
```bash
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
For local development, add linting tools:
|
||||
```bash
|
||||
pip install isort black flake8 pylint
|
||||
```
|
||||
|
||||
This program also needs read access to `/var/run/docker.sock`.
|
||||
|
||||
# Configuration
|
||||
Configuration options are available via environment variables:
|
||||
|
||||
@@ -7,6 +7,8 @@ services:
|
||||
restart: always
|
||||
ports:
|
||||
- 8000:8000
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
environment:
|
||||
DOCKUP_INTERVAL: 5 # Defaults to 30
|
||||
...
|
||||
|
||||
Reference in New Issue
Block a user