From 5abad45345c2d3f643734424f349b132cf269961 Mon Sep 17 00:00:00 2001 From: Deepak Prabhakara Date: Thu, 16 Apr 2026 22:51:19 +0100 Subject: [PATCH 1/2] renamed JACKSON_API_KEYS -> API_KEYS --- docs/polis/deploy/env-variables.mdx | 6 ++++-- docs/polis/guides/service.mdx | 8 ++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/polis/deploy/env-variables.mdx b/docs/polis/deploy/env-variables.mdx index 8468a5111c..2627165f9e 100644 --- a/docs/polis/deploy/env-variables.mdx +++ b/docs/polis/deploy/env-variables.mdx @@ -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/`). -For example `JACKSON_API_KEYS=key1,key2,key3` +For example `API_KEYS=key1,key2,key3` 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 diff --git a/docs/polis/guides/service.mdx b/docs/polis/guides/service.mdx index 56f906e0f8..32bb3539bc 100644 --- a/docs/polis/guides/service.mdx +++ b/docs/polis/guides/service.mdx @@ -18,8 +18,8 @@ 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 \ @@ -27,7 +27,7 @@ docker run \ -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" \ @@ -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" \ From d42168f52e4b2bad7e7aae61cbc8d625ceb84cb3 Mon Sep 17 00:00:00 2001 From: Deepak Prabhakara Date: Fri, 17 Apr 2026 08:43:52 +0100 Subject: [PATCH 2/2] tweak --- docs/polis/deploy/env-variables.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/polis/deploy/env-variables.mdx b/docs/polis/deploy/env-variables.mdx index 2627165f9e..495a2b4ffb 100644 --- a/docs/polis/deploy/env-variables.mdx +++ b/docs/polis/deploy/env-variables.mdx @@ -45,7 +45,7 @@ NPM library option: `acsUrl` ### 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 `API_KEYS=key1,key2,key3`