目 录CONTENT

文章目录

Notion和飞书的替代品,开源的在线协作文档管理工具——Docmost|好玩儿的Docker项目

咕咕
2024-09-12 / 2 评论 / 7 点赞 / 4532 阅读 / 0 字
温馨提示:
本文最后更新于2024-09-12,若内容或图片失效,请留言反馈。 部分素材来自网络,若不小心影响到您的利益,请联系我们删除。
广告 广告

1. 唠嗑

今天和大家分享一个有点像飞书又有点像Notion的一个协作文档的项目——Docmost,同样支持docker一键部署。

项目目前处于beta测试阶段,作者期待大家的反馈,好不断迭代升级这个项目。

2. 介绍

Docmost 是一个开源的协作wiki和文档软件。官方称它是 Confluence 和 Notion 的开源替代品。

5049470ac443def0b2c650ba26e9fa93.png

68acb468c1d5030d7a38ac44ab3142b1.png

功能特点:

  • 支持实时协作
  • 支持图表(Draw.io、Excalidraw 和 Mermaid)
  • 支持空间管理
  • 支持权限管理
  • 支持群组
  • 支持评论
  • 支持页面历史记录
  • 支持搜索
  • 支持文件附件

3. 相关地址

官方GitHub地址:https://github.com/docmost/docmost (目前4.4k个star,欢迎大家去给项目点星星!)
官网:https://docmost.com/
文档:https://docmost.com/docs

4. 搭建环境

5. 搭建视频(过俩天补充 = =)

5.1 YouTube

视频地址:

5.2 哔哩哔哩

哔哩哔哩:

6. 搭建方式

6.1 安装 Docker 与 Nginx Proxy Manager

可以直接参考这篇内容:

https://blog.laoda.de/archives/nginxproxymanager/

6.2 创建安装目录

创建一下安装的目录:

sudo -i

mkdir -p /root/data/docker_data/docmost

cd /root/data/docker_data/docmost

接着我们来编辑下docker-compose.yml

vim docker-compose.yml
services:
  docmost:
    image: docmost/docmost:latest
    depends_on:
      - db
      - redis
    environment:
      APP_URL: "https://docmost.gugu.ovh"      #这个域名记得改成自己最后反代用的域名
      APP_SECRET: "Yeon12237dtKMUh9rm"     #这个密码可以自己设置一个
      DATABASE_URL: "postgresql://docmost:PASS1WO0RD@db:5432/docmost?schema=public"    #这个PASS1WO0RD密码可以自己设置一个,与下面一致
      REDIS_URL: "redis://redis:6379"
    ports:
      - "3000:3000"
    restart: unless-stopped
    volumes:
      - ./docmost:/app/data/storage

  db:
    image: postgres:16-alpine
    environment:
      POSTGRES_DB: docmost
      POSTGRES_USER: docmost
      POSTGRES_PASSWORD: PASS1WO0RD    #这个密码可以自己设置一个
    restart: unless-stopped
    volumes:
      - ./db_data:/var/lib/postgresql/data

  redis:
    image: redis:7.2-alpine
    restart: unless-stopped
    volumes:
      - ./redis_data:/data

同样,修改完成之后,可以在英文输入法下,按 i 修改,完成之后,按一下 esc,然后 :wq 保存退出。

6.3 打开服务器防火墙(非必需)并访问网页

打开防火墙的端口 3000

举例,腾讯云打开方法如下(部分服务商没有自带的面板防火墙,就不用这步操作了):

image-20220630215240864 image-20220630220546335

类似图中的,这边我们填 3000,示例填 docmost ,确定即可(如果你在 docker-compose 文件里换了 9009,这边就需要填 9009,以此类推)

a327e23ffe59ddcdad756bccd4e24c23.png

查看端口是否被占用(以 3000 为例),输入:

lsof -i:3000  #查看 3000 端口是否被占用,如果被占用,重新自定义一个端口

如果啥也没出现,表示端口未被占用,我们可以继续下面的操作了~

如果出现:

-bash: lsof: command not found

运行:

apt install lsof  #安装 lsof

如果端口没有被占用(被占用了就修改一下端口,比如改成 8381,注意 docker 命令行里和防火墙都要改)

6.4 启动 docmost

cd /root/data/docker_data/docmost

docker compose up -d   # 注意,老版本用户用 docker-compose up -d

等待拉取好镜像,出现 done的字样之后,

理论上我们就可以输入 http://ip:3000 访问了。

但是这边我们推荐先搞一下反向代理!

做反向代理前,你需要一个域名!

namesilo 上面 xyz 后缀的域名一年就 7 块钱,可以年抛。(冷知识,namesilo上 6位数字的xyz续费永远都是0.99美元 = =)

如果想要长期使用,还是建议买 com 后缀的域名,更加正规一些,可以输入 laodade 来获得 1 美元的优惠(不知道现在还有没有)

