ApacheCN 文档一键部署

部署手册

第一步：检查系统版本

一键部署工具可能不止支持一个系统，但目前只在 CentOS7 上有过部署。

因此这个手册的所有命令都假定是 CentOS7。

执行以下命令来查看是否是 CentOS7：

# cat /etc/centos-release
CentOS Linux release 7.7.1908 (Core)

【如果运维人员在其它系统部署成功，更新这个手册。】

第二步：检查 Python3 和 Git

CentOS7 应该带这两个东西，无需安装。

（自带的 Python3 应该是 3.6，不过没关系，3.6 以及更新版本都可以。）

执行以下命令来查看是否安装：

# python3 --version
Python 3.6.8
# git --version
git version 1.8.3.1

第三步：检查 Docker

先检查是否安装了 Docker，如果有就跳过安装步骤：

# docker --version
Docker version 20.10.6, build 370c289

或者：

# rpm -q docker-ce
docker-ce-20.10.6-3.el7.x86_64

第四步：安装 Docker

如果已安装，可以跳过。

（1）通过脚本

curl -sSL https://get.daocloud.io/docker | sh

（2）通过包管理器

yum install -y yum-utils device-mapper-persistent-data lvm2
yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
yum install docker-ce docker-ce-cli containerd.io

第五步：启动 Docker

启动 Docker 服务：

# systemctl  start docker.service

查看 Docker 服务情况：

# systemctl  status docker.service
● docker.service - Docker Application Container Engine
   Loaded: loaded (/usr/lib/systemd/system/docker.service; enabled; vendor preset: disabled)
   Active: active (running) since Thu 2021-04-29 13:15:32 CST; 8 months 8 days ago
     Docs: https://docs.docker.com
 Main PID: 29885 (dockerd)
    Tasks: 30
   Memory: 182.8M'
...

运行 HelloWorld 容器来校验：

# docker run --rm hello-world
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
2db29710123e: Pull complete
Digest: sha256:2498fce14358aa50ead0cc6c19990fc6ff866ce72aeb5546e1d59caac3d0d60f
Status: Downloaded newer image for hello-world:latest

Hello from Docker!
This message shows that your installation appears to be working correctly.
...

第六步：添加证书（可选）

创建目录：

mkdir -p /data/ssl

将证书文件放在/data/ssl中，一般存在于上一个服务器的相同目录中。

第七步：克隆本仓库

git clone https://github.com/apachecn/one-key-deploy

如果感觉到明显卡顿，可以使用以下镜像：

CNPMJS：https://github.com.cnpmjs.org/apachecn/one-key-deploy
GitClone：https://gitclone.com/github.com/apachecn/one-key-deploy

第八步：安装 Python3 依赖

（注意是pip3）

cd one-key-deploy
pip3 install -r requirements.txt -i http://mirrors.aliyun.com/pypi/simple --trusted-host mirrors.aliyun.com

第九步：一键部署

首先设置是否启用 HTTPS，执行命令打开编辑器：

vi config.json

如果需要启用 HTTPS，确保完成了第六步，并将"conf"的值改为"apachecn-sec"，否则改为"default"，并保存。

执行以下命令来部署文档服务：

nohup python3 deploy.py &

会在目录中生成一个nohup.out，读取它来查看进度：

# cat nohup.out
...
name: wiki, repo: https://github.com.cnpmjs.org/apachecn/team-wiki
name: xgboost, repo: https://github.com.cnpmjs.org/apachecn/xgboost-doc-zh
name: zeppelin, repo: https://github.com.cnpmjs.org/apachecn/zeppelin-doc-zh
name: zetcode, repo: https://github.com.cnpmjs.org/apachecn/zetcode-zh
name: apachecn-doc, repo: nginx, port: 80, secPort: 443
KILL PID: 20416
KILL PID: 20420
KILL CONTAINER: 8b6205e903cb
KILL PID: 20404
KILL PID: 20400
KILL CONTAINER: 8b6205e903cb

第十步：检查服务

除了直接访问https://{ip}:{port}之外，可以通过命令行：

# docker ps -a | grep apachecn-home
3e7dbe4c8b29   nginx     "/docker-entrypoint.…"   22 hours ago   Up 16 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp   apachecn-home

