ShowDoc私有化部署指南：3种方案打造团队专属文档平台

ShowDoc私有化部署指南：3种方案打造团队专属文档平台

【免费下载链接】showdocShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具项目地址: https://gitcode.com/gh_mirrors/sh/showdoc

ShowDoc是一款专为IT团队设计的在线API文档和技术文档工具，支持私有化部署，让企业能够完全掌控数据安全和文档管理流程。无论你是技术决策者还是中级开发者，本指南将详细介绍三种部署方案，帮助你在本地服务器上快速搭建专属文档协作平台。

为什么选择ShowDoc私有化部署？

在数字化转型的浪潮中，技术文档管理成为团队协作的关键环节。ShowDoc私有化部署提供了以下核心价值：

• 数据安全：所有文档数据存储在自有服务器，避免敏感信息外泄风险
• 定制化配置：可根据团队需求调整系统配置和界面风格
• 性能优化：针对内部网络环境进行优化，提升访问速度
• 集成扩展：方便与企业现有系统（如Git、CI/CD等）集成
• 成本控制：一次部署，长期使用，避免SaaS服务的持续订阅费用

📊 部署方案对比分析

选择合适的部署方案是成功实施的第一步。以下是三种主流部署方式的详细对比：

🐳 方案一：Docker容器化部署（推荐）

Docker部署是目前最受欢迎的ShowDoc部署方式，它通过容器技术封装了所有依赖环境，实现了"开箱即用"的体验。

环境准备与前置检查

在开始部署前，确保你的服务器满足以下要求：

• Linux操作系统（CentOS 7+/Ubuntu 18.04+）
• Docker 20.10+ 和 Docker Compose 1.29+
• 至少1GB可用内存
• 2GB以上磁盘空间

详细部署步骤

1. 获取项目源码

# 克隆ShowDoc项目到本地 git clone https://gitcode.com/gh_mirrors/sh/showdoc # 进入项目目录 cd showdoc

2. 配置Docker环境

检查项目根目录下的 docker-compose.yml 文件，这是Docker部署的核心配置文件。默认配置已经包含了完整的服务定义：

services: showdoc: build: context: ./ args: - IN_CHINA=${IN_CHINA:-false} environment: IN_CHINA: ${IN_CHINA:-false} hostname: showdoc ports: - 4999:80 volumes: - ./showdocdata/html:/var/www/html restart: always

3. 启动ShowDoc服务

# 构建并启动容器 docker compose up -d # 查看容器运行状态 docker compose ps # 查看容器日志 docker compose logs -f showdoc

4. 验证部署结果

容器启动后，访问http://你的服务器IP:4999即可看到ShowDoc的安装界面。首次访问会自动引导你完成初始化设置。

生产环境优化建议

对于正式生产环境，建议进行以下配置优化：

# 创建数据持久化目录 mkdir -p /data/showdoc/{html,uploads,backup} # 修改docker-compose.yml中的卷挂载 volumes: - /data/showdoc/html:/var/www/html - /data/showdoc/uploads:/var/www/html/Public/Uploads # 设置定时备份任务（每天凌晨2点备份） 0 2 * * * docker exec showdoc sh -c 'cd /var/www/html && tar -czf /backup/showdoc_$(date +%Y%m%d).tar.gz Sqlite/ Public/Uploads/'

🤖 方案二：自动脚本部署

对于熟悉Linux系统但希望简化部署流程的用户，自动安装脚本提供了平衡便捷性和控制性的选择。

脚本部署流程

1. 下载并执行安装脚本

# 下载官方安装脚本 wget https://www.showdoc.com.cn/script/showdoc # 添加执行权限 chmod +x showdoc # 执行安装（中文版） ./showdoc install # 或安装英文版 ./showdoc install en

2. 脚本工作原理

自动脚本会执行以下操作：

• 检测系统环境并安装Docker（如未安装）
• 拉取ShowDoc官方镜像
• 配置数据存储目录（默认：/showdoc_data/html）
• 启动容器并设置开机自启
• 创建默认管理员账户（用户名：showdoc，密码：123456）

