前往小程序,Get更优阅读体验!
立即前往
发布
社区首页 >专栏 >BookStack速成指南:本地快速搭建在线文档管理系统与远程协作

BookStack速成指南:本地快速搭建在线文档管理系统与远程协作

作者头像
FGGIT
发布2025-01-24 09:15:32
发布2025-01-24 09:15:32
13900
代码可运行
举报
文章被收录于专栏:知识学习知识学习
运行总次数:0
代码可运行

前言

你是否曾经因为管理大量的技术文档、项目笔记或者团队知识库而感到头疼呢?有没有想过有一个高效便捷的平台来帮助你轻松搞定这一切?BookStack 就是你的最佳选择!这款开源的知识管理和服务平台基于 Laravel + Vue.js 构建,不仅界面友好,功能也非常强大。它支持所见即所得和Markdown编辑器,非常适合个人或团队使用。

但问题来了:如何快速搭建这样一个系统,并且在没有公网IP的情况下实现远程访问呢?答案就是Docker和cpolar!通过Docker,你可以在几分钟内完成BookStack的本地部署,每个应用都在独立的容器中运行,互不干扰。而cpolar则可以帮助你在不需要折腾路由器设置的情况下轻松实现实时远程访问。

下面就跟大家分享如何在Linux上用Docker快速搭建在线文档管理系统BookStack,并且通过cpolar内网穿透工具实现异地远程访问。接下来的内容将会一步步带你搞定这一切,相信我,看完这篇文章后你会觉得这简直是小菜一碟!让我们开始吧!

1. 安装Docker

本教程操作环境为Linux Ubuntu系统,在开始之前,我们需要先安装Docker。

本例使用Ubuntu 22.04进行演示,使用Docker进行部署,如果没有安装Docker,可以查看这篇教程进行安装:《Docker安装教程——Linux、Windows、MacOS》

2. 创建并启动BookStack容器

接下来创建BookStack项目文件夹并编辑docker-compose.yml,内容如下:

代码语言:javascript
代码运行次数:0
复制
mkdir bookstack
代码语言:javascript
代码运行次数:0
复制
nano docker-compose.yml

在编辑器中输入下方代码保存退出:

代码语言:javascript
代码运行次数:0
复制
services:
  bookstack:
    image: ghcr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - APP_URL=http://localhost:8282
      - DB_HOST=db
      - DB_USER=bookstack
      - DB_PASS=secret
      - DB_DATABASE=bookstack
    volumes:
      - ./bookstack-data:/config
    ports:
      - 8282:80
    depends_on:
      - db
  db:
    image: mysql:5.7
    container_name: bookstack_db
    environment:
      MYSQL_ROOT_PASSWORD: rootpassword
      MYSQL_DATABASE: bookstack
      MYSQL_USER: bookstack
      MYSQL_PASSWORD: secret
    volumes:
      - ./mysql-data:/var/lib/mysql
volumes:
  bookstack-data:
  mysql-data:

然后执行下方命令启动容器运行:

代码语言:javascript
代码运行次数:0
复制
sudo docker compose up -d

如需停止可以执行:

代码语言:javascript
代码运行次数:0
复制
sudo docker-compose down

OK,经过以上过程,Docker部署 BookStack 相册 就完成了,现在我们可以通过任意浏览器进行访问测试。

在浏览器输入 http://localhost:8282 即可,显示下图即为访问成功!

image-20240906165151775
image-20240906165151775

3. 登录与简单使用

在登录界面,默认Email地址为 admin@admin.com,密码为 password

成功登录后的主界面如下图所示:

image-20240906170043895
image-20240906170043895

点击右上角用户名admin,在下拉框里面点击编辑用户资料链接,进入编辑页面对用户信息进行修改,比如用户名、密码、头像、首选语言等。

image-20240906170315200
image-20240906170315200

修改完中文显示后点击LOGO返回首页

image-20240906170506935
image-20240906170506935

点击右上角图书按钮,即可创建图书:

1725613530317
1725613530317

添加相关书籍信息后,点击保存图书

1725613818105
1725613818105

然后可以点击创建页面或添加章节进入编辑界面:

image-20240906171217980
image-20240906171217980
image-20240906172802001
image-20240906172802001
image-20240906172553749
image-20240906172553749

以此类推,可以添加更多的书籍到你的书架中:

image-20240906172857628
image-20240906172857628

4. 公网远程访问本地BookStack

不过我们目前只能在本地访问刚刚使用docker部署的BookStack书库,如果身在异地,想要远程访问在家中部署的BookStack并上传与管理书籍,应该怎么办呢?我们可以使用cpolar内网穿透工具来实现无公网ip环境下的远程访问需求。

4.1 内网穿透工具安装

下面是安装cpolar步骤:

Cpolar官网地址: https://www.cpolar.com

使用一键脚本安装命令

代码语言:javascript
代码运行次数:0
复制
curl https://get.cpolar.sh | sudo sh
image-20240801132238671
image-20240801132238671

安装完成后,执行下方命令查看cpolar服务状态:(如图所示即为正常启动)

代码语言:javascript
代码运行次数:0
复制
sudo systemctl status cpolar
image-20240801132301959
image-20240801132301959

Cpolar安装和成功启动服务后,在浏览器上输入ubuntu主机IP加9200端口即:【http://localhost:9200】访问Cpolar管理界面,使用Cpolar官网注册的账号登录,登录后即可看到cpolar web 配置界面,接下来在web 界面配置即可:

image-20240801133735424
image-20240801133735424
4.2 创建远程连接公网地址

登录cpolar web UI管理界面后,点击左侧仪表盘的隧道管理——创建隧道:

  • 隧道名称:可自定义,本例使用了:BookStack 注意不要与已有的隧道名称重复
  • 协议:http
  • 本地地址:8282
  • 域名类型:随机域名
  • 地区:选择China VIP
1725615250077
1725615250077

创建成功后,打开左侧在线隧道列表,可以看到刚刚通过创建隧道生成了两个公网地址:

1725615283044
1725615283044

接下来,需要将书库的docker-compose文件中的地址 http://localhost:8282 替换为这个http协议的公网地址:

代码语言:javascript
代码运行次数:0
复制
nano docker-compose.yml
image-20240906180835742
image-20240906180835742

然后保存退出,先停止容器在启动容器

代码语言:javascript
代码运行次数:0
复制
sudo docker compose down
代码语言:javascript
代码运行次数:0
复制
sudo docker compose up -d
image-20240906181208479
image-20240906181208479

然后就可以在其他电脑或手机平板(异地)上,使用这个http公网地址在浏览器中访问即可。

如下图所示,成功实现使用公网地址异地远程访问本地部署的 BookStack 书库!

image-20240906181238766
image-20240906181238766
image-20240906181301314
image-20240906181301314

小结

为了方便演示,我们在上边的操作过程中使用了cpolar生成的HTTP公网地址隧道,其公网地址是随机生成的。这种随机地址的优势在于建立速度快,可以立即使用。然而,它的缺点是网址是随机生成,这个地址在24小时内会发生随机变化,更适合于临时使用。

如果有长期远程访问本地 BookStack 书库或者其他本地部署的服务的需求,但又不想每天重新配置公网地址,还想地址好看又好记并体验更多功能与更快的带宽,那我推荐大家选择使用固定的二级子域名方式来远程访问。

4.3 使用固定公网地址远程访问

登录cpolar官网,点击左侧的预留,选择保留二级子域名,地区选择China VIP,设置一个二级子域名名称,点击保留,保留成功后复制保留的二级子域名名称,这里我填写的是mybooksk,大家也可以自定义喜欢的名称。

image-20240906181725712
image-20240906181725712

保留成功后复制保留成功的二级子域名的名称:mybooksk,返回登录Cpolar web UI管理界面,点击左侧仪表盘的隧道管理——隧道列表,找到所要配置的隧道 BookStack,点击右侧的编辑:

image-20240906181833207
image-20240906181833207

修改隧道信息,将保留成功的二级子域名配置到隧道中

  • 域名类型:选择二级子域名
  • Sub Domain:填写保留成功的二级子域名:mybooksk
  • 地区:选择China VIP

点击更新(注意,点击一次更新即可,不需要重复提交)

image-20240906181928617
image-20240906181928617

更新完成后,打开在线隧道列表,此时可以看到公网地址已经发生变化,地址名称也变成了固定的二级子域名名称的域名:

image-20240906182037855
image-20240906182037855

接下来,再次回到终端中将书库的docker-compose文件中的随机公网地址替换为这个固定不变的公网地址并重启docker容器即可:

image-20240906182236134
image-20240906182236134

然后使用这个固定公网地址在浏览器访问,可以看到访问成功,这样即使出门在外也可以随时随地使用这个网址来远程访问本地部署的 BookStack 书库来管理本地图书了!

image-20240906182444743
image-20240906182444743

怎么样?是不是感觉很简单呢?通过Docker和cpolar的组合拳,你不仅可以在几分钟内完成BookStack的本地部署,还能轻松实现异地远程访问。无论你是个人用户还是团队管理者,这个方法都能大大提升你的工作效率。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2025-01-23,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 1. 安装Docker
  • 2. 创建并启动BookStack容器
  • 3. 登录与简单使用
  • 4. 公网远程访问本地BookStack
    • 4.1 内网穿透工具安装
    • 4.2 创建远程连接公网地址
    • 4.3 使用固定公网地址远程访问
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档