在线文档协作和知识库工具 Docmost，支持多人同时编辑文档

Docmost 是一个开源的在线文档协作和知识库工具，特别适合团队用来写文档、分享知识、管理项目，支持多人同时编辑文档，支持评论，能像画画一样轻松插入各种流程图、表格啥的。

Docmost核心功能

实时协作编辑器：多人能实时在页面上共同工作。

图表工具：内置支持Draw.io、Excalidraw和Mermaid等绘图工具。

空间管理：按团队、项目或部门整理页面，提升协作效率。

公共分享：可将页面公开分享，任何人凭借链接都能查看。

权限管理：用简单易懂的权限设置轻松控制内容访问权限。

用户组：通过用户组为用户统一分配权限。

评论功能：在页面添加评论，促进交流和反馈。

页面历史：通过完整的版本历史记录追踪变更。

嵌套导航：能在侧边栏对页面进行嵌套和重新排序。

搜索功能：强大的搜索能力帮助快速找到所需信息。

文件附件：在页面附加文件，方便参考和分享。

导入导出：可轻松以Markdown和HTML格式导入导出页面，还支持Zip导入、Notion导入，企业版支持Confluence导入。

读写偏好模式：避免意外编辑。

国际化支持：支持10多种语言，如英语、中文、法语、德语等。

身份验证：支持邮箱密码登录，企业版支持SSO（SAML/OIDC）。

企业版特色功能

• SSO（SAML 2.0/OIDC）：可集成Microsoft Entra ID、Okta、OneLogin等。

• Confluence导入工具。

• 邮件支持。

• 审计日志（即将推出）。

Docmost 安装

目前推荐使用Docker安装，如果是开发者，可能会对开发指南感兴趣。

前置条件

安装前需在服务器上安装Docker，可根据操作系统查看Docker官方安装指南，若使用Ubuntu，可通过以下命令安装Docker：

# 添加Docker的官方GPG密钥：
sudo apt-get update -qqy
sudo apt-get install ca-certificates curl -qqy
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# 将存储库添加到Apt源：
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update -qqy
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin -qqy

安装步骤

1、设置Docker Compose文件

创建一个新的Docmost目录并下载Docker Compose文件，命令如下：

mkdir docmost
cd docmost
curl -O https://raw.githubusercontent.com/docmost/docmost/main/docker-compose.yml

在Linux系统中，可使用vim打开docker-compose.yml文件：vi docker-compose.yml 下载的docker-compose.yml文件包含带有默认环境变量的模板，其中APP_URL应为可访问docmost的域名，例如https://docmost.example.com。

2、替换默认配置

需要替换docker-compose.yml文件中的默认环境变量：

• APP_URL替换为所选域名，如https://example.com或https://docmost.example.com。

• APP_SECRET的值必须替换为长随机密钥（至少32个字符），可使用openssl rand -hex 32生成，若保留默认值，应用将无法启动。

• 将POSTGRES_PASSWORD环境变量中的STRONG_DB_PASSWORD替换为安全密码。

• 用所选的Postgres密码更新DATABASE_URL默认的STRONG_DB_PASSWORD值。

若要配置电子邮件或文件存储驱动，可查看配置文档，默认文件存储驱动为本地存储，若不使用S3存储则无需操作。

3、启动服务

确保处于包含docker-compose.yml文件的docmost目录中，运行以下命令启动服务：docker compose up -d

服务启动后，在Web浏览器中导航到http://localhost:3000或指向服务器的域名，验证安装是否成功。若设置正确，会看到Docmost设置页面，可在此设置工作区和账户。

4、创建工作区

填写工作区名称（如ACME Inc）、姓名、电子邮件（如[email protected]）和密码，然后点击“设置工作区”。设置成功后，将成为工作区所有者，可邀请其他用户加入。

反向代理/ WebSockets

使用反向代理时，需启用WebSockets，因为实时页面编辑器依赖WebSockets运行。若遇到问题，可在GitHub仓库创建问题或讨论。

升级

要升级到最新的Docmost版本，运行以下命令：

docker pull docmost/docmost:latest
docker compose up --force-recreate --build docmost -d

实用的Docker命令

• 停止服务：docker compose down

• 重启服务：docker compose restart

配置相关

电子邮件

要发送电子邮件，需配置电子邮件驱动，这是邀请新用户加入工作区的必要操作。Docmost支持SMTP和Postmark电子邮件驱动。

• 使用SMTP：

MAIL_DRIVER=smtp
SMTP_HOST=
SMTP_PORT=
SMTP_USERNAME=
SMTP_PASSWORD=
SMTP_SECURE=
[email protected]
MAIL_FROM_NAME=Docmost

