ruiling/tachybase_todo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(plugin-api-keys): add warning for API_KEY env (#2847)

Browse Source
This commit is contained in:
Dunqing 2023-10-16 18:58:45 -05:00 committed by GitHub
parent 73b168ac25
commit 0c99c81c93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/plugins/@nocobase/plugin-api-keys/docs/en-US/usage.md
View File

@ -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.

2
packages/plugins/@nocobase/plugin-api-keys/docs/zh-CN/usage.md
View File

@ -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 将无法继续使用。