华为云云服务器评测｜使用Portainer部署showdoc文档工具

一、前言

1.1 云耀云服务器L实例简介

云耀云服务器L实例是新一代的轻量应用云服务器，专门为中小企业和开发者打造，提供开箱即用的便利性。云耀云服务器L实例提供丰富且经过严格挑选的应用镜像，可以一键部署应用，极大地简化了客户在云端构建电商网站、Web应用、小程序、学习环境以及各类开发测试等任务的过程。

1.2 showdoc工具简介

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。

1.3 Portainer工具简介

Portainer是一个轻量级的Docker管理工具，可以通过Web界面管理单个Docker主机或Swarm集群。它提供了一个直观的用户界面，方便用户管理Docker容器、镜像、网络和卷等资源。Portainer还支持对容器的访问、终止、日志查看和容器控制台访问。同时，Portainer还提供了一些高级功能，如用户和团队管理、LDAP认证、多主机管理等。总之，Portainer的出现为Docker的管理提供了一个简单、易用、集成化的解决方案。

二、本次实践介绍

2.1 本次实践简介

1.本次实践为个人测试学习环境，旨在快速部署应用，生产环境请谨慎；
2.本次实践环境为云耀云服务器L实例；
3.本次使用云耀云服务器L实例的应用镜像为Portainer 2.18.4；
4.本次实践前提为已购买云耀云服务器L实例和Portainer已初始化配置完成；
5.在Portainer平台上部署showdoc文档工具；

2.2 本次环境规划

服务器类别	内网IP地址	Docker版本	Portainer版本	showdoc版本
云耀云服务器L实例	192.168.0.168	24.0.4	2.18.4	开源版showdoc v3.2.2

三、远程连接服务器

3.1 检查云耀云服务器L实例状态

• 检查云耀云服务器L实例状态

• 复制弹性公网IP地址

3.2 远程登录服务器

点击远程登录，使用本地控制台登录。

3.3 Xshell工具连接服务器

在Xshell工具中，填写服务器弹性公网IP地址、账号密码信息，ssh连接远程服务器。

3.4 检查操作系统版本

• 检查操作系统版本，使用的ubuntu操作系统。

root@hcss-ecs-f91c:~# cat /etc/os-release
PRETTY_NAME="Ubuntu 22.04.1 LTS"
NAME="Ubuntu"
VERSION_ID="22.04"
VERSION="22.04.1 LTS (Jammy Jellyfish)"
VERSION_CODENAME=jammy
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=jammy

• 检查系统内核版本

root@hcss-ecs-f91c:~# uname -r
5.15.0-60-generic

3.5 检查Docker环境

• 检查Docker版本

root@hcss-ecs-f91c:~# docker -v
Docker version 24.0.4, build 3713ee1

• 检查Docker服务状态

root@hcss-ecs-f91c:~# systemctl status docker
● docker.service - Docker Application Container Engine
     Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
     Active: active (running) since Tue 2023-09-05 21:51:04 CST; 13h ago
TriggeredBy: ● docker.socket
       Docs: https://docs.docker.com
   Main PID: 1061 (dockerd)
      Tasks: 73
     Memory: 187.2M
        CPU: 33.285s
     CGroup: /system.slice/docker.service

• 检查Docker compose版本

root@hcss-ecs-f91c:~# docker compose version
Docker Compose version v2.19.1

四、部署showdoc文档工具

4.1 创建挂载目录

• 创建挂载目录

 mkdir -p /data/showdoc/html

• 目录授权

chmod -R 777 /data/showdoc/html

4.2 登录Portainer

登录云耀云服务器L实例使用Portainer应用镜像自动为我们安装的Portainer，访问地址http://弹性公网IP地址:9091。

4.3 编辑docker-compose.yaml文件

• 进入stacks管理页面，添加stack。

• 将下面的docker-compose.yaml文件复制到编辑器中。

version: '3'
services:
  showdoc:
    image: star7th/showdoc
    container_name: showdoc
    restart: always
    user: root
    privileged: true
    ports:
      - "4999:80"
    volumes:
      - "/data/showdoc/html:/var/www/html/"
    deploy: 
      resources:
        limits:
          cpus: '2'
          memory: 2G
        reservations:
          cpus: '1'
          memory: 1G

4.4 开始部署showdoc

点击部署选项，开始部署showdoc。

4.5 查看容器状态

• 查看stacks状态

• 在命令行终端查看容器状态

root@hcss-ecs-f91c:~# docker ps
CONTAINER ID   IMAGE                           COMMAND                  CREATED              STATUS              PORTS                             NAMES
d7031080e08f   star7th/showdoc                 "/entrypoint bash do…"   About a minute ago   Up About a minute   443/tcp, 9000/tcp, 0.0.0.0:4999->80/tcp, :::4999->80/tcp                             showdoc

五、showdoc初始化配置

5.1 安全组端口配置

showdoc服务对外访问的映射端口为4999，放行安全组入方向端口4999。

5.2 进入showdoc初始化配置页

访问地址：http://弹性公网IP地址:4999
将IP地址替换为自己服务器的弹性公网IP地址。

5.3 设置系统语言

选择语言为中文

5.4 进入showdoc首页

点击进入首页，自动跳转到showdoc首页。

六、showdoc的基本使用

6.1 登录showdoc

点击登录选项，默认账号密码showdoc/123456

6.2 访问管理后台

点击管理后台，进入后台管理页面。

6.3 创建新项目

点击“创建新项目”，输入项目名称等信息。

6.4 新建文档

• 点击刚才新建的项目“my-project”

• 新建目录

• 选择添加页面

• 编辑文档标题和文档内容，这里将自己刚写完的博文复制到文本编辑器中，在右侧可以看到预览效果，保存文档即可。

6.5 查看文档内容

查看刚才编辑的文档内容

6.6 文档分享

选择文档分享，将分享链接复制到浏览器打开即可。

七、总结

本次实践《华为云云服务器评测｜使用Portainer工具部署showdoc文档工具》成功完成，在部署过程中，操作流畅，无任何卡顿现象，需要注意的是要放行安全组的服务端口，以及检查应用容器是否正常启动。整体使用体验良好，云耀云服务器L实例对于个人来说真是一个可靠有用的好帮手！