# netstat -tnlp | grep 80
tcp        0      0 0.0.0.0:80              0.0.0.0:*               LISTEN      15363/docker-proxy
tcp        0      0 0.0.0.0:8080            0.0.0.0:*               LISTEN      9569/node
tcp6       0      0 :::80                   :::*                    LISTEN      15367/docker-proxy

如果容器的状态不是Up，执行命令来查看错误信息：

docker logs apachecn-home

【将看到的错误放到搜索引擎中搜索，然后将解决方案写在附录 A 中。】

第十一步：添加定时任务（可选）

添加定时任务的目的是定期重新拉取文档内容，保持最新。

执行crontab -e打开编辑器，插入一行：

0 0 * * * python3 {path}/one-key-deploy/deploy.py doc >> {path}/one-key-deploy/okd.log

其中{path}是该项目的绝对路径。

查看是否添加成功：

# crontab -l
0 0 * * * python3 /usr/local/bin/one-key-deploy/deploy.py doc >> /usr/local/bin/one-key-deploy/okd.log

附录 A：故障排除

（1）unix:///var/run/docker.sock. Is the docker daemon running?.

没有启动 Docker 系统服务，参考第五步。

已占用端口

80：主页 HTTP
443：主页 HTTPS
10080：文档导航站
8080：财务

`config.json`配置项说明

name：主页 Nginx 容器名称
docName：文档 Nginx 容器名称
port：主页 HTTP 端口号
secPort：主页 HTTPS 端口号
docPort：文档 HTTP 端口号（用于转发）
dataDir：主页数据目录
docDataDir：文档数据目录
sslDir：证书目录
conf：主页 Nginx 配置文件名称，在asset/conf/${conf}.conf
docConf：文档 Nginx 配置文件名称，在asset/conf/${conf}.conf
clean：如果为真，每次重新克隆文档仓库
cnzz：CNZZ 统计后台 ID
bdStat：百度统计后台 ID
icp：备案号
title：导航页面标题
menus：导航页面菜单
- name：文本
- link：链接
announce：导航页面公告
- text：文本
- link：链接
members：成员信息
- name：名称，例如飞龙
- desc：描述，例如iBooker组织创始人和ApacheCN文档翻译负责人
- link：链接，例如https://github.com/wizardforcel
- logo：头像，在asset/site_asset/avatar/${logo}.png
links：友情链接
- name：文本
- link：链接
cates：在页面显示的分类，有序
docs：文档列表
- name：目录名称，将保存到${dataDir}/html/${name}
- nameCn：显示名称
- desc：描述
- link：站外文档的链接，如果设定了该属性，优先在导航页显示
- repo：文档的 Git 仓库地址，如果不设定，则不拉取
- cate：类别，注意如果不是cates中的值，则不显示在页面上
- logo：图标，在asset/site_asset/icon/${logo}.png
- hidden：如果为真，则不在页面上显示

OpenDocCN / one-key-deploy

ApacheCN 文档一键部署

部署手册

第一步：检查系统版本

第二步：检查 Python3 和 Git

第三步：检查 Docker

第四步：安装 Docker

第五步：启动 Docker

第六步：添加证书（可选）

第七步：克隆本仓库

第八步：安装 Python3 依赖

第九步：一键部署

第十步：检查服务

第十一步：添加定时任务（可选）

附录 A：故障排除

已占用端口

`config.json`配置项说明

简介

发行版

贡献者

近期动态

OpenDocCN / one-key-deploy .gitee-modal { width: 500px !important; }

ApacheCN 文档一键部署

部署手册

第一步：检查系统版本

第二步：检查 Python3 和 Git

第三步：检查 Docker

第四步：安装 Docker

第五步：启动 Docker

第六步：添加证书（可选）

第七步：克隆本仓库

第八步：安装 Python3 依赖

第九步：一键部署

第十步：检查服务

第十一步：添加定时任务（可选）

附录 A：故障排除

已占用端口

config.json配置项说明

简介

发行版

贡献者

近期动态

搜索帮助

OpenDocCN / one-key-deploy

`config.json`配置项说明