当前位置： 首页 > news >正文

基于docker使用showdoc搭建API开发文档服务器

news 来源：原创 2025/8/20 12:24:37

以下是基于 Docker 快速搭建 ShowDoc API 文档服务器的完整指南，包含优化配置和常见问题解决方案：

1. 快速部署方案

# 创建数据目录（确保权限）
mkdir -p /showdoc_data/html && chmod 777 -R /showdoc_data# 一键启动容器（推荐国内镜像）
docker run -d --name showdoc \-p 8080:80 \-v /showdoc_data/html:/var/www/html/ \--restart=always \registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest

2. 生产环境优化配置

2.1 使用 Docker Compose（docker-compose.yml）
version: '3'
services:showdoc:image: registry.cn-shenzhen.aliyuncs.com/star7th/showdoccontainer_name: showdocrestart: unless-stoppedports:- "8080:80"volumes:- /showdoc_data/html:/var/www/html/environment:- TZ=Asia/Shanghai  # 时区设置
2.2 启用 HTTPS（Nginx 反向代理示例）
server {listen 443 ssl;server_name doc.yourdomain.com;ssl_certificate /path/to/cert.pem;ssl_certificate_key /path/to/key.pem;location / {proxy_pass http://localhost:8080;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;}
}

3. 关键功能配置

3.1 初始化后操作
  1. 访问 http://服务器IP:8080
  2. 修改默认密码（初始账号：showdoc/123456）
  3. 进入「管理后台」→「系统设置」：
    • 配置站点名称、LOGO
    • 开启/关闭注册功能
    • 设置附件存储路径（建议映射到宿主机）
3.2 团队协作配置
  • 项目权限：创建项目时可选择「公开」或「私密」
  • 成员管理：通过邮箱邀请团队成员，设置「浏览/编辑」权限
  • 操作日志：查看文档修改历史（支持版本对比）

4. 数据备份与迁移

4.1 备份数据
# 备份数据库（SQLite）
docker exec showdoc sqlite3 /var/www/html/Sqlite/showdoc.db .dump > showdoc_backup.sql# 备份附件
tar -czvf showdoc_attachments.tar.gz /showdoc_data/html/Public/Uploads/
4.2 迁移到新服务器
  1. 在新服务器重复安装步骤
  2. 将备份文件还原到对应目录
  3. 重启容器：docker restart showdoc

5. 常见问题解决

Q1: 访问时出现 502 错误
  • 检查容器是否正常运行：docker ps -a
  • 查看日志：docker logs showdoc
  • 确认端口未被占用：netstat -tulnp | grep 8080
Q2: 上传附件失败
  • 确保 /showdoc_data/html/Public/Uploads 目录有写入权限
  • 检查 PHP 上传限制（容器内修改 /usr/local/etc/php/php.ini）：
    upload_max_filesize = 20M
post_max_size = 20M
Q3: 如何升级版本？
docker stop showdoc
docker rm showdoc
docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest
# 重新运行启动命令（保持原有数据卷）

6. 高级功能扩展

  1. 对接 Git/SVN：通过「Webhook」实现文档自动同步
  2. API 文档自动化：集成 Swagger/OpenAPI 数据导入
  3. 自定义模板：在 /showdoc_data/html/Public/static/md 下添加 Markdown 模板

通过以上步骤，您将获得一个稳定、可协作的 API 文档管理系统。

相关文章：

基于docker使用showdoc搭建API开发文档服务器

以下是基于 Docker 快速搭建 ShowDoc API 文档服务器的完整指南，包含优化配置和常见问题解决方案： 1. 快速部署方案 # 创建数据目录（确保权限） mkdir -p /showdoc_data/html && chmod 777 -R /showdoc_data# 一键启动容器…...

编程日记 2025/8/20 12:24:37

Vision-Language Models (VLMs) 视觉语言模型的技术背景、应用场景和商业前景（Grok3 DeepSearch模式回答）

prompt: 你是一位文笔精湛、十分专业的技术博客作者，你将从技术背景、应用场景和商业前景等多个维度去向读者介绍Vision-Language Models 关键要点 研究表明，视觉语言模型（VLMs）是多模态AI系统，能同时处理视觉和文本数…...

编程日记 2025/8/18 10:12:44

OpenAI大变革！继续与微软等，以非营利模式冲击AGI

今天凌晨2点，OpenAI宣布，将继续由非营利组织控制；现有的营利性实体将转变为一家公共利益公司；非营利组织将控制该公共利益公司，并成为其重要的持股方。 这也就是说OpenAI曾在去年提到的由非营利性转变成营利性公司&am…...

编程日记 2025/8/20 7:23:56

Ubuntu打开中文文本乱码

文章目录 中文乱码问题修复乱码系统字符编码修改文本编码修改vim乱码 utf-8编码原理特点应用场景与其他编码的转换 iso-8859-1基本信息字符涵盖应用场景与其他编码的关系 ubuntu打开文本出现乱码，可能是编码没设置对。 中文乱码问题 使用vim打开文本，或…...

编程日记 2025/8/20 12:06:42

车载通信网络安全：挑战与解决方案

1. 简介 当今时代见证了车载汽车技术的巨大发展，因为现代智能汽车可以被视为具有出色外部基础设施连接能力的信息物理系统 [ 1 ]。车载技术支持的现代智能汽车不应被视为类似于机械系统，而是由数百万行复杂代码组成的集成架构，可为车内乘客提…...

编程日记 2025/8/18 11:11:06

【Linux系统】读写锁

读者写者问题 重点 读者写者问题是并发编程中的经典问题，主要研究多个进程或线程对共享数据进行读和写操作时如何实现同步和互斥，以保证数据的一致性和操作的正确性 。 问题核心要点 同步与互斥：需要确保多个读者可以同时读共享数据&#…...

编程日记 2025/8/18 13:26:17

springBoot中自定义一个validation注解，实现指定枚举值校验

缘由 在后台写接口的时候，经常会出现dto某个属性是映射到一个枚举的情况。有时候还会出现只能映射到枚举类中部分枚举值的情况。以前都是在service里面自行判断，很多地方代码冗余，所以就想着弄一个自定义的validation注解来实现。 例如下面某…...

编程日记 2025/8/17 17:59:34

【Python】--装饰器

装饰器（Decorator）本质上是一个返回函数的函数 主要作用是：在不修改原函数代码的前提下，给函数增加额外的功能 比如：增加业务，日志记录、权限验证、执行时间统计、缓存等场景 my_decorator def func():pas…...

编程日记 2025/8/18 10:12:28

排序算法——堆排序

一、介绍 「堆排序heapsort」是一种基于堆数据结构实现的高效排序算法。我们可以利用已经学过的“建堆操作”和“元素出堆操作”实现堆排序。 1. 输入数组并建立小顶堆，此时最小元素位于堆顶。 2. 不断执行出堆操作，依次记录出堆元素，即可得…...

编程日记 2025/8/18 10:12:26

Day111 | 灵神 | 二叉树 | 验证二叉搜索树

Day111 | 灵神 | 二叉树 | 验证二叉搜索树 98.验证二叉搜索树 98. 验证二叉搜索树 - 力扣（LeetCode） 方法一：前序遍历 递归函数传入合法的左右边界，只有当前结点是合法的边界，才是二叉搜索树，否则就返回…...

编程日记 2025/8/20 2:17:42

软考-软件设计师中级备考 13、刷题 数据结构

倒计时17天时间不多了，数据库、UML、等知识点有基础直接略过，法律全靠考前的一两天刷题，英语直接放弃。 一、数据结构：链表、栈、队列、数组、哈希表、树、图 1、关于链表操作，说法正确的是： A)新增一个头…...

