更新文档

2025-11-04 00:10:27 +08:00 · 2023-05-03 22:50:12 +08:00
parent f98485ab45
commit f323136a61
50 changed files with 519 additions and 775 deletions
--- a/docs/use/command-options.md
+++ b/docs/use/command-options.md
@@ -0,0 +1,100 @@
+
+| 名称 | 含义 | 选项值 |
+| :-: | :-: | :-: |
+| `--source` | 指定软件源地址 | 地址 |
+| `--branch` | 指定软件源分支 | 分支名 |
+| `--abroad` | 使用海外软件源 | 无 |
+| `--web-protocol` | 指定 WEB 协议 | http 或 https |
+| `--intranet` | 使用内网地址 | true 或 false |
+| `--install-epel` | 安装 EPEL 附加软件包 | true 或 false |
+| `--close-firewall` | 关闭防火墙 | true 或 false |
+| `--backup` | 备份原有软件源 | true 或 false |
+| `--ignore-backup-tips` | 忽略覆盖备份提示 | 无 |
+| `--updata-software` | 更新软件包 | true 或 false |
+| `--clean-cache` | 清理下载缓存 | true 或 false |
+
+## 示例
+
+### 指定软件源地址
+
+若不想通过交互选择默认提供的软件源，你可以使用该命令选项指定软件源地址
+
+``` bash
+bash <(curl -sSL https://gitee.com/SuperManito/LinuxMirrors/raw/main/ChangeMirrors.sh)
+```
+
+### 指定软件源分支
+
+使用场景：目标软件源有对应系统镜像但是不符合本脚本关于软件源分支设置的默认规则  
+
+本脚本为了适配大环境不会针对某一镜像站独特的镜像分支名称而单独定制，最开始是为了更换国内软件源而设计适配的，默认使用的分支名称如下
+
+<table>
+<tr>
+    <td><a href="https://www.debian.org" target="_blank"><img src="../assets/images/icon/debian.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Debian</td>
+    <td align="center">debian</td>
+</tr>
+<tr>
+    <td><a href="https://cn.ubuntu.com" target="_blank"><img src="../assets/images/icon/ubuntu.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Ubuntu</td>
+    <td align="center">ubuntu</td>
+</tr>
+<tr>
+    <td><a href="https://www.kali.org" target="_blank"><img src="../assets/images/icon/kali.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Kali Linux</td>
+    <td align="center">kali</td>
+</tr>
+<tr>
+    <td><a href="https://access.redhat.com/products/red-hat-enterprise-linux" target="_blank"><img src="../assets/images/icon/redhat.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Red Hat Enterprise Linux</td>
+    <td align="center">centos</td>
+</tr>
+<tr>
+    <td><a href="https://www.centos.org/centos-linux" target="_blank"><img src="../assets/images/icon/centos.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;CentOS</td>
+    <td align="center">centos</td>
+</tr>
+<tr>
+    <td><a href="https://www.centos.org/centos-stream" target="_blank"><img src="../assets/images/icon/centos.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;CentOS Stream</td>
+    <td align="center">centos-stream</td>
+</tr>
+<tr>
+    <td><a href="https://rockylinux.org" target="_blank"><img src="../assets/images/icon/rocky.svg" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Rocky Linux</td>
+    <td align="center">rocky</td>
+</tr>
+<tr>
+    <td><a href="https://fedoraproject.org/zh-Hans" target="_blank"><img src="../assets/images/icon/fedora.ico" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;Fedora</td>
+    <td align="center">fedora</td>
+</tr>
+<tr>
+    <td><a href="https://www.openeuler.org/zh" target="_blank"><img src="../assets/images/icon/openeuler.ico" width="16" height="16" style="vertical-align: -0.15em"/></a>&nbsp;openEuler</td>
+    <td align="center">openeuler</td>
+</tr>
+<tr>
+    <td><a href="https://www.opensuse.org" target="_blank"><img src="../assets/images/icon/opensuse.svg" width="16" height="16" style="vertical-align: -0.25em"/></a>&nbsp;openSUSE</td>
+    <td align="center">opensuse</td>
+</tr>
+</table>
+
+请看下面的例子
+
+``` sh title="使用阿里云的 Rocky Linux 软件源" linenums="1"
+bash ChangeMirrors.sh \
+  --source mirrors.aliyun.com \
+  --branch rockylinux
+```
+
+阿里云镜像站的 Rocky Linux 镜像分支名称为 [`rockylinux`](https://mirrors.aliyun.com/rockylinux)，不符合默认规则，但是可以通过命令选项绕过脚本默认规则来实现
+
+## 无人值守
+
+不通过交互完成换源操作，需要使用大量命令选项来实现，建议熟悉后再使用
+
+``` sh title="参考命令" linenums="1"
+bash ChangeMirrors.sh \
+  --source <软件源域名> \
+  --web-protocol <http/https> \
+  --intranet false \
+  --install-epel true \
+  --close-firewall true \
+  --backup true \
+  --updata-software false \
+  --clean-cache false \
+  --ignore-backup-tips
+```
--- a/docs/use/execution-flow.md
+++ b/docs/use/execution-flow.md
@@ -0,0 +1,10 @@
+  - 选择软件源 `交互`
+    - 检测到存在对应内网地址选择是否切换 `交互`
+  - 选择软件源使用的 WEB 协议 `交互`
+  - 检测如果是 RHEL/CentOS/Rocky 系统选择是否安装/覆盖 EPEL 扩展包软件源 `交互`
+  - 检测防火墙和SELINUX如果开启选择是否关闭 `交互`
+  - 备份原有源
+    - 检测如果存在重复的备份文件选择是否覆盖 `交互`
+  - 更换软件源
+  - 选择是否更新软件包 `交互`
+    - 选择是否清理已下载的软件包缓存 `交互`
--- a/docs/use/main.md
+++ b/docs/use/main.md
@@ -0,0 +1,21 @@
+## 主要命令
+
+=== "国内使用（默认）"
+
+    ``` bash
+    bash <(curl -sSL https://gitee.com/SuperManito/LinuxMirrors/raw/main/ChangeMirrors.sh)
+    ```
+
+=== "海外使用"
+
+    ``` bash
+    bash <(curl -sSL https://gitee.com/SuperManito/LinuxMirrors/raw/main/ChangeMirrors.sh) --abroad
+    ```
+
+## 注意事项
+
+- 完整复制上面的命令到终端按回车键即可执行，若无法安装 `curl` 软件包可复制源码到本地后通过 `bash` 手动执行  
+- 为了适配所有环境，需要使用 `Root` 用户执行脚本，切换命令为 `su root`，如遇报错请查看常见问题与帮助  
+- 如果您使用的环境没有安装或不支持简体中文环境，请通过 `SSH客户端工具` 使用，否则将无法正确选择交互内容  
+- 执行脚本过程中会自动备份原有源无需手动备份，期间会在终端输出多个主观选择交互内容，可按回车键快速确定  
+- 脚本支持在原有源配置错误或者不存在的情况下使用，并且可以重复使用；脚本变更的软件源默认使用 `HTTP` 协议
--- a/docs/use/not-enabled.md
+++ b/docs/use/not-enabled.md
@@ -0,0 +1,22 @@
+=== "Debian"
+
+    默认禁用了源码仓库和预发布软件源，若需启用请将 `/etc/apt/sources.list` 文件中相关内容的所在行取消注释
+
+    `Debian`  
+    `Ubuntu`  
+    `Kali`
+
+=== "RedHat/openEuler"
+
+    部分仓库默认没有启用，若需启用请将 `/etc/yum.repos.d` 目录下相关 repo 文件中的 `enabled` 值修改为 `1`
+
+    `Red Hat Enterprise Linux`  
+    `CentOS`  
+    `Rocky Linux`  
+    `Fedora`  
+    `openEuler`
+
+=== "openSUSE"
+
+    部分仓库默认没有启用，若需启用请将 `/etc/zypp/repos.d` 目录下相关 repo 文件中的 `enabled` 值修改为 `1`
+