showdoc内网服务安装及外网映射

说明

文档管理在项目管理过程中至为重要，其重要性甚至大过代码。

有些不重视文档的团队，是不合格的；不重视文档的领导，也是不称职的。

国内外有很多可以用于团队协同的文档工具，其中不乏做的十分出色的；有时候放到别人的平台上不放心，也有自建文档共享平台的需求，借用开源软件可轻松搭建。

服务依赖开源项目

• showDoc
  • github: https://github.com/star7th/showdoc
  • official website: https://www.showdoc.com.cn/ 可用官方服务测试

服务现状

在哪里

• 服务器：内网服务器

访问方式

• 内网：http://192.168.1.1:8001/
• 外网：http://doc.xxx.xxx/

如要保障外网访问，需内网穿透工具才能访问内网的服务，并结合公网服务器才能转发访问请求

安装方式

内网安装 showDoc 及 frp client

showDoc

• 自行安装 showdoc 服务
• 这里介绍 Windows 系统搭建过程，Unix 上搭建可使用命令行完成

重要说明：

虽按官网采用 phpStudy 集成环境安装，但最终只采用了 apache 作为服务容器。具体请查看 C:\deploy\000showDoc\readme.md

• 位置：C:\deploy\000showDoc\phpstudy_pro
• 监听端口：8001
• 已设置自启动服务：httpdService
• 自启服务配置文件：C:\deploy\000showDoc\phpstudy_pro\Extensions\Apache2.4.39\bin\httpd-apache.xml

frpClient

• frp 官方地址：https://github.com/fatedier/frp#visit-your-web-service-in-lan-by-custom-domains
• 位置：D:\frpServices\frp_showdoc
• 本地服务端口：8001，内网可直接访问 119:8001
• 服务端通信端口：7002
• 已设置自启动服务：frp-showdoc-service
• 配置文件：D:\frpServices\frp_showdoc\frpc.ini
• 具体请查看 D:\frpServices\frp_showdoc 下 readme 文件

[common]
server_addr = public network ip
server_port = 7002
# 安全token
token = xxx-showdoc

[web]
type = http
local_port = 8001
custom_domains = doc.xxx.xxx
#subdomain = doc

一般运行以下命令即可开启客户端服务

frpc.exe -c frpc.ini

但需要做成服务并自启动（使用 winsw ），修改 frpclient.xml 配置后，执行

frpclient.exe install

查看服务中是否存在对应的名称 frp-showdoc-service，并确保服务为自启动

外网安装 frp server 及 Nginx 支持域名访问

外网安装 frp server

• 服务器：阿里云 ip
• 位置：C:\Program Files\frpServices\frp_showdoc
• 监听端口：7002 - 本机服务，与客户端通信
• 访问端口：7003 - nginx 转发
• 已设置自启动服务：frp-showdoc-service
• 配置文件：C:\Program Files\frpServices\frp_showdoc\frps.ini
• 具体请查看 文件夹下 readme 文件

[common]
# 本机frp服务监听的端口
 bind_port = 7002
#http访问的端口7003，nginx转
 vhost_http_port = 7003
# vhost_https_port = 7002
# 安全token
token = showdoc
# 自己的主域名
#subdomain_host = doc.xxx.xxx
dashboard_port = 8013
dashboard_user = admin
dashboard_pwd = hfcas666

外网 nginx 支持域名访问

需要监听域名访问，配置文件 C:\Program Files\nginx-1.20.2\conf\conf.d\7003-119-showdoc.conf

upstream showdoc {
	server localhost:7003;
}

server {
	listen       80;
	server_name  doc.xxx.xxx; 

	location / {
		proxy_pass  http://showdoc;
		resolver 8.8.8.8;
		proxy_set_header    Host            $host;
		proxy_set_header    X-Real-IP       $remote_addr;
		proxy_set_header    X-Forwarded-For $proxy_add_x_forwarded_for;
		proxy_hide_header   X-Powered-By;
	}
}

运行方式

• 内外网均已配置自启服务
• 采用 winsw 制作自启动服务

维护

• 外网
  • log
    • frp: C:\Program Files\frpServices\frp_showdoc\log\
    • nginx: C:\Program Files\nginx-1.20.2\logs\
  • 服务状态：查看服务中 frp-showdoc-service 及 nginx 是否运行正常
• 内网
  • log
    • frp: D:\frpServices\frp_showdoc\log
    • showDoc: C:\deploy\000showDoc\phpstudy_pro\Extensions\Apache2.4.39\logs
  • 服务状态：查看服务中 frp-showdoc-service 及 httpdService 是否运行正常

迁移

• 支持直接拷贝数据文件夹，直接覆盖新的安装位置即可实现数据迁移。
• 需备份文件夹：/sqlite和/Public/Upload 两个
• 重新安装 showdoc 服务后，覆盖两个文件夹即可

• 本文作者： Linking
• 本文链接： https://linking.fun/2021/12/16/showdoc内网服务安装及外网映射/
• 版权声明： 版权所有，转载请注明出处！