Skip to content

chore: renamed JACKSON_API_KEYS to API_KEYS #2513

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.

Sign up for GitHub

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

Open
deepakprabhakara wants to merge 2 commits into
base: master
Choose a base branch
from
+9 −7
Open

chore: renamed JACKSON_API_KEYS to API_KEYS #2513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5abad45
renamed JACKSON_API_KEYS -> API_KEYS
deepakprabhakara Apr 16, 2026
d42168f
tweak
deepakprabhakara Apr 17, 2026
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
8 changes: 5 additions & 3 deletions docs/polis/deploy/env-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,17 @@ Available from version `1.40.1`.

NPM library option: `acsUrl`

### JACKSON_API_KEYS
### API_KEYS

A comma separated list of API keys that will be validated when serving the API requests (`/api/v1/`).
A comma-separated list of API keys that will be validated when serving the API requests (`/api/v1/`).

For example `JACKSON_API_KEYS=key1,key2,key3`
For example `API_KEYS=key1,key2,key3`
Comment thread
coderabbitai[bot] marked this conversation as resolved.

The API requests will then need to specify an `Authorization` header which contains one of the API keys above in this format:
`Api-Key key1`

`JACKSON_API_KEYS` is still supported but is deprecated, please switch to `API_KEYS` when you can.

### SAML_AUDIENCE

The value of this setting (same as SP EntityID of Ory Polis) allows the Ory Polis instance to verify that it is the intended
Expand Down
8 changes: 4 additions & 4 deletions docs/polis/guides/service.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ response contains the current version of Ory Polis. For example: `{"version":"1.
The docker container can be found at [boxyhq/jackson](https://hub.docker.com/r/boxyhq/jackson/tags). It is preferable to use a
specific version instead of the `latest` tag.

Replace the values for `DB_URL`, `JACKSON_API_KEYS`, `NEXTAUTH_SECRET` and `NEXTAUTH_ADMIN_CREDENTIALS` with your own values
before running docker run command.
Replace the values for `DB_URL`, `API_KEYS`, `NEXTAUTH_SECRET` and `NEXTAUTH_ADMIN_CREDENTIALS` with your own values before
running docker run command.

```bash
docker run \
-p 5225:5225 \
-e DB_ENGINE="sql" \
-e DB_TYPE="postgres" \
-e DB_URL="postgres://postgres:postgres@postgres:5432/postgres" \
-e JACKSON_API_KEYS="secret" \
-e API_KEYS="secret" \
-e NEXTAUTH_URL="http://localhost:5225" \
-e EXTERNAL_URL="http://localhost:5225" \
-e NEXTAUTH_SECRET="super-secret" \
Expand All @@ -42,7 +42,7 @@ docker run \
-p 5225:5225 \
-e DB_ENGINE="mongo" \
-e DB_URL="mongodb://localhost:27017/jackson" \
-e JACKSON_API_KEYS="secret" \
-e API_KEYS="secret" \
-e NEXTAUTH_URL="http://localhost:5225" \
-e EXTERNAL_URL="http://localhost:5225" \
-e NEXTAUTH_SECRET="super-secret" \
Expand Down
Loading