Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add hint for PASETO_KEY generation #178

Merged
merged 1 commit into from
Nov 11, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,13 @@ You can configure the API with environment variables:
Supports PostgreSQL and SQLite.

* `PASETO_KEY` (optional): Base64 encoded 32 bytes key used to check the
[PASETO](https://paseto.io/) authentication tokens.
If not set the API will run in read only mode.
[PASETO](https://paseto.io/) authentication tokens. You can generate it with

```console
head -c 32 /dev/urandom | base64
```

If not set, the API will run in read only mode.

* `ENVIRONMENT` (optional): possible values `test`, `development`, `production`.
Default `production`.
Expand Down