如何编写软件的使用教程？

本文以群晖实体机安装 mysql、有度即时通的 docker 镜像为例，叙述一下如何利用随身笔记编写软件使用教程。
----------------------------------------------------------------------------------------------------

一、准备工作

1. 电脑
2. mysql、有度即时通的 docker
3. 一定的电脑软件操作经验
4. 一定的时间，有 liux 系统的操作经验，会截图
   二、mysql 的 docker 安装
   
   1.打开随身笔记页面，新建文档
   2.在顶端工具栏，点击编辑器下拉菜单，选择 vditor 编辑器。
   3.打开群晖登陆页面，点击 docker 工具进入。
   （可以在浏览器中使用截图工具，将页面截图，在随身笔记中新建页面内直接粘贴，系统将会将剪切板中的图像自动下载保存到系统中，以 png 的格式保存在 media 的目录下，并将图像在右侧的预览栏中显示。）
   ![](/media/202309/2023-09-15_084717_9229990.5290067582642773.png)
   
   4.在 docker 工具左侧导航栏里点击映像。
   （方法同上，注意的是在浏览器中截图时选择将图像保存在剪切板中；如果选择保存在某个文件中，则需要插入图像的地方点击编辑器工具栏中的图像按钮，将保存的图像文件上传到服务器。具体操作请参照官方的操作手册）
   ![](/media/202309/2023-09-15_084843_1442900.05831760944505515.png)
   5.在右侧的映像中找 mysql：latest，双击启动容器
   
   ![](/media/202309/2023-09-15_123416_6659200.08382424421964585.png)
   
   6.选择使用网络，建议采用 bridge 网络即可，然后点击下一步；
   
   ![](/media/202309/2023-09-15_123528_0448430.2587905285718465.png)
   
   7.按照图示的选择，启动资源限制，一般 mysql 数据库对资源要求不高，按照自己服务器的配置选择，可以选择低的，内存按照自己实际配置选择即可。然后点击高级设置。
   
   ![](/media/202309/2023-09-15_123706_7539280.9234990834596658.png)
   
   8.环境设置，系统中只带了 4 个，还需要增加，请按图后的文字对照输入即可，然后点击保存即可。
   
   ![](/media/202309/2023-09-15_124325_2958130.03703502000681158.png)

```
变量名                           值
GOSU_VERSION      1.12
MYSQL_MAJOR       5.7
MYSQL_ROOT_PASSWORD    Youdu123456
MYSQL_VERSION    5.7.36-1Debian10
PATH                         /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
TZ                             Asia/Shanghai
```

其中第三个选项最关键，是设置数据库的访问密码，可以设置成自己需要的密码，并遵循 mysql 数据库的密码规则。
完成后，点击保存。

9.在端口设置时，可以按照默认的选择，一般服务器上运行不是一个程序，3306 很可能被占用，所以建议选择 33060，删除 3306 端口，将本地端口设置为 33060，也可以设置成其他端口。
我的服务器设置如下：
docker 端口：容器端口 3306， nas 端口 3306，TCP
10.设置完成后点击下一步，到映射文件夹界面；

![](/media/202309/2023-09-15_124008_9881160.9303164969238537.png)
我的服务器设置如下，文件夹可以根据自己实际情况设置，最好在进入容器界面前在系统内将文件夹添加好，权限全部设为 777，容器映射文件夹名建议照搬：
文件夹                       容器映射文件夹名
/opt/mysql/data        /var/lib/mysql
/opt/mysql/config     /etc/mysql/conf.d
10.命令行

`docker-entrypoint.sh`

11.大功告成，点击完成启动容器，mysql 容器启动！

![](/media/202309/2023-09-15_124943_3069060.937980142819496.png)

三 有度即时通的 docker 安装

1. 首先在仓库获取有度即时通的 docker，也就是图中的第四个镜像。
   
   ![](/media/202309/2023-09-15_125156_4102360.44404373558033705.png)

2.轻车熟路，有上一个 mysql 镜像安装的经验，按图示操作即可，然后点击高级设置。

![](/media/202309/2023-09-15_125342_9294600.35089841351098117.png)

3.环境设置中按照图示操作即可。

![](/media/202309/2023-09-15_125435_1499720.7580493616481153.png)
需要注意的有亮点，第一是在 MYSQL_ADDR 中的端口号要与 MySQL 镜像中设置的密码一致。第二是在 MYSQL_PWD 的密码与 MySQL 镜像中设置的值一致即可。

4.参照 MySQL 的端口设置，有度的端口设置建议见下文：
0.0.0.0:7003 7003/tcp

0.0.0.0:7006 7006/tcp

0.0.0.0:7021 7021/udp

0.0.0.0:7080 7080/tcp

0.0.0.0:7443 7443/tcp

![](/media/202309/2023-09-15_125926_2090120.2334303488994538.png)

5.重启策略：自动重启选项后打勾即可。
6.映射文件夹，请在服务器的文件夹内事先新建youdu文件夹，并将权限调整为 777，按照下图设置即可。

![](/media/202309/2023-09-15_135200_5525390.4441458245659501.png)

7.链接 MySQL 容器后，就可以启动容器了。

![](/media/202309/2023-09-15_135237_8492230.9061391022543649.png)

8.有度即时通本地访问：
`http://SERVER_IP:7080/userportal/`

![](/media/202309/2023-09-15_135345_2696830.8558750857746412.png)
9.设置超级用户名和密码即可进入有度即时通的系统了。