mirror of
https://github.com/muety/wakapi.git
synced 2023-08-10 21:12:56 +03:00
docs: update readme
This commit is contained in:
@@ -25,12 +25,10 @@ If you like this project, please consider supporting it 🙂. You can donate eit
|
|||||||
|
|
||||||
## Server Setup
|
## Server Setup
|
||||||
### Run from source
|
### Run from source
|
||||||
1. Enable Go module support: `export GO111MODULE=on`
|
1. Clone the project
|
||||||
1. Get code: `go get github.com/muety/wakapi`
|
|
||||||
1. Go to project root: `cd "$GOPATH/src/github.com/muety/wakapi"`
|
|
||||||
1. Copy `.env.example` to `.env` and set database credentials
|
1. Copy `.env.example` to `.env` and set database credentials
|
||||||
1. Adapt `config.ini` to your needs
|
1. Adapt `config.ini` to your needs
|
||||||
1. Build executable: `go build`
|
1. Build executable: `GO111MODULE=on go build`
|
||||||
1. Run server: `./wakapi`
|
1. Run server: `./wakapi`
|
||||||
|
|
||||||
### Run with Docker
|
### Run with Docker
|
||||||
|
@@ -15,21 +15,22 @@ import (
|
|||||||
var cfg *Config
|
var cfg *Config
|
||||||
|
|
||||||
type Config struct {
|
type Config struct {
|
||||||
Env string
|
Env string
|
||||||
Version string
|
Version string
|
||||||
Port int
|
Port int
|
||||||
Addr string
|
Addr string
|
||||||
BasePath string
|
BasePath string
|
||||||
DbHost string
|
DbHost string
|
||||||
DbPort uint
|
DbPort uint
|
||||||
DbUser string
|
DbUser string
|
||||||
DbPassword string
|
DbPassword string
|
||||||
DbName string
|
DbName string
|
||||||
DbDialect string
|
DbDialect string
|
||||||
DbMaxConn uint
|
DbMaxConn uint
|
||||||
CleanUp bool
|
CleanUp bool
|
||||||
DefaultUserName string
|
DefaultUserName string
|
||||||
DefaultUserPassword string
|
DefaultUserPassword string
|
||||||
|
// this is actually a pepper (https://en.wikipedia.org/wiki/Pepper_(cryptography))
|
||||||
PasswordSalt string
|
PasswordSalt string
|
||||||
SecureCookieHashKey string
|
SecureCookieHashKey string
|
||||||
SecureCookieBlockKey string
|
SecureCookieBlockKey string
|
||||||
|
Reference in New Issue
Block a user