diff --git a/README.md b/README.md index 84fc960b..47fbbfa8 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple ### 安装 ```shell -pip install mkdocs-material +pip install -r requirements.txt ``` ### 预览修改 diff --git a/docs/client/index.md b/docs/client/index.md index f27e213b..48440d6d 100644 --- a/docs/client/index.md +++ b/docs/client/index.md @@ -9,7 +9,7 @@ hide: [Yacd](http://yacd.metacubex.one) -[Dashboard](http://clash.metacubex.one) +[Metacubexd](http://d.metacubex.one) *** diff --git a/docs/config/listeners.md b/docs/config/listeners.md index da9492e1..a74265ad 100644 --- a/docs/config/listeners.md +++ b/docs/config/listeners.md @@ -147,7 +147,7 @@ listeners: ``` !!! note - proxy 如果不为空,则将该入站流量交由指定[proxy](../proxies/)处理 + proxy 如果不为空,则将该入站流量交由指定[proxy](proxies/index.md)处理 rule 如果定义的 [子规则 (sub-rule)](./rules/sub-rule.md)不存在 则直接使用 rules diff --git a/docs/index.md b/docs/index.md index 83853c77..d3e5a3b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- hide: - - navigation + # - navigation - toc --- # 简介 @@ -19,9 +19,9 @@ hide: *** -### Clash.Meta 主要特性 +# Clash.Meta 主要特性 -#### **代理模块:** +## **代理模块:** * 支持出站传输协议 VLESS Reality, Vision 流控 * 支持出站传输协议 Trojan XTLS @@ -36,7 +36,7 @@ hide: * Relay 代理链支持 UDP over TCP * TCP 连接并发 -#### 规则模块 +## 规则模块 * 支持规则 GEOSITE * 支持入站类型规则 IN-TYPE @@ -52,7 +52,7 @@ hide: * 支持 GeoSite 按需加载 * 支持使用 `geox-url` 自定义的 GEOIP / GEOSITE 数据库下载地址 -#### DNS 模块 +## DNS 模块 * 支持 Sniffer 域名嗅探器 * 支持 Fallback-Filter 使用 Geosite @@ -62,7 +62,7 @@ hide: * 支持 DNS over HTTP/3 * 支持 DNS over QUIC -#### TUN 模块 +## TUN 模块 * 支持 macOS、Linux 和 Windows * 内置 iptables, 无需手动配置 diff --git a/docs/startup/faq/index.md b/docs/startup/faq/index.md new file mode 100644 index 00000000..11e7e6bc --- /dev/null +++ b/docs/startup/faq/index.md @@ -0,0 +1,28 @@ +--- +hide: + # - navigation + - toc +--- + +# 常见问题 + +### alpha 和 meta 分支的区别 + +alpha 分支为最新提交分支,meta 分支每隔一段时间合并 alpha 分支的代码,meta 分支不一定比 alpha 分支更稳定。 + +### 我应该下载哪一个文件? + +release 中,包的文件名中包含了多个信息,包括 + +- 程序名称(clash.meta) +- 操作系统(如 android、darwin、freebsd、linux、windows 等) +- 架构(如 386、amd64、arm32v7、arm64 等) +- 编译方式 + > - `默认(无额外标识)`: 使用 GOAMD64=v3 标签编译的默认版本。👉[在此了解](https://github.com/golang/go/wiki/MinimumRequirements#amd64)更多关于 GOAMD64 标签的信息。 + > - `cgo`: 使用 GOAMD64=v1 标签进行编译。该版本具有与默认版本不同的功能和特性,包括支持 lwip tun 堆栈。 + > - `compatible`: 使用 GOAMD64=v1 标签进行编译。该版本是为了兼容特定的操作系统或架构而编译的。 +- 分支(alpha) +- 提交的 git hash 值(如 f90066f) + +可以根据这些信息或使用 `uname -m` 检查设备的 CPU 架构, 并在发布页面中找到相应的版本的可执行文件。 + diff --git a/docs/startup/service/index.md b/docs/startup/service/index.md new file mode 100644 index 00000000..650a2486 --- /dev/null +++ b/docs/startup/service/index.md @@ -0,0 +1,79 @@ +--- +hide: + # - navigation + - toc +--- + +# Clash 服务运行 + +## 使用 systemd + +- 创建名为 `clash-meta` 的用户 + +- 下载二进制可执行文件 [releases](https://github.com/MetaCubeX/Clash.Meta/releases) + +- 将下载的二进制可执行文件重名名为 `Clash-Meta` 并移动到 `/usr/local/bin/` + +- 以守护进程的方式,由用户 `clash-meta` 运行 Clash-Meta。 + +使用以下命令将 Clash 二进制文件复制到 /usr/local/bin, 配置文件复制到 /etc/Clash-Meta: + +```shell +cp Clash-Meta /usr/local/bin +cp config.yaml /etc/Clash-Meta +``` + +创建 systemd 配置文件 `/etc/systemd/system/Clash-Meta.service`: + +```ini +[Unit] +Description=Clash-Meta Daemon, Another Clash Kernel. +After=network.target NetworkManager.service systemd-networkd.service iwd.service + +[Service] +Type=simple +User=clash-meta +Group=clash-meta +LimitNPROC=500 +LimitNOFILE=1000000 +CapabilityBoundingSet=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE +AmbientCapabilities=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE +Restart=always +ExecStartPre=/usr/bin/sleep 1s +ExecStart=/usr/local/bin/Clash-Meta -d /etc/Clash-Meta +ExecReload=/bin/kill -HUP $MAINPID + +[Install] +WantedBy=multi-user.target +``` + +使用以下命令重新加载 systemd: + +```shell +systemctl daemon-reload +``` + +启用 clash-meta 服务: + +```shell +systemctl enable Clash-Meta +``` + +使用以下命令立即启动 Clash: + +```shell +systemctl start Clash-Meta +``` + +使用以下命令使 Clash-Meta 重新加载: + +```shell +systemctl reload Clash-Meta +``` + +使用以下命令检查 Clash 的运行状况和日志: + +```shell +systemctl status clash +journalctl -xe +``` diff --git a/mkdocs.yml b/mkdocs.yml index cb93ba99..30bf9899 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,6 +3,7 @@ repo_url: https://github.com/MetaCubeX/Clash.Meta repo_name: MetaCubeX/Clash.Meta copyright: Copyright © 2023 Clash.Meta edit_uri: "https://github.com/MetaCubeX/Meta-Docs/blob/main/docs/" +dev_addr: '127.0.0.1:11451' extra: generator: false analytics: @@ -77,7 +78,10 @@ markdown_extensions: format: !!python/name:pymdownx.superfences.fence_code_format nav: - - 简介: index.md + - 简介: + - index.md + - startup/service/index.md + - startup/faq/index.md - 支持 Clash.Meta 的工具: client/index.md - 配置示例: example/index.md - 配置详解: diff --git a/requirements.txt b/requirements.txt index bbcf2789..43af7035 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ -mkdocs-git-revision-date-localized-plugin==1.2.0 +mkdocs-material +mkdocs-git-revision-date-localized-plugin==1.2.0 \ No newline at end of file