编程日记 2025/8/20 2:03:23

【5G通信】天线调整

在天线工程中，机械下倾角、电子下倾角和数字下倾角是调整天线波束指向的不同技术手段，其核心区别在于实现方式和灵活性： 1. 机械下倾角（Mechanical Downtilt） 定义：通过物理调整天线的安装角度&#xff0c…...

编程日记 2025/8/19 14:27:34

Kafka的Log Compaction原理是什么？

Kafka的Log Compaction（日志压缩）是一种独特的数据保留策略，其核心原理是保留每个key的最新有效记录。以下是关键原理分点说明： 1. 键值保留机制 通过扫描所有消息的key，仅保留每个key对应的最新value值。例如&#…...

编程日记 2025/8/18 7:07:11

嵌入式面试八股文（十四）·内存管理机制、优先级继承机制以及优先级翻转

目录 1. 内存管理算法（五种内存管理机制） 1.1 heap_1.c 1.2 heap_2.c 1.3 heap_3.c 1.4 heap_4.c 1.5 heap_5.c 1.6 总结 2. STM32通知寄存器有哪些？ 2.1 核心寄存器组（Cortex-M） 2.2 特殊功能寄存…...

编程日记 2025/8/18 10:12:13

深度剖析：可视化如何重塑驾驶舱信息交互模式

