broodjeaap/go-watch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated readme for first start

Browse source
This commit is contained in:
BroodjeAap 2022-12-30 13:40:44 +00:00
parent 26fa9f9995
commit 1bd809ebfe
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -32,17 +32,20 @@ An [XPath](#xpath) filter could also have been used.
## Docker ## Docker
Easiest way to get started is with the prebuilt docker image: Easiest way to get started is with the prebuilt docker image `ghcr.io/broodjeaap/go-watch:master`, first get a config template:
`docker run --rm ghcr.io/broodjeaap/go-watch:master -printConfig 2> config.yaml`
After modifying the config to fit your needs, start the docker container
``` ```
docker run \ docker run \
-p 8080:8080 \ -p 8080:8080 \
-v /host/path/to/config:/config \ -v $PWD/:/config \
ghcr.io/broodjeaap/go-watch:master ghcr.io/broodjeaap/go-watch:master
``` ```
This will start GoWatch with a SQLite database, stored in the `/config` directory, which is probably fine for most use cases. This will start GoWatch with a SQLite database, stored in the `/config` directory, which is probably fine for most use cases.
To use another database, the environment variable `GOWATCH_DATABASE_DSN` can be used, for example with a PostgreSQL database: To use another database, the `database.dsn` value in the config or `GOWATCH_DATABASE_DSN` environment variable can be used, for example with a PostgreSQL database:
``` ```
version: "3" version: "3"