From e6a4d6bcf005e465e6f23c5259d4be8b68382dc5 Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Thu, 24 Apr 2025 18:02:32 +0800 Subject: [PATCH] DocsHow to disable user registration (#7265) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docker/.env | 10 ++++++---- docs/configurations.md | 6 ++++++ docs/release_notes.md | 3 ++- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docker/.env b/docker/.env index b6eeb0bff..c1cdb50a7 100644 --- a/docker/.env +++ b/docker/.env @@ -132,13 +132,13 @@ TIMEZONE='Asia/Shanghai' # Note that neither `MAX_CONTENT_LENGTH` nor `client_max_body_size` sets the maximum size for files uploaded to an agent. # See https://ragflow.io/docs/dev/begin_component for details. -# The log level for the RAGFlow's owned packages and imported packages. -# Available level: +# Log level for the RAGFlow's own and imported packages. +# Available levels: # - `DEBUG` # - `INFO` (default) # - `WARNING` # - `ERROR` -# For example, following line changes the log level of `ragflow.es_conn` to `DEBUG`: +# For example, the following line changes the log level of `ragflow.es_conn` to `DEBUG`: # LOG_LEVELS=ragflow.es_conn=DEBUG # aliyun OSS configuration @@ -149,5 +149,7 @@ TIMEZONE='Asia/Shanghai' # REGION=cn-hangzhou # BUCKET=ragflow65536 -# user registration switch +# A user registration switch: +# - Enable registration: 1 +# - Disable registration: 0 REGISTER_ENABLED=1 diff --git a/docs/configurations.md b/docs/configurations.md index 9d05875d9..2362a1062 100644 --- a/docs/configurations.md +++ b/docs/configurations.md @@ -132,6 +132,12 @@ If you cannot download the RAGFlow Docker image, try the following mirrors. - `MACOS` Optimizations for macOS. It is disabled by default. You can uncomment this line if your OS is macOS. +### User registration + +- `REGISTER_ENABLED` + - `1`: (Default) Enable user registration. + - `0`: Disable user registration. + ## Service configuration [service_conf.yaml.template](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml.template) specifies the system-level configuration for RAGFlow and is used by its API server and task executor. diff --git a/docs/release_notes.md b/docs/release_notes.md index 3d16523bc..dd1918877 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -18,7 +18,7 @@ Released on April 23, 2025. - Agent version control: all updates are continuously logged and can be rolled back to a previous version via export. - Team collaboration: Agents can be shared with team members. - OpenAI-compatible APIs: Agents can be called via OpenAI-compatible APIs. -- User registration control: administrators can enable or disable user registration through an environment variable. +- User registration control: administrators can enable or disable user registration through an environment variable. See `REGISTER_ENABLED` in **/docker/.env**. ### Improvements @@ -31,6 +31,7 @@ Released on April 23, 2025. - [Set page rank](./guides/dataset/set_page_rank.md) - [Enable RAPTOR](./guides/dataset/enable_raptor.md) +- [Set variables for your chat assistant](./guides/chat/set_chat_variables.md) - [RAGFlow MCP server overview](./develop/mcp.md) ## v0.17.2