suziwen/dragon repository overview

小书匠天马飞天版，用户可以自己部署小书匠知识管理系统。

天马飞天，即是龙。

⁠差异

该版本跟天马版⁠的主要区别是提供了服务器文章管理，比如服务器全文搜索(lucene)。

天马版只是为了满足最基本的多端同步需求，文章的管理需要自己通过数据库 Couchdb 官方提供的管理页面进行操作。对硬件的需求是向最低化方向发展的，也就是尽可能的不需要太高服务器性能就可以运行天马版。

而天马飞天版，开发的方向是提供尽可能丰富的文章管理接口，虽然现在只提供了全文搜索，但将来会在这个版本上开发出更多丰富的功能。因为功能的添加，也会造成对服务器性能要求上的提升，比如需要更高的内存， CPU 计算能力，硬盘空间等。

如果你只是想要多端同步，天马版完全满足你的需求。如果想把服务器做为自己的数据中心，并且想要更好 的管理文章，可以考虑使用天马飞天版。

不管你选择哪个版本，后继都可以自由切换到相同平行版本号的不同版本上，只要数据文件都是指向相同的存储路径上就可以了（数据文件需要自己映射到宿主机器上），当然，在切换时，最好自己先备份数据文件，以免切换失误引起的数据损坏问题。

⁠配置要求

1. 最低 1cpu, 512M 内存
2. 建议 1cpu, 1G 内存

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

⁠最基本的命令

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

其他一些参数，可以查看天马版⁠的说明。

这里只说明下天马飞天版的一些差别处。

⁠索引文件位置

/opt/couchdb-lucene/indexes

如果想将索引文件放到宿主机上，可以添加类似下面的参数

-v /home/user/lucene/indexes:/opt/couchdb-lucene/indexes

⁠跟小书匠客户端集成

想在小书匠客户端⁠上使用该版本内置的 couchdb 数据库时，不要使用 5984 端口开放的数据库地址。而是使用 80 端口对应的数据库地址。这样就可以在小书匠客户端上，使用服务器的全文搜索功能。

使用类似下面这个地址
http://ip:80/data/user_1
不要使用 couchdb 开放的 5984 数据库地址
http://ip:5984/user_1