From 1eb706de7ab14acf9cf0e8e0eb343b7ea9199050 Mon Sep 17 00:00:00 2001 From: CalciumIon <1808837298@qq.com> Date: Mon, 30 Dec 2024 20:56:54 +0800 Subject: [PATCH] docs: update README --- README.en.md | 5 +++++ README.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.en.md b/README.en.md index dac89af07..1ebea4e5f 100644 --- a/README.en.md +++ b/README.en.md @@ -83,6 +83,7 @@ You can add custom models gpt-4-gizmo-* in channels. These are third-party model - `COHERE_SAFETY_SETTING`: Cohere model [safety settings](https://docs.cohere.com/docs/safety-modes#overview), options: `NONE`, `CONTEXTUAL`, `STRICT`, default `NONE` - `GEMINI_VISION_MAX_IMAGE_NUM`: Gemini model maximum image number, default `16`, set to `-1` to disable - `MAX_FILE_DOWNLOAD_MB`: Maximum file download size in MB, default `20` +- `CRYPTO_SECRET`: Encryption key for encrypting database content ## Deployment > [!TIP] @@ -93,6 +94,10 @@ You can add custom models gpt-4-gizmo-* in channels. These are third-party model > docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR > ``` +### Multi-Server Deployment +- Must set `SESSION_SECRET` environment variable, otherwise login state will not be consistent across multiple servers. +- If using a public Redis, must set `CRYPTO_SECRET` environment variable, otherwise Redis content will not be able to be obtained in multi-server deployment. + ### Requirements - Local database (default): SQLite (Docker deployment must mount `/data` directory) - Remote database: MySQL >= 5.7.8, PgSQL >= 9.6 diff --git a/README.md b/README.md index 704921a5d..da65b1bbc 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ ### 多机部署 - 必须设置环境变量 `SESSION_SECRET`,否则会导致多机部署时登录状态不一致。 -- 如果公用Redis,必须设置 `CRYPTO_SECRET`,否则会导致多机部署时Redis内容无法解密。 +- 如果公用Redis,必须设置 `CRYPTO_SECRET`,否则会导致多机部署时Redis内容无法获取。 ### 部署要求 - 本地数据库(默认):SQLite(Docker 部署默认使用 SQLite,必须挂载 `/data` 目录到宿主机)