chore: update README.md
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
0d6ee87cae
commit
900e7abc58
|
@ -6,7 +6,7 @@ A minimalist backend for [sessions-ext](https://gitea.dwysokinski.me/twhelp/sess
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
#### Set up the environment
|
#### Setting up the environment
|
||||||
|
|
||||||
Prerequisites:
|
Prerequisites:
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ skaffold run --port-forward=true --tail=true
|
||||||
skaffold delete
|
skaffold delete
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Run unit tests
|
#### Running unit tests
|
||||||
|
|
||||||
At least one of the following is required to run 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)
|
- Docker ([dockertest](https://github.com/ory/dockertest) will spin up a database)
|
||||||
|
@ -60,7 +60,7 @@ Configuration options can be specified via environment variables.
|
||||||
| ``API_SWAGGER_ENABLED`` | ``false`` | Enables the API documentation endpoints (e.g. ``/api/v1/swagger/index.html``, ``/api/v1/swagger/doc.json``) |
|
| ``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_HOST`` | | Host (name or ip) serving the API (e.g. localhost:8080) |
|
||||||
| ``API_SWAGGER_SCHEMES`` | ``http,https`` | Comma-separated list of protocols |
|
| ``API_SWAGGER_SCHEMES`` | ``http,https`` | Comma-separated list of protocols |
|
||||||
| ``API_CORS_ENABLED`` | ``false`` | Enables cors headers |
|
| ``API_CORS_ENABLED`` | ``false`` | Enables CORS headers |
|
||||||
| ``API_CORS_ALLOWED_ORIGINS`` | | Comma-separated list of allowed domains |
|
| ``API_CORS_ALLOWED_ORIGINS`` | | Comma-separated list of allowed domains |
|
||||||
| ``API_CORS_ALLOW_CREDENTIALS`` | ``false`` | Whether requests with credentials are allowed |
|
| ``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_ALLOWED_METHODS`` | ``HEAD,GET,POST,PUT`` | Comma-separated list of allowed methods |
|
||||||
|
|
Loading…
Reference in New Issue