开源知识库&Wiki工具-BookStack

龅牙兔谈科技 2024-05-10 19:20:31

BookStack 是一个免费且开源的知识管理和文档化平台,以简单易用和高度组织性为特色,非常适合团队和个人进行项目文档、技术文档或知识库的建立和维护。

BookStack 是一个简单、自托管、易于使用的平台,专门用于组织和存储信息。它为用户提供了一个结构化的方式来创建、管理和分享文档和知识。这个平台特别适合于需要有序存储大量信息的团队或个人,如技术文档、会议记录、项目计划等。

BookStack 采用 PHP 开发,并基于 Laravel 框架构建,提供了一种直观的方式来组织和存储信息。

GitHub地址:https://github.com/BookStackApp/BookStack

DockerHub地址:https://hub.docker.com/r/linuxserver/bookstack

官网链接:https://www.bookstackapp.com

主要特性免费且开源:BookStack 是基于 MIT 许可证的完全开源项目,源代码可在 GitHub 上查看。简单易用的界面:界面简洁,编辑器支持所见即所得(WYSIWYG),内容分为三个实际组:书籍、章节和页面。可搜索且互联:BookStack 的内容完全可搜索,支持在书籍级别或跨书籍、章节和页面搜索。支持直接链接到任何段落,便于文档互联。可配置性:可配置的选项允许根据使用场景设定 BookStack,如更改名称、logo、注册选项及公开可见性等。简单的系统要求:基于 PHP 和 Laravel 框架构建,使用 MySQL 存储数据。性能优化良好,可以在配置较低的服务器上运行。内置 diagrams.net:页面编辑器内置 diagrams.net 绘图功能,可快速方便地在文档中创建图表。支持多语言:支持多种语言设置,感谢社区贡献者的支持,包括英语、法语、德语、西班牙语、意大利语、日语等多种语言。支持 Markdown 编辑器:提供 Markdown 编辑器和实时预览功能,支持 Markdown 爱好者。集成的认证系统:支持多种社交登录提供商,如 GitHub、Google、Slack 和 AzureAD 等。对企业环境还提供 Okta、SAML2 和 LDAP 认证选项。强大的功能:提供强大的搜索和链接功能,跨书籍排序,页面修订和图像管理。完整的角色和权限系统,可以根据需要锁定内容和操作。多因素认证:内置多因素认证(MFA),支持按角色级别强制执行。MFA 选项包括 TOTP(如 Google/Microsoft Authenticator、Authy 等)和静态备份代码。暗黑模式与亮色模式:提供亮色和暗黑两种主题,用户可根据个人喜好选择,适合在不同光照环境下保护眼睛。适用场景企业文档管理:公司可以使用 BookStack 来创建和管理技术文档库、会议记录和操作手册。教育资源共享:教育机构可以利用 BookStack 来组织和共享教学资料和学术研究。个人知识管理:个人用户可以使用 BookStack 作为个人学习和研究的知识库。部署和访问//以Docker方式安装docker run -d \ --name=bookstack \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e APP_URL=yourbaseurl \ -e DB_HOST=yourdbhost \ -e DB_PORT=yourdbport \ -e DB_USER=yourdbuser \ -e DB_PASS=yourdbpass \ -e DB_DATABASE=bookstackapp \ -e QUEUE_CONNECTION= `#optional` \ -p 6875:80 \ -v /path/to/bookstack/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/bookstack:latest http://localhost_ip:6875 //浏览器访问

参数解释:

参数

功能说明

-p 80

将容器的 80 端口映射到主机的 6875 端口

-e PUID=1000

设置用户 ID(UID),详情见下文说明

-e PGID=1000

设置用户组 ID(GID),详情见下文说明

-e TZ=Etc/UTC

指定使用的时区,参见相关列表

-e APP_URL=yourbaseurl

指定应用程序访问的 IP:端口 或 URL(例如 http://192.168.1.1:6875 或 https://bookstack.mydomain.com)

-e DB_HOST=yourdbhost

指定数据库主机地址

-e DB_PORT=yourdbport

指定数据库端口(若非默认3306)

-e DB_USER=yourdbuser

指定数据库用户名

-e DB_PASS=yourdbpass

指定数据库密码(要求至少4个字符且非字母数字密码需正确转义)

-e DB_DATABASE=bookstackapp

指定使用的数据库

-e QUEUE_CONNECTION=

设置为 database 以启用异步操作,如发送邮件或触发 Webhook,详见文档

-v /config

持久化配置文件

注意:① 安装过程详解或其他安装方式,请参考官方安装指导手册https://www.bookstackapp.com/docs/admin/installation/;② 更新维护手册,请参考官方链接https://www.bookstackapp.com/docs/admin/updates/

使用

官方提供在线Demo环境:https://demo.bookstackapp.com

!!!【点赞】、【关注】不走丢^_^

!!!【点赞】、【关注】不走丢^_^



0 阅读:0

龅牙兔谈科技

简介:感谢大家的关注