为什么你开车时总觉得“信息太多却抓不住重点”？ 今天的汽车早已不是单纯的交通工具，而是一个高度集成的信息终端。从导航、油耗、胎压到自动驾驶提示，各种数据不断涌进驾驶舱。 但问题也随之而来： 关键信息被淹没在一堆图标里…...

编程日记 2025/8/17 11:00:14

app根据蓝牙名字不同，匹配不同的产品型号，显示对应的UI界面

在开发一个 App 时，如果希望根据蓝牙设备名称（Bluetooth Name）的不同，自动匹配不同的产品型号，并显示对应的 UI 界面，可以按照以下思路来实现： ✅ 功能目标 扫描并连接蓝牙设备；获取…...

编程日记 2025/8/20 2:03:25

数据结构 --- 栈

1.栈的初始化 2.入栈 3.出栈 4.取出栈顶元素 5.获取栈中有效元素个数 6.栈的销毁 栈：⼀种特殊的线性表，其只允许在固定的⼀端进⾏插⼊和删除元素操作。进⾏数据插⼊和删除操作 的⼀端称为栈顶，另⼀端称为栈底。栈中的数据元素遵守后进先…...

编程日记 2025/8/19 17:03:36

37-算法打卡-栈与队列-滑动窗口最大值-leetcode(239)-第三十七天

1 题目地址 239. 滑动窗口最大值 - 力扣（LeetCode）239. 滑动窗口最大值 - 给你一个整数数组 nums，有一个大小为 k 的滑动窗口从数组的最左侧移动到数组的最右侧。你只可以看到在滑动窗口内的 k 个数字。滑动窗口每次只向右移动一位。返回 滑…...

编程日记 2025/8/18 10:12:02

【原创分享】魔音变声器内含超多语音包实时变声

魔音变声器,一款专业的调音变声器软件 亲测可使用所有功能[真棒] 去除所有广告 ————————————【下 载 地 址】———————————— 【​获取方法1】：https://pan.xunlei.com/s/VOP_TXtKNlevTgYvIlxmmJquA1?pwd8vpi# ————————————【下 …...

编程日记 2025/8/19 15:09:21

数据结构（一）——线性表的顺序表示和实现

一、线性表的定义 由n(n>0)个数据特性相同的元素构成的有限序列称为线性表，(n0)的时候被称为空表。 一个数据元素可以是简单的一个数据，一个符号，也可以是复杂的若干个数据项的组合。 二、线性表的类型定义 s线性表是由n(n≥0)个相同类…...

编程日记 2025/8/18 10:11:58

Winform（12.控件讲解）

ChildForm窗口： ChildForm代码： using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Windows.Forms; namespac…...

编程日记 2025/8/18 10:11:55

Python 10天冲刺 《元编程（Meta-programming）》

Python 的元编程（Meta-programming）是指在程序运行期间动态生成、修改或操作代码的技术。它允许开发者通过代码控制代码的行为，从而实现灵活、可扩展和抽象化的编程模式。Python 提供了多种元编程工具，包括装饰器、元类、动态导入…...

编程日记 2025/8/19 19:18:23

Android开发-创建、运行、调试App工程

