suziwen/pegasus repository overview

⁠⚙️ 配置要求

1. 最低 1cpu, 512M 内存

一般云服务器厂商提供的最低配置就能满足要求。不过，有可能不同厂商提供的操作系统镜像对 Docker 的魔改限制，可能要求更高的性能，这时候除升级配置外，也可以试着切换不同的操作系统镜像，再试试安装对应的 Docker 容器。上面提供的最低配置是在 Ubuntu 20.04 LTS x64 操作系统， 1 vCPU,512.00 MB 的机器上测试安装成功的。

⁠⌨️ 最基本的命令

docker run -d --name story-writer -p 80:80  suziwen/pegasus

然后就可以通过 http://ip地址 访问小书匠了， 数据库文件地址 http://ip地址/data/user_1

也可以通过开放 5984 端口，然后单独访问对应的数据库 user_1

docker run -d --name story-writer -p 80:80 -p 5984:5984  suziwen/pegasus

通过该链接 http://ip地址:5984/_utils 访问数据库控制台，用户名和密码默认为 pegasus

⁠🖥️ 支持的参数

COUCHDB_USER and COUCHDB_PASSWORD

couchdb 数据库的用户名及密码，默认用户名 pegasus 密码 pegasus

docker run -d --name story-writer -p 80:80 -p 5984:5984 -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password suziwen/pegasus

NGINX_USER and NGINX_PASSWORD

访问 web 版小书匠时，入口的用户名和密码，如果有一个值为空，表示可以直接访问，不需要登录。

docker run -d --name story-writer -p 80:80 -e NGINX_USER=admin -e NGINX_PASSWORD=password suziwen/pegasus

注： 建议不要直接对外开放 5984 端口，而是通过 web 应用地址(http://ip地址/data/user_1)访问数据库。

⁠🧭 映射数据文件路径

数据文件默认存放在容器的 /opt/couchdb/data 路径下，用户可以自己将该路径镜像到宿主机器上

docker run -d --name story-writer -p 80:80 -v /home/couchdb/data:/opt/couchdb/data suziwen/pegasus

⁠🔐 安全

1. 不建议直接开放 5984 端口，而是通过 80 端口进行数据库访问，当需要单独管理数据库时，再通过 5984 端口的数据库控制台，进行操作。
2. 建议自己在应用的外层加一层反向代理，进行访问入口的权限控制，防止匿名用户直接访问应用。
3. 该镜像内部使用了 nginx, 如果不想使用额外的容器，也可以登录到当前容器里，修改 nginx 的访问控制。

⁠锁屏

小书匠提供启动应用自动进入锁屏状态，这里的锁屏，并非将操作系统进入锁屏，而只是针对当前打开的网页进入锁屏状态。因为小书匠是一款支持离线使用的笔记软件，用户在无联网状态下，也是可以继续使用小书匠。这样的优点，同时也产生了另一种缺点，那就是别人在你这台电脑，直接打开该网页，就能查看到文章内容。为了解决该问题，启动应用自动进入锁屏状态功能，就显得非常重要。用户可以在 小书匠主按钮>设置>基本>锁屏, 进行锁屏参数的设置。

注: 第一次使用小书匠时，并不需要锁屏密码，但如果你设置了 NGINX 等用户名/密码认证，就需要先进行这个认证。设置完密码后，如果忘记了密码，可以新开一个隐身会话窗口，再次在该窗口下访问小书匠，输入 NGINX 相关的认证，就可以进入到小书匠里，这时候，就可以自己修改掉锁屏密码或者关掉应用启动锁屏选项，等这些参数都同步完成后，再刷新下原有窗口的小书匠，锁屏状态就会修改了。

⁠💁 其他

1. 如果您想实现 Docker 服务器的全文搜索，方便小书匠客户端手动选择性同步文章，可以考虑安装小书匠天马飞天版⁠。
2. 小书匠天马版默认实现了 PWA (Progressive Web Apps )功能，如果您自己申请了域名，并配置了 https 的支持（当然如果你直接用 localhost,默认就可以直接使用），就可以直接将天马版做为本地的客户端使用了。
3. 如果您没有自己的服务器，也不会 docker ,也可以考虑部署小书匠的 Github Pages 静态网页版-----小书匠招财猫版本⁠ ,演示地址：https://suziwen.github.io/lucky-cat/⁠