From 2173954b84685536fbef72206f0a87106362d69f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferdinand=20M=C3=BCtsch?= Date: Wed, 29 Jun 2022 23:39:35 +0200 Subject: [PATCH] docs: instructions for go install [ci skip] --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b9b3cfc..89505f3 100644 --- a/README.md +++ b/README.md @@ -100,15 +100,16 @@ If you want to run Wakapi on **Kubernetes**, there is [wakapi-helm-chart](https: #### Compile & run ```bash -# Build the executable -$ go build -o wakapi +# Build and install +# Alternatively: go build -o wakapi +$ go install github.com/muety/wakapi@latest -# Adapt config to your needs -$ cp config.default.yml config.yml -$ vi config.yml +# Get default config and customize +$ curl -o wakapi.yml https://raw.githubusercontent.com/muety/wakapi/master/config.default.yml +$ vi wakapi.yml # Run it -$ ./wakapi +$ ./wakapi -config wakapi.yml ``` **Note:** Check the comments in `config.yml` for best practices regarding security configuration and more.