namesilo 自带隐私保护,咕咕一直在用这家,价格也是这些注册商里面比较低的,关键是他家不像其他家域名注册商,没有七七八八的套路!(就是后台界面有些 古老 = =)

【域名购买】Namesilo 优惠码和域名解析教程(附带服务器购买推荐和注意事项)

我们接着往下看!

7. 反向代理

7.1 利用 Nginx Proxy Manager

在添加反向代理之前,确保你已经完成了域名解析,不会的可以看这个:域名一枚,并做好解析到服务器上域名购买、域名解析 视频教程

baa4249c28647acbe0259f28de8e7755.png

之后,登陆 Nginx Proxy Manager(不会的看这个:安装 Nginx Proxy Manager相关教程))

注意:

Nginx Proxy Manager(以下简称 NPM)会用到 80443 端口,所以本机不能占用(比如原来就有 Nginx)

直接丢几张图:

bbb0aee568b0e9c8c0610510da99861c.png d6ac2cfcc3587225151eeb8d7e9a5b0b.png 669e32877361d7d50036f9ca3b56708c.png aa6a5eec38eb64ba33ac0d7d5c76c88e.png

注意填写对应的 域名IP端口,按文章来的话,应该是 3000

IP 填写:

如果 Nginx Proxy Manager 和 docmost 在同一台服务器上,可以在终端输入:

ip addr show docker0

查看对应的 Docker 容器内部 IP。

否则直接填 docmost 所在的服务器 IP 就行。

7.2 利用宝塔面板

发现还是有不少小伙伴习惯用宝塔面板,这边也贴一个宝塔面板的反代配置:

直接新建一个站点,不要数据库,不要 php,纯静态即可。

然后打开下面的配置,修改 Nginx 的配置。

image-20220819150345725 image-20220819150542867

代码如下:

location / {
      proxy_pass http://127.0.0.1:3000/;       # 注意改成你实际使用的端口
      rewrite ^/(.*)$ /$1 break;
      proxy_redirect off;
      proxy_set_header Host $host;
      proxy_set_header X-Forwarded-Proto $scheme;
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header Upgrade-Insecure-Requests 1;
      proxy_set_header X-Forwarded-Proto https;
    }

此方法对 90% 的反向代理都能生效,然后就可以用域名来安装访问了。

有同学可能会问,为什么不直接用宝塔自带的反向代理功能。

image-20220819150730128

也可以,不过咕咕自己之前遇到过当有多个网站需要反代的时候,在这边设置会报错的情况 = =

所以后来就不用了,直接用上面的方法来操作了。

8. 使用教程

建议参考官方配置文档:https://github.com/docmostapp/docmost/blob/main/docs/configuration.md

8.1 注册与登录后台

访问网址,

4b1f08ea5cdde45789618b79808b6a39.png

注册账号,

aad95e1080baa3c9974576623ed9c163.png

后台界面,

466bd2b84943b9d068a3f15eb8023bee.png

可以邀请用户,

38e283f1e9b82f646046306c110e7800.png

借用官方的demo,大概填充好内容之后,是这个样子的,

5049470ac443def0b2c650ba26e9fa93.png

68acb468c1d5030d7a38ac44ab3142b1.png

其他的可以自己尝试,用过notion或者飞书的小伙伴应该可以很快上手。

8.2 更新 docmost

cd /root/data/docker_data/docmost

docker-compose pull

docker-compose up -d    # 请不要使用 docker-compose stop 来停止容器,因为这么做需要额外的时间等待容器停止;docker-compose up -d 直接升级容器时会自动停止并立刻重建新的容器,完全没有必要浪费那些时间。

docker image prune  # prune 命令用来删除不再使用的 docker 对象。删除所有未被 tag 标记和未被容器使用的镜像

提示:

WARNING! This will remove all dangling images.
Are you sure you want to continue? [y/N]

输入 y

利用 Docker 搭建的应用,更新非常容易~

8.3 卸载 docmost

同样进入安装页面,先停止所有容器。

cd /root/data/docker_data/docmost

docker-compose down

cd ..

rm -rf /root/data/docker_data/docmost  # 完全删除

可以卸载得很干净。

9. 常见问题及注意点

目前个人遇到的问题:

  • 暂不支持Markdown写的东西直接粘贴过去
  • Excalidraw画完之后保存退出点了没反应

10. 结尾

祝大家用得开心,有问题可以去 GitHub 提 Issues,也可以在评论区互相交流探讨。

同时,项目处于初期,有能力给项目做贡献的同学,也欢迎积极加入到 项目 中来,贡献自己的一份力量!

最后,感谢开发人员们的辛苦付出,让我们能用到这么优秀的项目!

参考资料

官方GitHub:https://github.com/docmost/docmost

7
广告 广告

评论区