mirror
/
wakapi
mirror of https://github.com/muety/wakapi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: instructions for go install [ci skip]

This commit is contained in:
Ferdinand Mütsch 2022-06-29 23:39:35 +02:00
parent 099cdaddbc
commit 2173954b84
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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.