From 0c99c81c933390cfba272fe09d381e0dd2a60b63 Mon Sep 17 00:00:00 2001 From: Dunqing Date: Mon, 16 Oct 2023 18:58:45 -0500 Subject: [PATCH] docs(plugin-api-keys): add warning for API_KEY env (#2847) --- packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md | 2 ++ packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md b/packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md index cadf5a6f2..946013210 100644 --- a/packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md +++ b/packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md @@ -14,6 +14,8 @@ Here's an example using cURL: curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}' ``` +> Warning: When using the `Docker` image to use `NocoBase`, make sure you have configured the [APP_KEY](https://docs.nocobase.com/api/env#app_key) environment variable, otherwise the API key will be invalid after each restart. + ## Deleting an API key After deleting the API key, it will no longer be usable. diff --git a/packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md b/packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md index e2a592eba..8a4c540bb 100644 --- a/packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md +++ b/packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md @@ -14,6 +14,8 @@ cURL 的例子如下 curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}' ``` +> Warning: 当你使用 `Docker` 镜像来使用 `NocoBase` 时,请确保你配置了 [APP_KEY](https://docs-cn.nocobase.com/api/env#app_key) 环境变量,否则 API key 将在每次重启后失效。 + ## 删除 API key 删除 API key 后,该 Key 将无法继续使用。