ShowDoc 本地部署

2021-03-16 14:59:36 阅读：820 来源： 互联网

标签：git 部署 ShowDoc nginx proxy 本地 pip showdoc mkdocs

ShowDoc 本地部署

参考：官方文档

基本步骤

1. 自动安装

需要首先安装好Docker

wget https://www.showdoc.com.cn/script/showdoc
chmod +x showdoc
./showdoc

2. 常用命令

#停止
./showdoc stop 
#重启
./showdoc restart
#升级showdoc到最新版
./showdoc update
#卸载showdoc
./showdoc uninstall

遇到的问题

外部图床403。原因是图片请求时referrer被检测到

需要在html页面head中加入：

<meta name="referrer" content="never">

3. nginx配置

# 使用80端口根目录作为Showdoc入口
server {
    listen 80;

    location / {
        proxy_pass http://127.0.0.1:4999/;
        proxy_set_header X-Forwarded-Host $host;
        client_max_body_size    100m;
    }
}

4. 备份

准备一个空的Git仓库：“http://10.241.39.17/wondersgroup.com/showDoc.git”

准备同步脚本
克隆git仓库，在仓库根目录新建脚本backup.sh：

#!/bin/bash
echo "================="
echo "autoBackup by Lixiangyu"

git pull

rsync -rtv /showdoc_data/html/Public/Uploads/ ./Public/Uploads
rsync -rtv /showdoc_data/html/Sqlite ./

echo "
▶ git add .
"
git add .
git status
#echo -n "
#▶ commit message:
#
#▶ "
#read msg
time=`date`
msg="日期：$time，自动备份"
git commit -m "$msg"

echo "
▶ git push
"
git push

每天自动同步
保存用于自动同步的账户信息

# 初次运行时，保存git账户密码信息，用于自动push
git config --global credential.helper store
git pull
# 以上过程将使用git credential存储了输入的用户名和密码

运行自动任务

chmod +x backup.sh

# 编辑自动任务表
crontab -e

# 加入以下内容：
# Showdoc Backup

0 2 * * * /bin/sh /root/tools/showDoc/backup.sh >> /root/tools/showDoc/log 2>&1
```

mkdocs Markdown静态文档服务

官网
 中文版

安装步骤

检查环境

# python 或python3
$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2

# nginx
$ nginx -v     
nginx version: nginx/1.16.1

# 如果没有以上环境，则需要安装：
# pip 按Python版本选择：
yum install python-pip -y
yum install python3-pip -y

# nginx
yum install nginx -y

安装mkdocs：pip install mkdocs

初始化项目：mkdocs new projectName

// 项目结构如下
.
├── docs
│   └── index.md
└── mkdocs.yml

运行项目：mkdocs serve &(在mkdocs.yml所在目录下运行)

配置nginx:

# 编辑配置
vim /etc/nginx/nginx.conf
server {
	listen 81;

	location / {
		proxy_pass http://127.0.0.1:8000/;
		proxy_set_header X-Forwarded-Host $host;
	}
	location /webhook/ {
		proxy_pass http://127.0.0.1:8083/;
		proxy_set_header X-Forwarded-Host $host;
	}
}

// 重启nginx
systemctl restart nginx

访问文档服务：http://10.241.65.78:81

安装主题

内建主题，如RTD

# 在mkdocs.yml中添加以下内容后刷新即可：
theme: readthedocs

其他主题

pip3 install mkdocs-material

# 配置内添加：
theme:
  name: 'material'
  palette:
	primary: "light blue"
	accent: "lime"
  language: "zh"

更多配置参考：mkdocs-material

标签：git,部署,ShowDoc,nginx,proxy,本地,pip,showdoc,mkdocs
来源： https://blog.csdn.net/ic_xcc/article/details/114881519

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

ShowDoc 本地部署