• 使用Postmark：

MAIL_DRIVER=postmark
POSTMARK_TOKEN=
[email protected]
MAIL_FROM_NAME=Docmost

文件存储

Docmost支持本地存储和S3兼容存储驱动，默认驱动为本地存储。

使用S3兼容存储时，需添加以下环境变量：

STORAGE_DRIVER=s3
AWS_S3_ACCESS_KEY_ID=
AWS_S3_SECRET_ACCESS_KEY=
AWS_S3_REGION=
AWS_S3_BUCKET=
AWS_S3_ENDPOINT=
AWS_S3_FORCE_PATH_STYLE=

S3兼容意味着Docmost可与AWS S3、Backblaze、Wasabi、DigitalOcean Spaces、Minio等其他S3兼容提供商配合使用。

文件上传和导入大小限制

• 编辑器上可上传的最大文件大小：FILE_UPLOAD_SIZE_LIMIT=100mb

• 导入文件的最大大小限制：FILE_IMPORT_SIZE_LIMIT=200mb

遥测

系统会匿名收集活跃版本、用户数量、页面数量、空间和工作区数量。要禁用遥测，设置DISABLE_TELEMETRY=true。

可参考环境变量查看所有可用的环境变量。

环境变量

环境变量用于配置应用程序，控制应用程序行为的各个方面，包括URL、数据库连接和第三方集成。

应用程序配置

变量	示例	描述
`APP_URL`	`https://docmost.example.com`	应用程序的基本URL。可选，但对正确生成电子邮件链接有用。
`APP_SECRET`	`LONG_SECRET_KEY`	用于应用程序安全的安全密钥（至少32个字符）。可使用`openssl rand -hex 32`生成。
`PORT`	`3000`	应用程序运行的端口。
`JWT_TOKEN_EXPIRES_IN`	`30d`	JSON Web令牌（JWT）的过期时间，默认是30天。

数据库配置

变量	示例	描述
`DATABASE_URL`	`postgresql://postgres:password@localhost:5432/docmost?schema=public`	PostgreSQL数据库的连接URL。

Redis配置

变量	示例	描述
`REDIS_URL`	`redis://127.0.0.1:6379`	Redis服务器的连接URL，格式为redis://username:password@host:port/db-number。

存储配置

• 使用本地存储

变量	示例	描述
`STORAGE_DRIVER`	`local`	用于文件存储的存储驱动。

• 使用S3兼容存储

变量	示例	描述
`STORAGE_DRIVER`	`s3`	用于文件存储的存储驱动。
`AWS_S3_ACCESS_KEY_ID`		AWS S3访问密钥ID。
`AWS_S3_SECRET_ACCESS_KEY`		AWS S3秘密访问密钥。
`AWS_S3_REGION`		S3存储桶所在的区域。
`AWS_S3_BUCKET`		S3存储桶的名称。
`AWS_S3_ENDPOINT`		S3服务的端点URL（可选）。
`AWS_S3_FORCE_PATH_STYLE`	`true`	强制请求使用路径样式寻址（可选）。

存储文件上传限制

变量	示例	描述
`FILE_UPLOAD_SIZE_LIMIT`	`50mb`	每次上传的最大文件大小，默认是50mb。
`FILE_IMPORT_SIZE_LIMIT`	`100mb`	最大文件导入大小限制，默认是200mb。

电子邮件配置

• 使用SMTP

变量	示例	描述
`MAIL_DRIVER`	`smtp`	用于发送电子邮件的邮件驱动。
`SMTP_HOST`	`smtp.example.com`	用于发送电子邮件的SMTP服务器。
`SMTP_PORT`	`587`	SMTP服务器使用的端口。
`SMTP_USERNAME`		SMTP服务器的用户名。
`SMTP_PASSWORD`		SMTP服务器的密码。
`SMTP_SECURE`	`false`	连接服务器时使用TLS，通常用于465端口，默认为false。
`MAIL_FROM_ADDRESS`	`[email protected]`	发送电子邮件的邮箱地址。
`MAIL_FROM_NAME`	`Docmost`	发送电子邮件的名称。

• 使用Postmark

变量	示例	描述
`MAIL_DRIVER`	`postmark`	用于发送电子邮件的邮件驱动。
`POSTMARK_TOKEN`		如果使用Postmark作为`MAIL_DRIVER`，则为Postmark的令牌。
`MAIL_FROM_ADDRESS`	`[email protected]`	发送电子邮件的邮箱地址。
`MAIL_FROM_NAME`	`Docmost`	发送电子邮件的名称。