在移动应用开发的世界里，Android平台凭借其开放性和广泛的设备支持，成为了许多开发者的选择。而要成为一名合格的Android开发者，掌握如何创建、运行以及调试应用程序是必不可少的基础技能。本文将详细介绍如何使用Android Studio完成这些任务…...

编程日记 2025/8/18 10:11:51

系统级编程(二)：通过读取PE文件获取EXE或者DLL的依赖

PE文件 Windows的PE文件（Portable Executable）是一种专为Windows操作系统设计的标准可执行文件格式，用于存储和管理可执行程序、动态链接库（DLL）、驱动程序等二进制文件。PE文件格式自Windows NT 3.1引入以来，已成为Windows平台上所有可执行文件的标准格式，并广泛应用于…...

编程日记 2025/8/20 6:00:14

Linux主机时间设置操作指南及时间异常影响

一、Linux主机时间设置命令操作指南 1. 查看当前系统时间与时区 查看当前时间与时区：timedatectl # 显示详细时间与时区信息（systemd系统适用） date # 查看当前系统时间 hwclock --show # 查看硬件时…...

编程日记 2025/8/18 10:11:46

GPS定位方案

目录 一、常用的GPS定位方案包括： 二、主流品牌及热销型号 三、常用GPS算法及核心逻辑： 一、基础定位算法 二、高精度算法 三、辅助优化算法 四、信号处理底层算法 四、基本原理（想自己写算法的琢磨一下原理） 一、常用的GP…...

编程日记 2025/8/18 10:11:44

应对联网汽车带来的网络安全挑战

数字化加速正在彻底改变全球各行各业，而汽车行业更是走在了前列。目前，全球自动驾驶汽车保有量约为4860万辆，预计到2024年将增长至5420万辆。 智能汽车的崛起无疑令人兴奋，但也带来了一系列问题。为了保护客户免受新的威胁，汽车行业必须做出一系列考量：针对自动驾驶、网…...

编程日记 2025/8/18 10:11:41

人工智能与生命科学的深度融合：破解生物医学难题，引领未来科技革命

引言 随着人工智能技术的飞速发展，生命科学领域迎来了前所未有的变革。从药物研发到疾病预测，从个性化医疗到基因组学，AI的深度融入不仅加速了生物医学的进步，还在多个领域打破了传统科学研究的局限，开创了新的医学前沿…...

编程日记 2025/8/20 16:21:53

DeepSeek智能时空数据分析（七）：4326和3857两种坐标系有什么区别？各自用途是什么？

序言：时空数据分析很有用，但是GIS/时空数据库技术门槛太高 时空数据分析在优化业务运营中至关重要，然而，三大挑战仍制约其发展：技术门槛高，需融合GIS理论、SQL开发与时空数据库等多领域知识；空…...

编程日记 2025/8/18 12:27:15

Qt/C++面试【速通笔记七】—Qt中为什么new QWidget不需要手动调用delete？

在Qt的开发中，管理内存是一个非常重要的话题，特别是在使用QWidget这类窗口组件时，很多开发者会遇到一个问题：“为什么我使用new QWidget创建的窗口对象不需要手动调用delete进行销毁？”。 1. 父子关系机制：…...

编程日记 2025/8/18 13:06:33

Super-vlan

Super VLAN（VLAN聚合）的理论与配置 1. 基本概念 Super VLAN（超级VLAN）是一种VLAN聚合技术，主要用于解决传统VLAN划分中IP地址浪费的问题。其核心思想是将多个Sub VLAN（子VLAN）聚合到一个Super …...

编程日记 2025/8/17 8:31:26

C——函数

一、函数的概念 数学中我们其实就⻅过函数的概念，⽐如：⼀次函数 y kx b ，k和b都是常数，给⼀个任意的 x，就得到⼀个y值。 其实在C语⾔也引⼊函数（function）的概念，有些翻译为&…...

编程日记 2025/8/19 20:35:24

5.6刷题并查集

P1551 亲戚 #include<bits/stdc.h> using namespace std; const int N 5010; int f[N]; int find(int x){if(f[x] x)return x;return f[x] find(f[x]); } void solve(){int n, m, p; cin >> n >> m >> p;for(int i 1; i < n; i)f[i] i;for(in…...

