docs: update readme

This commit is contained in:
Ferdinand Mütsch 2020-05-28 22:36:00 +02:00
parent 6c2f0cb1ec
commit 98d7d02935
2 changed files with 18 additions and 19 deletions

View File

@ -25,12 +25,10 @@ If you like this project, please consider supporting it 🙂. You can donate eit
## Server Setup
### Run from source
1. Enable Go module support: `export GO111MODULE=on`
1. Get code: `go get github.com/muety/wakapi`
1. Go to project root: `cd "$GOPATH/src/github.com/muety/wakapi"`
1. Clone the project
1. Copy `.env.example` to `.env` and set database credentials
1. Adapt `config.ini` to your needs
1. Build executable: `go build`
1. Build executable: `GO111MODULE=on go build`
1. Run server: `./wakapi`
### Run with Docker

View File

@ -15,21 +15,22 @@ import (
var cfg *Config
type Config struct {
Env string
Version string
Port int
Addr string
BasePath string
DbHost string
DbPort uint
DbUser string
DbPassword string
DbName string
DbDialect string
DbMaxConn uint
CleanUp bool
DefaultUserName string
DefaultUserPassword string
Env string
Version string
Port int
Addr string
BasePath string
DbHost string
DbPort uint
DbUser string
DbPassword string
DbName string
DbDialect string
DbMaxConn uint
CleanUp bool
DefaultUserName string
DefaultUserPassword string
// this is actually a pepper (https://en.wikipedia.org/wiki/Pepper_(cryptography))
PasswordSalt string
SecureCookieHashKey string
SecureCookieBlockKey string