3. 安装后管理命令

# 停止服务 ./showdoc stop # 重启服务 ./showdoc restart # 更新到最新版本 ./showdoc update # 卸载ShowDoc ./showdoc uninstall

常见问题解决

端口冲突处理： 如果4999端口已被占用，可以修改启动脚本或手动调整端口映射：

# 编辑容器配置 docker run -d --name showdoc -p 8080:80 -v /showdoc_data/html:/var/www/html star7th/showdoc

文件权限问题： 确保数据目录有正确的权限设置：

chmod -R 777 /showdoc_data/html/Public/Uploads chown -R www-data:www-data /showdoc_data/html

🛠️ 方案三：手动源码部署

对于需要深度定制或有特殊环境要求的用户，手动部署提供了最大的灵活性。

环境要求与准备

1. 系统要求

   • PHP 5.4+（推荐PHP 7.4+）
   • MySQL 5.5+ 或 SQLite 3.8+
   • Web服务器（Nginx 1.14+ 或 Apache 2.4+）
   • 必要的PHP扩展：pdo_mysql, pdo_sqlite, mbstring, gd, curl

2. 源码准备与配置

# 下载最新版本源码 git clone https://gitcode.com/gh_mirrors/sh/showdoc cd showdoc # 设置文件权限 chmod -R 755 Public/ chmod -R 777 Public/Uploads/ chmod -R 777 Sqlite/ # 配置数据库（使用SQLite示例） cp Sqlite/showdoc.db.php.example Sqlite/showdoc.db.php

3. Web服务器配置示例

Nginx配置：

server { listen 80; server_name showdoc.yourdomain.com; root /path/to/showdoc/Public; index index.php index.html; location / { try_files $uri $uri/ /index.php?$query_string; } location ~ \.php$ { fastcgi_pass unix:/run/php/php7.4-fpm.sock; fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; } location ~ /\.ht { deny all; } }

Apache配置：

<VirtualHost *:80> ServerName showdoc.yourdomain.com DocumentRoot /path/to/showdoc/Public <Directory /path/to/showdoc/Public> Options Indexes FollowSymLinks AllowOverride All Require all granted </Directory> </VirtualHost>

数据库配置选项

ShowDoc支持多种数据库后端，可根据团队规模选择：

MySQL配置示例：

// 修改 server/Application/Common/Conf/config.php 'DB_TYPE' => 'mysql', 'DB_HOST' => 'localhost', 'DB_NAME' => 'showdoc', 'DB_USER' => 'showdoc_user', 'DB_PWD' => 'your_password', 'DB_PORT' => '3306', 'DB_PREFIX' => '',

🔧 部署后配置与优化

1. 安全加固配置

// 修改安全配置 server/Application/Common/Conf/config.php 'URL_CASE_INSENSITIVE' => false, // URL区分大小写 'URL_MODEL' => 2, // PATHINFO模式 'COOKIE_PREFIX' => 'showdoc_', // Cookie前缀 'SESSION_PREFIX' => 'showdoc_', // Session前缀

2. 性能优化建议

• 启用OPcache（PHP加速）：

opcache.enable=1 opcache.memory_consumption=128 opcache.interned_strings_buffer=8 opcache.max_accelerated_files=4000 opcache.revalidate_freq=60

• 配置Redis缓存：

'DATA_CACHE_TYPE' => 'Redis', 'REDIS_HOST' => '127.0.0.1', 'REDIS_PORT' => 6379,

• 启用Gzip压缩（Nginx）：

gzip on; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;

3. 定期维护任务