编程日记 2025/8/20 4:50:07

pcl平面投影

// 创建一个系数为XY0,Z1的平面pcl::ModelCoefficients::Ptr coefficients (new pcl::ModelCoefficients ());coefficients->values.resize (4);coefficients->values[0] coefficients->values[1] 0;coefficients->values[2] 1.0;coefficients->values[3] 0…...

编程日记 2025/8/18 10:11:32

Linux远程管理

如何查看ip 如何使用vim编辑器 如何设置网络信息 远程访问 一&#xff1a;网络管理 &#xff08;1&#xff09;获取计算机的网络信息 基本语法&#xff1a; windows ipconfig ifconfig enS33: f1agS4163<UP,BR0ADCAST,RUNNING,MULTICAST> mtu 1500 inet…...

编程日记 2025/8/18 10:11:30

如何添加或删除极狐GitLab 项目成员？

极狐GitLab 是 GitLab 在中国的发行版&#xff0c;关于中文参考文档和资料有&#xff1a; 极狐GitLab 中文文档极狐GitLab 中文论坛极狐GitLab 官网 项目成员 (BASIC ALL) 成员是有权访问您的项目的用户和群组。 每个成员都有一个角色&#xff0c;这决定了他们在项目中可以…...

编程日记 2025/8/19 20:20:28

2025年服务器技术全景解析：量子计算、液冷革命与未来生态构建

2025年服务器技术全景解析&#xff1a;量子计算、液冷革命与未来生态构建 一、量子计算&#xff1a;从实验室到产业化的跨越 1. 中国量子计算产业化突破 • 本源量子“悟空”超导计算机&#xff1a; 搭载72位自主超导量子芯片“悟空芯”&#xff0c;支持198个量子比特…...

编程日记 2025/8/19 11:02:11

Vue3+ Vite + Element-Plus + TypeScript 从0到1搭建

一环境准备 二vite 项目初始化 按照 &#x1f343;Vite 官方文档 - 搭建第一个 Vite 项目 说明&#xff0c;执行以下命令完成 vue 、typescirpt 模板项目的初始化 npm init vitelatest vue3-element-admin --template vue-tsvue3-element-admin: 自定义的项目名称 vue-ts &am…...

编程日记 2025/8/18 10:11:26

如何对 Redis 进行水平扩展和垂直扩展以应对微服务流量的增长？

核心概念&#xff1a; 垂直扩展 (Scale Up): 提升单个节点的性能。简单来说就是给现有的 Redis 服务器增加更多的 CPU 、内存、更快的存储&#xff08;SSD&#xff09;或更高的网络带宽。水平扩展 (Scale Out): 增加更多节点来分担负载。这意味着部署多个 Redis 实例&#xff…...

编程日记 2025/8/18 10:11:23

PyCharm 加载不了 conda 虚拟环境，不存在的

#工作记录 前言 在开发过程中&#xff0c;PyCharm 无法加载 Conda 虚拟环境是常见问题。 在不同情况下&#xff0c;“Conda 可执行文件路径”的指定可能会发生变化&#xff0c;不会一尘不变&#xff0c;需要灵活处置。 以下是一系列解决此问题的经验参考。 检查 Conda 安装…...

编程日记 2025/8/18 10:11:21

Matlab/Simulink的一些功能用法笔记（4）

水一篇帖子 01--MATLAB工作区的保护眼睛颜色设置 默认的工作区颜色为白色 在网上可以搜索一些保护眼睛的RGB颜色参数设置 在MATLAB中按如下设置&#xff1a; ①点击预设 ②点击颜色&#xff0c;点击背景色的三角标符号 ③点击更多颜色&#xff0c;找到RGB选项 ④填写颜色参数…...

编程日记 2025/8/18 10:11:19

OS7.【Linux】基本指令入门(6)

目录 1.zip和unzip 配置指令 使用 两个名词:打包和压缩 打包 压缩 Linux下的操作演示 压缩和解压缩文件 压缩和解压缩目录 -d选项 2.tar Linux下的打包和压缩方案简介 czf选项 xzf选项 -C选项 tzf选项 3.bc 4.uname 不带选项的uname -a选项 -r选项 -v选项…...

