HedgeDoc终极配置指南：环境变量与配置文件深度解析
项目地址: https://gitcode.com/gh_mirrors/he/hedgedoc HedgeDoc是一款强大的开源协作笔记平台，让团队能够更好地共同成长想法。要充分发挥HedgeDoc的全部潜力，掌握其配置系统至关重要。本文将深入解析HedgeDoc的环境变量和配置文件，帮助您快速搭建个性化的协作环境。
🔧 核心配置环境变量
HedgeDoc支持多种环境变量配置，让您轻松定制实例的各个方面。
基础配置变量
- HD_BASE_URL：设置HedgeDoc实例的访问URL
- HD_BACKEND_PORT：后端服务监听端口，默认为3000
- HD_FRONTEND_PORT：前端服务监听端口，默认为3001
- HD_LOGLEVEL：日志级别，支持error、warn、info、debug、trace
数据库配置
支持SQLite、PostgreSQL和MariaDB三种数据库：
- HD_DATABASE_TYPE：指定数据库类型（postgres、mariadb或sqlite）
- HD_DATABASE_NAME：数据库名称，使用SQLite时为数据库文件路径
- HD_DATABASE_HOST：数据库主机地址（SQLite不需要）
- HD_DATABASE_PORT：数据库端口（SQLite不需要）
🎨 个性化定制选项
HedgeDoc提供了丰富的个性化配置，让您的实例与众不同。
品牌定制
- HD_CUSTOM_NAME：设置组织名称，显示在编辑器右上角和介绍页面
- HD_CUSTOM_LOGO：自定义Logo图片URL
- HD_PRIVACY_URL：隐私政策链接
- HD_TERMS_OF_USE_URL：服务条款链接
- HD_IMPRINT_URL：法律声明链接
⚙️ 配置文件详解
除了环境变量，HedgeDoc还支持通过配置文件进行设置，相关配置模块位于：
backend/src/config/app.config.ts - 应用基础配置 backend/src/config/database.config.ts - 数据库连接配置 backend/src/config/customization.config.ts - 个性化定制配置
🚀 快速部署技巧
Docker部署配置
使用Docker Compose可以快速搭建完整的HedgeDoc环境，包含数据库和后端服务。
反向代理设置
配置Nginx或Caddy作为反向代理，实现SSL加密和域名绑定。
💡 最佳实践建议
- 生产环境：推荐使用PostgreSQL或MariaDB
- 开发环境：SQLite足够满足需求
- 安全配置：务必设置强密码和启用HTTPS
- 备份策略：定期备份数据库和上传文件
🔍 故障排除指南
遇到配置问题时，可以：
- 检查环境变量拼写是否正确
- 验证数据库连接信息
- 查看日志文件获取详细错误信息
通过掌握这些配置技巧，您将能够打造一个完全符合团队需求的HedgeDoc协作平台，让创意在更好的环境中茁壮成长！ 🌱
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
