Zulip 服务器配置权威指南从 /etc/zulip/settings.py 到生产环境调优【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip/etc/zulip/settings.py是 Zulip 服务器的主配置文件系统管理员通过它控制主机名、认证、邮件网关、文件存储、视频通话、用户引导与法律政策页面等一百多项服务器级设置。本文以 Zulip 官方生产配置文档为骨架结合仓库内配置模板zproject/prod_settings_template.py与核心源码实现系统讲解每一类关键配置的语义、修改方式与生效机制帮助你快速掌握自托管 Zulip 的配置方法并完成个性化的生产部署调优。认识 /etc/zulip/settings.pyZulip 服务器配置的核心Zulip 将影响整个服务器的配置集中放在/etc/zulip/settings.py一个文件中。该文件由安装器在部署时基于仓库内的 prod_settings_template.py 模板生成模板中为超过一百项设置都写好了分类清晰的组织化注释Zulip 官方称其为自我文档化self-documents的配置文件管理员可以直接按注释阅读每一项的含义、默认值与用法。打开模板可以看到它按功能将配置划分为多个区块每个区块顶部都有一段说明注释包括Mandatory settings必需设置EXTERNAL_HOST、ZULIP_ADMINISTRATOR等生产环境必须配置Outgoing email (SMTP) settings出站邮件相关Email gateway integration邮件网关发邮件进 ZulipAuthentication settings认证后端与 LDAP、OAuth、SAML、OIDC 等集成Service configurationPostgreSQL、RabbitMQ、Redis、Memcached 等外部服务连接Previews / Logging / Video calls / AI Features / Miscellaneous等杂项设置。模板头部还明确提示修改后必须重启服务器才能生效并给出了重启命令这与官方文档 Server configuration 的描述完全一致。必需设置EXTERNAL_HOST 与 ZULIP_ADMINISTRATOREXTERNAL_HOST与ZULIP_ADMINISTRATOR是安装器会预填的两个强制设置模板中的默认值如下ZULIP_ADMINISTRATOR zulip-adminexample.com EXTERNAL_HOST zulip.example.comZULIP_ADMINISTRATOR维护该 Zulip 安装的人员或团队的公开邮箱。模板注释明确说明它是面向公众的地址——可能出现在 404 页面上、作为许多自动邮件的发件人、并被宣传为支持地址。因此建议使用supportexample.com或adminexample.com这类地址且不要携带显示名例如只能写supportexample.com不能写Zulip Support supportexample.com。EXTERNAL_HOST用户访问 Zulip 的对外主机名应与用户在浏览器中输入的地址一致。如果需要通过特定端口访问可以直接把端口写进这里例如EXTERNAL_HOST zulip.example.com:1234。ALLOWED_HOSTS 与 FAKE_EMAIL_DOMAIN模板中紧跟着两个与EXTERNAL_HOST配合的安全相关设置# ALLOWED_HOSTS [zulip-alias.example.com, 192.0.2.1] # FAKE_EMAIL_DOMAIN fake-domain.example.comALLOWED_HOSTS允许用户通过浏览器访问的额外主机名列表逗号分隔。这是安全措施对应 Django 的ALLOWED_HOSTS校验。Zulip 会自动把localhost、127.0.0.1、EXTERNAL_HOST及其子域模式加入该列表只有用其他主机名访问时才需要手动补充。注意该列表只填主机名不要带端口号。FAKE_EMAIL_DOMAIN当EXTERNAL_HOST不是合法域名例如是 IP 地址时Zulip 生成机器人、虚拟用户等的伪造邮箱地址所使用的域名。从源码结构看这些设置会进一步被 zproject/computed_settings.py 等模块消费最终进入 Django 的全局配置对象模板中的 default_settings.py 则为每个设置提供了开发环境的默认值生产模板中注释掉的行即代表沿用默认值。修改设置的正确姿势编辑、保存、重启修改settings.py中任意一项的流程非常简单在服务器上编辑并保存文件然后重启服务器su zulip -c /home/zulip/deployments/current/scripts/restart-server该命令以zulip用户身份调用部署目录下的 scripts/restart-server 脚本。模板文件头部也以注释形式内嵌了同一命令作为提醒Remember to restart the server after making changes here!说明改配置必须重启是 Zulip 的强制约束。此外模板在RATE_LIMITING_RULES的注释中提供了一个很有用的排查命令可以用来读取任意设置当前生效的值/home/zulip/deployments/current/scripts/get-django-setting RATE_LIMITING_RULESget-django-setting脚本见 scripts/get-django-setting会打印指定 Django 设置的实际值适合在调整限流、会话等参数后核对是否生效。关于 Docker 部署的特别说明官方文档特别强调如果使用 Docker 部署参见 Docker 部署文档通过SETTING_*环境变量来配置settings.py或直接编辑容器内的配置文件两种方式二选一。常用服务器级设置速览settings.py中值得关注的设置按主题可分为以下几类每一项都可在模板中找到带详细注释的原文认证方法AuthenticationAUTHENTICATION_BACKENDS元组决定启用哪些登录方式。默认只启用邮箱密码认证AUTHENTICATION_BACKENDS: tuple[str, ...] ( zproject.backends.EmailAuthBackend, # Email and password; just requires SMTP setup # zproject.backends.GoogleAuthBackend, # zproject.backends.GitHubAuthBackend, # zproject.backends.SAMLAuthBackend, # zproject.backends.ZulipLDAPAuthBackend, # zproject.backends.ZulipRemoteUserBackend, # zproject.backends.GenericOpenIdConnectBackend, # zproject.backends.DiscordAuthBackend, )安装过程要求EmailAuthBackend处于启用状态如要禁用需在创建初始 realm 与用户之后再操作。模板随后给出了 LDAP含AUTH_LDAP_USER_SEARCH、AUTH_LDAP_USER_ATTR_MAP、AUTH_LDAP_GROUP_TYPE等、Google/GitHub/GitLab/Discord OAuth、SAMLSOCIAL_AUTH_SAML_ENABLED_IDPS、SOCIAL_AUTH_SAML_ORG_INFO、OpenID ConnectSOCIAL_AUTH_OIDC_ENABLED_IDPS、Apple 登录、AzureAD、REMOTE_USERSSO、JWTJWT_AUTH_KEYS等一整套后端配置模板。各后端与 LDAP/SCIM 数据同步的详细说明见 authentication-methods.md。邮件网关Email gatewayEMAIL_GATEWAY_PATTERN等设置让用户可以通过向特定地址发邮件把内容送入 Zulip 会话EMAIL_GATEWAY_PATTERN EMAIL_GATEWAY_LOGIN EMAIL_GATEWAY_IMAP_SERVER EMAIL_GATEWAY_IMAP_PORT 993 EMAIL_GATEWAY_IMAP_FOLDER INBOX其中 IMAP 登录密码保存在/etc/zulip/zulip-secrets.conf的email_gateway_password中遵循 Zulip密码不进 settings.py、统一放 secrets 文件的惯例。完整说明见 email-gateway.md。视频与语音通话集成Video calls模板为多种通话服务提供了开关ZoomVIDEO_ZOOM_CLIENT_ID、VIDEO_ZOOM_SERVER_TO_SERVER_ACCOUNT_ID可自定义VIDEO_ZOOM_OAUTH_URL与VIDEO_ZOOM_API_URLWebexVIDEO_WEBEX_CLIENT_ID还需在 secrets 中配置video_webex_client_secretJitsi MeetJITSI_SERVER_URL默认使用 SaaS 服务https://meet.jit.si可指向自建服务器设为None可禁用BigBlueButton、Constructor Groups、Nextcloud Talk 等同样预留了配置项。详见 video-calls.md。上传文件存储后端Upload backends默认情况下用户上传的文件与头像直接存储在服务器本地LOCAL_UPLOADS_DIR /home/zulip/uploads # S3_AUTH_UPLOADS_BUCKET # S3_AVATAR_BUCKET # S3_REGION None # MAX_FILE_UPLOAD_SIZE 100如需改用 Amazon S3 或其他可扩展数据存储可配置S3_*系列设置MAX_FILE_UPLOAD_SIZE控制上传大小上限MB设为0将完全禁用上传并隐藏 UI 中的上传入口。官方建议若修改LOCAL_UPLOADS_DIR路径需同步修改 nginx 配置推荐用符号链接替换/home/zulip/uploads而非直接改路径。详见 upload-backends.md。定制用户引导导航视频NAVIGATION_TOUR_VIDEO_URL新用户注册后Zulip 会向其展示一段约 2 分钟的应用导览视频Welcome to Zulip video帮助新用户快速上手。服务器管理员可以通过NAVIGATION_TOUR_VIDEO_URL完全定制这段体验在/etc/zulip/settings.py中修改该设置可把官方视频托管到你的网络内或提供一段介绍你的组织如何使用 Zulip的自定义视频设为None可彻底禁用导航视频体验。模板中的默认形态为# NAVIGATION_TOUR_VIDEO_URL https://static.zulipchat.com/static/navigation-tour-video/zulip-10.mp4源码视角该设置如何驱动 onboarding 流程从源码可以清楚看到该设置贯穿整个新用户引导子系统zerver/lib/onboarding_steps.py 中navigation_tour_video 是ONE_TIME_NOTICES列表里的一项第 64 行。get_next_onboarding_steps()会为每个用户计算尚未完成的上线引导步骤当settings.NAVIGATION_TOUR_VIDEO_URL is None时直接将该步骤视为已看过第 85-87 行从而实现禁用效果。zerver/lib/onboarding.py 中欢迎机器人发送的私信会拼接视频链接You can always come back to the Welcome to Zulip video for a quick app overview.。zerver/views/onboarding_steps.py 处理稍后观看的提醒私信同样把该 URL 嵌入消息文本。zerver/lib/events.py 把navigation_tour_video_url放进初始状态供前端渲染引导 UI。zerver/tests/test_onboarding_steps.py 用NAVIGATION_TOUR_VIDEO_URLNone验证了管理员禁用后不再下发该引导步骤的行为。默认值定义在 zproject/default_settings.py类型为str | None恰好对应自定义 URL与禁用两种形态。自定义服务条款与隐私政策Zulip 允许服务器管理员配置自己的Terms of Service服务条款与Privacy Policy隐私政策页面整个体系由两个设置驱动POLICIES_DIRECTORY政策文档存放目录TERMS_OF_SERVICE_VERSION服务条款版本号启用该功能的开关。官方建议使用/etc/zulip/policies作为目录这样政策文件会随服务器其他配置一起被自然备份。启用步骤在/etc/zulip/policies目录中放置 Markdown 文件terms.md与privacy.md在settings.py中设置TERMS_OF_SERVICE_VERSION为1.0以启用该功能。对应的模板配置为# TERMS_OF_SERVICE_VERSION 1.0 # POLICIES_DIRECTORY /etc/zulip/policies/默认值见 zproject/default_settings.pyPOLICIES_DIRECTORY默认为zerver/policies_absent一个不存在的占位目录相当于未启用TERMS_OF_SERVICE_VERSION默认为None。开发环境 zproject/dev_settings.py 则设为corporate/policies与1.0便于本地验证。政策站点导航与 404 页面你可以在同一目录放置更多 Markdown 文件以记录其他政策此时推荐补充两个可选文件sidebar_index.md列出政策站点的所有页面用于生成政策站点导航missing.md自定义该目录下 404 页面显示的内容。从源码看zerver/views/documentation.py 在运行期动态拼接模板路径f{settings.POLICIES_DIRECTORY}/%s.md第 321 行并在get()中解析sidebar_index.md生成侧边导航第 280-308 行因此管理员在目录里增删文件无需重启即可生效注释中明确提到延迟到运行期读取便于测试。版本机制条款更新时如何重新获取用户同意TERMS_OF_SERVICE_VERSION不只是开关还是版本控制工具zerver/views/home.py 中登录时比较TERMS_OF_SERVICE_VERSION与用户已接受的tos_version主版本号若服务器版本的主版本号更大则要求用户重新确认条款确认后调用do_change_tos_version更新记录。注册流程中zerver/views/registration.py 与 zerver/actions/create_user.py 会把当前TERMS_OF_SERVICE_VERSION写入新用户。上下文处理器 zerver/context_processors.py 根据是否设置该值决定是否在前端展示条款入口zerver/views/home.py 还会把当前版本号传给页面模板用于显示条款已更新的提示文案。也就是说管理员只需修改TERMS_OF_SERVICE_VERSION例如从1.0升到2.0并重启即可强制所有用户重新确认新条款——这正是该设计在合规场景下的核心价值。测试中的行为验证zerver/tests/test_docs.py 的PrivacyTermsTest对整套政策页面做了覆盖未配置时zerver/policies_absent访问/policies/terms与/policies/privacy返回占位文案 This server is an installation配置了最小政策目录zerver/policies_minimal后页面渲染出 These are the custom terms and conditions. 与 This is the custom privacy policy.使用生产推荐的绝对路径如/etc/zulip/policies/同样可以正常渲染/terms/、/privacy/等旧 URL 会 301 重定向到新的/policies/命名空间?navno参数可去掉政策页面上的全站导航用于满足苹果 App Store 对 iOS 应用内条款页面的链接要求。附settings.py 与 zulip.conf 的分工官方文档特别提醒读者区分两层配置/etc/zulip/settings.py管的是应用层的 Zulip 服务器行为本页全部内容而系统与部署级配置如 nginx、postgresql、redis 等组成完整 Zulip 安装的各个服务的参数位于/etc/zulip/zulip.conf详见 system-configuration.md。另外Zulip 组织管理员还可以通过 Web 端或桌面端在组织设置里配置大量与具体组织相关的选项如消息预览开关INLINE_IMAGE_PREVIEW等这类realm 级设置与本文的服务器级设置相互补充。最后提醒settings.py中的密码与密钥一律不写入该文件而是放在/etc/zulip/zulip-secrets.conf中如email_password、social_auth_google_secret、postgres_password等模板代码通过get_secret()从 secrets 文件读取——这是 Zulip 配置体系的一项硬性安全约定务必遵守。【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
Zulip 服务器配置权威指南：从 /etc/zulip/settings.py 到生产环境调优
Zulip 服务器配置权威指南从 /etc/zulip/settings.py 到生产环境调优【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip/etc/zulip/settings.py是 Zulip 服务器的主配置文件系统管理员通过它控制主机名、认证、邮件网关、文件存储、视频通话、用户引导与法律政策页面等一百多项服务器级设置。本文以 Zulip 官方生产配置文档为骨架结合仓库内配置模板zproject/prod_settings_template.py与核心源码实现系统讲解每一类关键配置的语义、修改方式与生效机制帮助你快速掌握自托管 Zulip 的配置方法并完成个性化的生产部署调优。认识 /etc/zulip/settings.pyZulip 服务器配置的核心Zulip 将影响整个服务器的配置集中放在/etc/zulip/settings.py一个文件中。该文件由安装器在部署时基于仓库内的 prod_settings_template.py 模板生成模板中为超过一百项设置都写好了分类清晰的组织化注释Zulip 官方称其为自我文档化self-documents的配置文件管理员可以直接按注释阅读每一项的含义、默认值与用法。打开模板可以看到它按功能将配置划分为多个区块每个区块顶部都有一段说明注释包括Mandatory settings必需设置EXTERNAL_HOST、ZULIP_ADMINISTRATOR等生产环境必须配置Outgoing email (SMTP) settings出站邮件相关Email gateway integration邮件网关发邮件进 ZulipAuthentication settings认证后端与 LDAP、OAuth、SAML、OIDC 等集成Service configurationPostgreSQL、RabbitMQ、Redis、Memcached 等外部服务连接Previews / Logging / Video calls / AI Features / Miscellaneous等杂项设置。模板头部还明确提示修改后必须重启服务器才能生效并给出了重启命令这与官方文档 Server configuration 的描述完全一致。必需设置EXTERNAL_HOST 与 ZULIP_ADMINISTRATOREXTERNAL_HOST与ZULIP_ADMINISTRATOR是安装器会预填的两个强制设置模板中的默认值如下ZULIP_ADMINISTRATOR zulip-adminexample.com EXTERNAL_HOST zulip.example.comZULIP_ADMINISTRATOR维护该 Zulip 安装的人员或团队的公开邮箱。模板注释明确说明它是面向公众的地址——可能出现在 404 页面上、作为许多自动邮件的发件人、并被宣传为支持地址。因此建议使用supportexample.com或adminexample.com这类地址且不要携带显示名例如只能写supportexample.com不能写Zulip Support supportexample.com。EXTERNAL_HOST用户访问 Zulip 的对外主机名应与用户在浏览器中输入的地址一致。如果需要通过特定端口访问可以直接把端口写进这里例如EXTERNAL_HOST zulip.example.com:1234。ALLOWED_HOSTS 与 FAKE_EMAIL_DOMAIN模板中紧跟着两个与EXTERNAL_HOST配合的安全相关设置# ALLOWED_HOSTS [zulip-alias.example.com, 192.0.2.1] # FAKE_EMAIL_DOMAIN fake-domain.example.comALLOWED_HOSTS允许用户通过浏览器访问的额外主机名列表逗号分隔。这是安全措施对应 Django 的ALLOWED_HOSTS校验。Zulip 会自动把localhost、127.0.0.1、EXTERNAL_HOST及其子域模式加入该列表只有用其他主机名访问时才需要手动补充。注意该列表只填主机名不要带端口号。FAKE_EMAIL_DOMAIN当EXTERNAL_HOST不是合法域名例如是 IP 地址时Zulip 生成机器人、虚拟用户等的伪造邮箱地址所使用的域名。从源码结构看这些设置会进一步被 zproject/computed_settings.py 等模块消费最终进入 Django 的全局配置对象模板中的 default_settings.py 则为每个设置提供了开发环境的默认值生产模板中注释掉的行即代表沿用默认值。修改设置的正确姿势编辑、保存、重启修改settings.py中任意一项的流程非常简单在服务器上编辑并保存文件然后重启服务器su zulip -c /home/zulip/deployments/current/scripts/restart-server该命令以zulip用户身份调用部署目录下的 scripts/restart-server 脚本。模板文件头部也以注释形式内嵌了同一命令作为提醒Remember to restart the server after making changes here!说明改配置必须重启是 Zulip 的强制约束。此外模板在RATE_LIMITING_RULES的注释中提供了一个很有用的排查命令可以用来读取任意设置当前生效的值/home/zulip/deployments/current/scripts/get-django-setting RATE_LIMITING_RULESget-django-setting脚本见 scripts/get-django-setting会打印指定 Django 设置的实际值适合在调整限流、会话等参数后核对是否生效。关于 Docker 部署的特别说明官方文档特别强调如果使用 Docker 部署参见 Docker 部署文档通过SETTING_*环境变量来配置settings.py或直接编辑容器内的配置文件两种方式二选一。常用服务器级设置速览settings.py中值得关注的设置按主题可分为以下几类每一项都可在模板中找到带详细注释的原文认证方法AuthenticationAUTHENTICATION_BACKENDS元组决定启用哪些登录方式。默认只启用邮箱密码认证AUTHENTICATION_BACKENDS: tuple[str, ...] ( zproject.backends.EmailAuthBackend, # Email and password; just requires SMTP setup # zproject.backends.GoogleAuthBackend, # zproject.backends.GitHubAuthBackend, # zproject.backends.SAMLAuthBackend, # zproject.backends.ZulipLDAPAuthBackend, # zproject.backends.ZulipRemoteUserBackend, # zproject.backends.GenericOpenIdConnectBackend, # zproject.backends.DiscordAuthBackend, )安装过程要求EmailAuthBackend处于启用状态如要禁用需在创建初始 realm 与用户之后再操作。模板随后给出了 LDAP含AUTH_LDAP_USER_SEARCH、AUTH_LDAP_USER_ATTR_MAP、AUTH_LDAP_GROUP_TYPE等、Google/GitHub/GitLab/Discord OAuth、SAMLSOCIAL_AUTH_SAML_ENABLED_IDPS、SOCIAL_AUTH_SAML_ORG_INFO、OpenID ConnectSOCIAL_AUTH_OIDC_ENABLED_IDPS、Apple 登录、AzureAD、REMOTE_USERSSO、JWTJWT_AUTH_KEYS等一整套后端配置模板。各后端与 LDAP/SCIM 数据同步的详细说明见 authentication-methods.md。邮件网关Email gatewayEMAIL_GATEWAY_PATTERN等设置让用户可以通过向特定地址发邮件把内容送入 Zulip 会话EMAIL_GATEWAY_PATTERN EMAIL_GATEWAY_LOGIN EMAIL_GATEWAY_IMAP_SERVER EMAIL_GATEWAY_IMAP_PORT 993 EMAIL_GATEWAY_IMAP_FOLDER INBOX其中 IMAP 登录密码保存在/etc/zulip/zulip-secrets.conf的email_gateway_password中遵循 Zulip密码不进 settings.py、统一放 secrets 文件的惯例。完整说明见 email-gateway.md。视频与语音通话集成Video calls模板为多种通话服务提供了开关ZoomVIDEO_ZOOM_CLIENT_ID、VIDEO_ZOOM_SERVER_TO_SERVER_ACCOUNT_ID可自定义VIDEO_ZOOM_OAUTH_URL与VIDEO_ZOOM_API_URLWebexVIDEO_WEBEX_CLIENT_ID还需在 secrets 中配置video_webex_client_secretJitsi MeetJITSI_SERVER_URL默认使用 SaaS 服务https://meet.jit.si可指向自建服务器设为None可禁用BigBlueButton、Constructor Groups、Nextcloud Talk 等同样预留了配置项。详见 video-calls.md。上传文件存储后端Upload backends默认情况下用户上传的文件与头像直接存储在服务器本地LOCAL_UPLOADS_DIR /home/zulip/uploads # S3_AUTH_UPLOADS_BUCKET # S3_AVATAR_BUCKET # S3_REGION None # MAX_FILE_UPLOAD_SIZE 100如需改用 Amazon S3 或其他可扩展数据存储可配置S3_*系列设置MAX_FILE_UPLOAD_SIZE控制上传大小上限MB设为0将完全禁用上传并隐藏 UI 中的上传入口。官方建议若修改LOCAL_UPLOADS_DIR路径需同步修改 nginx 配置推荐用符号链接替换/home/zulip/uploads而非直接改路径。详见 upload-backends.md。定制用户引导导航视频NAVIGATION_TOUR_VIDEO_URL新用户注册后Zulip 会向其展示一段约 2 分钟的应用导览视频Welcome to Zulip video帮助新用户快速上手。服务器管理员可以通过NAVIGATION_TOUR_VIDEO_URL完全定制这段体验在/etc/zulip/settings.py中修改该设置可把官方视频托管到你的网络内或提供一段介绍你的组织如何使用 Zulip的自定义视频设为None可彻底禁用导航视频体验。模板中的默认形态为# NAVIGATION_TOUR_VIDEO_URL https://static.zulipchat.com/static/navigation-tour-video/zulip-10.mp4源码视角该设置如何驱动 onboarding 流程从源码可以清楚看到该设置贯穿整个新用户引导子系统zerver/lib/onboarding_steps.py 中navigation_tour_video 是ONE_TIME_NOTICES列表里的一项第 64 行。get_next_onboarding_steps()会为每个用户计算尚未完成的上线引导步骤当settings.NAVIGATION_TOUR_VIDEO_URL is None时直接将该步骤视为已看过第 85-87 行从而实现禁用效果。zerver/lib/onboarding.py 中欢迎机器人发送的私信会拼接视频链接You can always come back to the Welcome to Zulip video for a quick app overview.。zerver/views/onboarding_steps.py 处理稍后观看的提醒私信同样把该 URL 嵌入消息文本。zerver/lib/events.py 把navigation_tour_video_url放进初始状态供前端渲染引导 UI。zerver/tests/test_onboarding_steps.py 用NAVIGATION_TOUR_VIDEO_URLNone验证了管理员禁用后不再下发该引导步骤的行为。默认值定义在 zproject/default_settings.py类型为str | None恰好对应自定义 URL与禁用两种形态。自定义服务条款与隐私政策Zulip 允许服务器管理员配置自己的Terms of Service服务条款与Privacy Policy隐私政策页面整个体系由两个设置驱动POLICIES_DIRECTORY政策文档存放目录TERMS_OF_SERVICE_VERSION服务条款版本号启用该功能的开关。官方建议使用/etc/zulip/policies作为目录这样政策文件会随服务器其他配置一起被自然备份。启用步骤在/etc/zulip/policies目录中放置 Markdown 文件terms.md与privacy.md在settings.py中设置TERMS_OF_SERVICE_VERSION为1.0以启用该功能。对应的模板配置为# TERMS_OF_SERVICE_VERSION 1.0 # POLICIES_DIRECTORY /etc/zulip/policies/默认值见 zproject/default_settings.pyPOLICIES_DIRECTORY默认为zerver/policies_absent一个不存在的占位目录相当于未启用TERMS_OF_SERVICE_VERSION默认为None。开发环境 zproject/dev_settings.py 则设为corporate/policies与1.0便于本地验证。政策站点导航与 404 页面你可以在同一目录放置更多 Markdown 文件以记录其他政策此时推荐补充两个可选文件sidebar_index.md列出政策站点的所有页面用于生成政策站点导航missing.md自定义该目录下 404 页面显示的内容。从源码看zerver/views/documentation.py 在运行期动态拼接模板路径f{settings.POLICIES_DIRECTORY}/%s.md第 321 行并在get()中解析sidebar_index.md生成侧边导航第 280-308 行因此管理员在目录里增删文件无需重启即可生效注释中明确提到延迟到运行期读取便于测试。版本机制条款更新时如何重新获取用户同意TERMS_OF_SERVICE_VERSION不只是开关还是版本控制工具zerver/views/home.py 中登录时比较TERMS_OF_SERVICE_VERSION与用户已接受的tos_version主版本号若服务器版本的主版本号更大则要求用户重新确认条款确认后调用do_change_tos_version更新记录。注册流程中zerver/views/registration.py 与 zerver/actions/create_user.py 会把当前TERMS_OF_SERVICE_VERSION写入新用户。上下文处理器 zerver/context_processors.py 根据是否设置该值决定是否在前端展示条款入口zerver/views/home.py 还会把当前版本号传给页面模板用于显示条款已更新的提示文案。也就是说管理员只需修改TERMS_OF_SERVICE_VERSION例如从1.0升到2.0并重启即可强制所有用户重新确认新条款——这正是该设计在合规场景下的核心价值。测试中的行为验证zerver/tests/test_docs.py 的PrivacyTermsTest对整套政策页面做了覆盖未配置时zerver/policies_absent访问/policies/terms与/policies/privacy返回占位文案 This server is an installation配置了最小政策目录zerver/policies_minimal后页面渲染出 These are the custom terms and conditions. 与 This is the custom privacy policy.使用生产推荐的绝对路径如/etc/zulip/policies/同样可以正常渲染/terms/、/privacy/等旧 URL 会 301 重定向到新的/policies/命名空间?navno参数可去掉政策页面上的全站导航用于满足苹果 App Store 对 iOS 应用内条款页面的链接要求。附settings.py 与 zulip.conf 的分工官方文档特别提醒读者区分两层配置/etc/zulip/settings.py管的是应用层的 Zulip 服务器行为本页全部内容而系统与部署级配置如 nginx、postgresql、redis 等组成完整 Zulip 安装的各个服务的参数位于/etc/zulip/zulip.conf详见 system-configuration.md。另外Zulip 组织管理员还可以通过 Web 端或桌面端在组织设置里配置大量与具体组织相关的选项如消息预览开关INLINE_IMAGE_PREVIEW等这类realm 级设置与本文的服务器级设置相互补充。最后提醒settings.py中的密码与密钥一律不写入该文件而是放在/etc/zulip/zulip-secrets.conf中如email_password、social_auth_google_secret、postgres_password等模板代码通过get_secret()从 secrets 文件读取——这是 Zulip 配置体系的一项硬性安全约定务必遵守。【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考