#!/bin/bash # 备份脚本 /usr/local/bin/showdoc-backup.sh BACKUP_DIR="/backup/showdoc" DATE=$(date +%Y%m%d_%H%M%S) # 备份数据库 mysqldump -u showdoc_user -p'your_password' showdoc > $BACKUP_DIR/showdoc_db_$DATE.sql # 备份上传文件 tar -czf $BACKUP_DIR/showdoc_files_$DATE.tar.gz /path/to/showdoc/Public/Uploads/ # 清理30天前的备份 find $BACKUP_DIR -name "*.sql" -mtime +30 -delete find $BACKUP_DIR -name "*.tar.gz" -mtime +30 -delete

📈 监控与故障排查

健康检查端点

ShowDoc提供了多个健康检查接口，可用于监控系统状态：

# 检查服务状态 curl -f http://localhost:4999/index.php?s=/home/index/check # 检查数据库连接 curl http://localhost:4999/index.php?s=/home/index/dbcheck # 获取系统信息 curl http://localhost:4999/index.php?s=/home/index/info

常见问题解决方案

日志文件位置

• Nginx访问日志：/var/log/nginx/access.log
• Nginx错误日志：/var/log/nginx/error.log
• PHP错误日志：/var/log/php7.4-fpm.log
• ShowDoc应用日志：/path/to/showdoc/server/Runtime/Logs/

🚀 高级部署场景

集群化部署架构

对于高可用性要求的生产环境，可以采用以下架构：

负载均衡器 (Nginx/Haproxy) ↓ [应用服务器1] ←→ [共享存储] ↓ ↑ [应用服务器2] ←→ [Redis缓存] ↓ ↑ [应用服务器3] ←→ [MySQL集群]

关键配置：

• 使用NFS或GlusterFS实现文件共享
• Redis集群实现Session共享
• MySQL主从复制保证数据一致性
• Keepalived实现负载均衡器高可用

容器化进阶配置

# docker-compose.prod.yml version: '3.8' services: showdoc: image: star7th/showdoc:latest container_name: showdoc restart: unless-stopped ports: - "4999:80" environment: - TZ=Asia/Shanghai - MAX_UPLOAD_SIZE=50M volumes: - showdoc_data:/var/www/html - ./custom_config:/var/www/html/server/Application/Common/Conf networks: - showdoc_network healthcheck: test: ["CMD", "curl", "-f", "http://localhost/index.php?s=/home/index/check"] interval: 30s timeout: 10s retries: 3 nginx: image: nginx:alpine ports: - "80:80" - "443:443" volumes: - ./nginx.conf:/etc/nginx/nginx.conf - ./ssl:/etc/nginx/ssl depends_on: - showdoc networks: - showdoc_network networks: showdoc_network: driver: bridge volumes: showdoc_data: driver: local

📋 部署检查清单

在完成ShowDoc部署后，建议按以下清单进行验证：

• 服务能够正常访问（HTTP 200响应）
• 管理员账号可以正常登录
• 文档创建和编辑功能正常
• 文件上传功能正常
• 权限管理功能正常
• 数据备份机制已配置
• 监控告警已设置
• 安全配置已加固
• 性能测试通过
• 团队培训已完成

🎯 最佳实践总结

1. 选择合适的部署方案：根据团队规模和技术能力选择Docker、脚本或手动部署
2. 重视数据安全：定期备份、设置访问控制、启用HTTPS
3. 性能优化先行：配置缓存、压缩、CDN等优化措施
4. 建立维护流程：制定定期检查、更新、备份的标准化流程
5. 团队培训到位：确保团队成员熟悉ShowDoc的使用和管理

通过本指南的三种部署方案，你可以根据团队的具体需求选择最适合的ShowDoc私有化部署方式。无论是追求便捷的Docker部署，还是需要深度定制的源码部署，ShowDoc都能为你的团队提供稳定可靠的文档协作平台。

记住，成功的部署只是开始，持续的维护和优化才是确保系统长期稳定运行的关键。定期关注 server/Application/Common/Conf/config.php 配置文件的更新，及时应用安全补丁，才能让ShowDoc在你的环境中发挥最大价值。

【免费下载链接】showdocShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具项目地址: https://gitcode.com/gh_mirrors/sh/showdoc