twhelp
/
sessions
1
0
Fork 0
Code Issues 1 Pull Requests 10 Packages Projects Releases Wiki Activity

chore: update README.md
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Dawid Wysokiński 2022-12-20 09:44:16 +01:00
parent 5777aee059
commit 7127be6f5f
Signed by: Kichiyaki
GPG Key ID: B5445E357FB8B892
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -38,6 +38,7 @@ skaffold delete
#### Running unit tests
At least one of the following is required to run unit tests:
- Docker ([dockertest](https://github.com/ory/dockertest) will spin up a database)
- Postgres database
@ -63,9 +64,9 @@ go run ./cmd/sessions/main.go db migration create go migration 1
Configuration options can be specified via environment variables.
| Env variable | Default | Description |
|--------------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------|
|--------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ``APP_MODE`` | ``development`` | Whether to use development or production settings |
| ``DB_DSN`` | | **Required.** Syntax: ``postgres://user:password@host:5432/db?sslmode=disable``. Only Postgres is supported. |
| ``DB_DSN`` | | **Required.** Only Postgres is supported. Example: ``postgres://user:password@host:5432/dbname?sslmode=disable`` (https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) |
| ``DB_MAX_OPEN_CONNECTIONS`` | ``5`` | Maximum number of open connections to the database (https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) |
| ``DB_MAX_IDLE_CONNECTIONS`` | ``2`` | Maximum number of connections in the idle connection pool (https://pkg.go.dev/database/sql#DB.SetMaxIdleConns) |
| ``DB_CONNECTION_MAX_LIFETIME`` | ``3m`` | Maximum amount of time a connection may be reused (https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime) |