From f7a05ee641f68402a5c3d9ae32ea7c72b43b6ff3 Mon Sep 17 00:00:00 2001 From: AKP Date: Wed, 6 Apr 2022 11:29:59 +0100 Subject: Update README.md Signed-off-by: AKP --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ceed4b6..7bfd2b2 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,16 @@ ![Web UI](.github/screenshots/webUI.png) -## Quickstart: Docker +## Quickstart + +### Docker ```bash docker pull ghcr.io/codemicro/walrss:latest docker run -d -v $(pwd)/walrss-data:/run -p 8080:8080 ghcr.io/codemicro/walrss:latest ``` -## Quickstart: Build from source +### Build from source You must have an up-to-date version of the Go toolchain installed. Check `go.mod` for the minimum required version. @@ -27,11 +29,12 @@ go build github.com/codemicro/walrss/walrss ```bash mkdir walrss-data WALRSS_DIR="./walrss-data" ./walrss +# now go to http://127.0.0.1:8080 ``` ## Config -Your `config.yaml` file lives in your data directory, which is specified by the `WALRSS_DIR` environment variable (default is `./`). +Your `config.yaml` file lives in your data directory, which is specified by the `WALRSS_DIR` environment variable (default is `./`). Below is a list of the possible options you can set within it. ```yaml server: -- cgit v1.2.3-70-g09d2