编程日记 2025/8/19 19:23:30

便捷OCR文字识别软件推荐

软件介绍 此次要介绍的是一款OCR识别软件。 核心功能及特点 这款小巧的OCR识别软件&#xff0c;功能简洁&#xff0c;操作方便&#xff0c;只需进行截图&#xff0c;随后就能自动识别文字内容。并且&#xff0c;它具备离线使用的特性&#xff0c;这一特点使得它非常适合在不联…...

编程日记 2025/8/20 10:24:00

【中间件】brpc_基础_栈管理

文章目录 BRPC bthread栈管理1 简介2 关键数据结构2.1 栈描述符 (bthread_stack_t)2.2 栈池 (StackPool) 3 核心操作3.1 栈分配 (bthread_stack_alloc)3.2 栈释放 (bthread_stack_dealloc)3.3 栈切换支持 4 性能优化5 安全性设计6 跨平台实现6.1 Linux6.2 Windows 7 应用场景8 …...

编程日记 2025/8/18 13:06:27

Linux 硬盘和光驱系统管理

一、硬盘与目录的容量 [rootwww ~]# df [-ahikHTm] [目录或档名] 选项与参数&#xff1a; -a &#xff1a;列出所有的档案系统&#xff0c;包括系统特有的 /proc 等档案系统&#xff1b; -k &#xff1a;以 KBytes 的容量显示各档案系统&#xff1b; -m &#xff1a;以 MByt…...

编程日记 2025/8/18 13:06:25

分库分表后复杂查询的应对之道：基于DTS实时性ES宽表构建技术实践

1 问题域 业务发展的初期&#xff0c;我们的数据库架构往往是单库单表&#xff0c;外加读写分离来快速的支撑业务&#xff0c;随着用户量和订单量的增加&#xff0c;数据库的计算和存储往往会成为我们系统的瓶颈&#xff0c;业界的实践多数采用分而治之的思想&#xff1a;分库…...

编程日记 2025/8/20 4:43:28

[三分钟]性能测试工具JMeter入门: 下载安装JMeter并设置中文；JMeter基本使用流程

文章目录 1.下载并打开JMeter2.设置JMeter中文3.JMeter基本使用流程 Apache JMeter 是 Apache 组织基于 Java 开发的压力测试工具。 JMeter 支持多种协议和技术&#xff0c;如 HTTP、HTTPS、FTP、JDBC、SOAP、REST、JMS 等。它不仅可以用于性能测试&#xff0c;还可以用于功能测…...

编程日记 2025/8/18 13:06:22

StableDiffusionWebUI的AI绘图AI绘视频详细使用教程+报错排坑

概述 这里是官方的最原始的体积最小的StableDiffusionWebUI的下载及其使用教程&#xff0c;已经帮你们把坑都排完了&#xff0c;本教程适合开发者、程序员自己折腾&#xff0c;源码体积只有1.8M。 从0安装到绘图 1.环境 Python与Git环境&#xff1a; 安装Python3.10.0 >…...

编程日记 2025/8/18 13:06:19

Flutter 合并 ‘dot-shorthands‘ 语法糖，Dart 开始支持交叉编译

最近在 Dart 在 main 3.9 合并了一项名为 「dot-shorthands」 的语法糖提议&#xff0c;该提议主要是为了简化开发过程中的相关静态固定常量的写法&#xff0c;通过上下文类型推断简化枚举值和静态成员的访问&#xff1a; 简单来说&#xff0c;就是在之前你可能需要写 SomeEnum…...

编程日记 2025/8/18 13:06:18

貌似我的ollama加载的模型被下载了两份？终于搞懂原理了。

文章目录 背景ollama的模型默认会被放在哪儿呢？什么是homedir？ollama服务直接ollama serve如何修改保存模型文件的路径？背景 如果你想以最快的方式，部署本地的大模型，那么ollama无疑是最合适的选择之一。我其实linux用的不多。之前一直是在windows上部署的ollama。后来有…...

编程日记 2025/8/18 13:06:16