diff --git a/README.md b/README.md index 6d0f2d1..24c9b5c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -62,21 +63,21 @@ 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_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) | -| ``API_SWAGGER_ENABLED`` | ``false`` | Enables the API documentation endpoints (e.g. ``/api/v1/swagger/index.html``, ``/api/v1/swagger/doc.json``) | -| ``API_SWAGGER_HOST`` | | Host (name or ip) serving the API (e.g. localhost:8080) | -| ``API_SWAGGER_SCHEMES`` | ``http,https`` | Comma-separated list of protocols | -| ``API_CORS_ENABLED`` | ``false`` | Enables CORS headers | -| ``API_CORS_ALLOWED_ORIGINS`` | | Comma-separated list of allowed domains | -| ``API_CORS_ALLOW_CREDENTIALS`` | ``false`` | Whether requests with credentials are allowed | -| ``API_CORS_ALLOWED_METHODS`` | ``HEAD,GET,POST,PUT`` | Comma-separated list of allowed methods | -| ``API_CORS_MAX_AGE`` | ``300`` | Max time to cache response (seconds) | +| Env variable | Default | Description | +|--------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ``APP_MODE`` | ``development`` | Whether to use development or production settings | +| ``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) | +| ``API_SWAGGER_ENABLED`` | ``false`` | Enables the API documentation endpoints (e.g. ``/api/v1/swagger/index.html``, ``/api/v1/swagger/doc.json``) | +| ``API_SWAGGER_HOST`` | | Host (name or ip) serving the API (e.g. localhost:8080) | +| ``API_SWAGGER_SCHEMES`` | ``http,https`` | Comma-separated list of protocols | +| ``API_CORS_ENABLED`` | ``false`` | Enables CORS headers | +| ``API_CORS_ALLOWED_ORIGINS`` | | Comma-separated list of allowed domains | +| ``API_CORS_ALLOW_CREDENTIALS`` | ``false`` | Whether requests with credentials are allowed | +| ``API_CORS_ALLOWED_METHODS`` | ``HEAD,GET,POST,PUT`` | Comma-separated list of allowed methods | +| ``API_CORS_MAX_AGE`` | ``300`` | Max time to cache response (seconds) | ## License