简单免费的Wiki知识库软件BookStack安装及使用教程
开源软件身份卡 | |
---|---|
名称 | Bookstack |
官网 | 官网 |
代码托管 | Github |
开发团队 | Dan Brown |
开源协议 | MIT |
本文档使用版本 | 24.05.2 |
本文档更新日期 | 2024年9月21日 |
配套视频教程 | B站 |
BookStack是由英国全栈Web开发工程师Dan Brown开发的,开源协议为MIT协议。
安装
使用Docker Compose安装,离线镜像下载地址:https://www.alipan.com/s/fXhbMCWoAEh
依次加载镜像:docker load -i bookstack.24.05.2.tar.gz
、docker load -i mariadb.10.11.8.tar.gz
编辑nano docker-compose.yml
文件内容:
- docker-compose.yml
version: "2" services: bookstack: image: linuxserver/bookstack:24.05.2 # 修改 container_name: bookstack environment: - PUID=1000 - PGID=1000 - APP_URL=http://demo.example.com # 修改 - DB_HOST=bookstack_db - DB_PORT=3306 - DB_USER=bookstack - DB_PASS=3xrogdxUXhYD # 修改 - DB_DATABASE=bookstackapp volumes: - ./bookstack_app_data:/config ports: - 80:80 # 修改 restart: unless-stopped depends_on: - bookstack_db bookstack_db: image: linuxserver/mariadb:10.11.8 # 修改 container_name: bookstack_db environment: - PUID=1000 - PGID=1000 - MYSQL_ROOT_PASSWORD=3xrogdxUXhYD # 修改 - TZ=Asia/Shanghai - MYSQL_DATABASE=bookstackapp - MYSQL_USER=bookstack - MYSQL_PASSWORD=3xrogdxUXhYD # 修改 volumes: - ./bookstack_db_data:/config restart: unless-stopped
启动:docker compose up -d
默认账号为:admin@admin.com
,默认密码为:password
介绍
BookStack的内容组织形式为书架-图书-章节-页面,当然也可以跳过书架直接创建图书,支持自定义图书封面、添加标签,也可以跳过章节直接创建页面
默认为可视化编辑器,可视化编辑器采用的是TinyMCE。可以在设置-个性化-默认页面编辑器中修改为Markdown,Markdown编辑时为两栏结构、实时预览。
我们再回到可视化编辑演示中,支持自动保存草稿,点击中间草稿提示区可以切换可视化编辑和Markdown编辑,可以干净地转换为Markdown(可能会丢失格式)或者保留原格式转换为Markdown。
表格支持可视化操作;图片管理器操作也比较美观,图片可以直接拖动修改大小;插入代码块或者行内代码;思维导图使用的是diagrams,也就是draw.io那个公司(同时该公司还是BookStack的青铜赞助商),点击保存即可以png形式显示在页面中。
右侧可以打开侧边栏,支持添加标签、上传附件、将页面设置为页面模板或选择已有模板、查看页面的评论,保存时可以选填更新说明。
页面右侧是关于页面的一些操作,包括基本的编辑/复制/移动/删除;查看修订历史;设置权限;关注,点击关注后,会在详细信息下方出现通知的偏好设置,通知是使用电子邮件进行通知的;收藏,点击收藏后,会在右上角-头像-我的收藏中出现;支持导出为多个格式,导出为PDF需要服务器有中文字体,不然导出是乱码的。
下方可以添加评论、回复评论。
在面包屑导航中点击小箭头支持快捷跳转,我们回到图书一级,图书的右侧增加了排序功能。图书页面下方的导出,导出的是图书内的全部页面。
后台支持添加用户,集成了多种认证方式;权限的话支持创建不同的角色,授予不同的系统权限、创建、浏览、编辑、删除等权限。
BookStack支持API,在URL后跟/api/docs
可以查看API文档,在我的账户-访问与安全中创建API令牌后就可以使用API了。
总结(个人观点)
优点
- 完全开源
- 界面现代化
- 支持Markdown
- 可以排序(至于为什么要把排序单独列出来,是因为在研究XWiki时发现竟然不支持页面排序)
- 用户和组权限配置
- 支持认证登录
- 具备API
不足之处:
- 同时编辑时无提醒
- 个人认为提前设定好书架/图书限制了内容的再组织(当然这也好解释,毕竟人家名字中就带有Book)
- 不支持自定义URL(如果页面名称为中文,那么页面的url地址是随机的字母数字混合字符)
个人认为不能替代Confluence的,个人、小团队使用还是可以的。