docs: update README.md

2026-03-01 04:49:44 +08:00 · 2026-01-26 13:24:13 +08:00
parent 6e5c64f2e4
commit 5edcaeb1c9
3 changed files with 138 additions and 18 deletions
--- a/.github/workflows/build_publish.yml
+++ b/.github/workflows/build_publish.yml
@@ -313,7 +313,20 @@ jobs:
      - name: Generate Index Page
        run: |
          sudo apt-get install -y pandoc
-          pandoc README.md -o output/index.html --metadata title="FRP Packages" -s
+          GITHUB_LINE="\n\n[![GitHub](https://github.githubassets.com/favicons/favicon.svg)](https://github.com/awfufu/frp-pkgs) [GitHub](https://github.com/awfufu/frp-pkgs)"
+          
+          # English Version (Index)
+
+          sed '1d' README.md | sed "s|\[简体中文\](README_cn.md)|[简体中文](cn.html)$GITHUB_LINE|" > README_temp.md
+          pandoc README_temp.md -o output/index.html --metadata title="frp packages" -s
+          
+          # Chinese Version
+
+          sed '1d' README_cn.md | sed "s|简体中文|简体中文$GITHUB_LINE|" | sed 's|\[English\](README.md)|[English](index.html)|' > README_cn_temp.md
+          pandoc README_cn_temp.md -o output/cn.html --metadata title="frp packages" -s
+          
+          # Clean up
+          rm README_temp.md README_cn_temp.md

      - name: Deploy to Cloudflare Pages
        uses: cloudflare/pages-action@v1
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
-# FRP RPM Packages for Fedora
+# [frp packages](https://github.com/awfufu/frp-pkgs)

-Auto RPM build for [fatedier/frp](https://github.com/fatedier/frp) (Fast Reverse Proxy), tracking the official releases.
+English | [简体中文](README_cn.md)
+
+Auto package build for [fatedier/frp](https://github.com/fatedier/frp), tracking the official releases.
+
+![Build Status](https://github.com/awfufu/frp-pkgs/actions/workflows/build_publish.yml/badge.svg)

 ### Installation

 #### RHEL / Fedora

-Add the repository to your system to receive automatic updates.
-
 ```bash
 # Add repository
 sudo dnf config-manager addrepo --from-repofile=https://go-frp.awfufu.com/go-frp.repo
@@ -22,15 +24,13 @@ sudo dnf install frpc frps

 #### Debian / Ubuntu

-Add the repository to known lists.
-
 ```bash
 # 1. Download and add GPG key
 sudo mkdir -p /etc/apt/keyrings
 curl -fsSL https://go-frp.awfufu.com/public.gpg | sudo gpg --dearmor -o /etc/apt/keyrings/go-frp.gpg

 # 2. Add repository
-echo "deb [signed-by=/etc/apt/keyrings/go-frp.gpg] https://go-frp.awfufu.com stable main" | sudo tee /etc/apt/sources.list.d/go-frp.list
+echo "deb [arch=amd64,arm64 signed-by=/etc/apt/keyrings/go-frp.gpg] https://go-frp.awfufu.com stable main" | sudo tee /etc/apt/sources.list.d/go-frp.list

 # 3. Update and install
 sudo apt update
@@ -41,15 +41,16 @@ sudo apt install frpc frps

 #### Client (frpc)

-1. Configuration: Edit the configuration file:
+1. Configuration

 ```bash
+# Edit the configuration file
 sudo vim /etc/frpc/frpc.toml
 ```

 *For multiple instances, you can create separate config files like `/etc/frpc/my-proxy.toml`.*

-2. Start Service:
+2. Start Service

 ```bash
 # If using default /etc/frpc/frpc.toml:
@@ -59,7 +60,7 @@ sudo systemctl enable --now frpc@frpc
 sudo systemctl enable --now frpc@my-proxy
 ```

-3. Check Status:
+3. Check Status

 ```bash
 systemctl status frpc@frpc
@@ -67,16 +68,27 @@ systemctl status frpc@frpc

 #### Server (frps)

-1. Configuration: Edit `/etc/frpc/frps.toml`.
-2. Start Service:
+1. Configuration
+
+```bash
+# Edit the configuration file
+sudo vim /etc/frps/frps.toml
+```
+
+2. Start Service

 ```bash
 sudo systemctl enable --now frps@frps
 ```

-### Build Status
+### Notes

-| Type | Status |
-|------|--------|
-| RPM  | ![Build Status](https://github.com/awfufu/frp-pkgs/actions/workflows/build_rpm.yml/badge.svg) |
-| DEB  | ![Build Status](https://github.com/awfufu/frp-pkgs/actions/workflows/build_deb.yml/badge.svg) |
+- This repository uses [GitHub Actions](https://github.com/awfufu/frp-pkgs/actions) to automatically build RPM and DEB packages for [fatedier/frp](https://github.com/fatedier/frp), and automatically uploads them to the static page [go-frp.awfufu.com](https://go-frp.awfufu.com) hosted by Cloudflare.
+
+- This repository is not officially maintained by [fatedier/frp](https://github.com/fatedier/frp); it only provide automatically built packages. If you encounter any issues, please go to the official repository to submit an Issue.
+
+- After installing the package, to prevent tampering, it is recommended to manually verify the hash of the executable file and compare it with the [official](https://github.com/fatedier/frp/releases) one.
+
+```bash
+sha256sum /usr/bin/frpc /usr/bin/frps
+```
--- a/README_cn.md
+++ b/README_cn.md
@@ -0,0 +1,95 @@
+# [frp packages](https://github.com/awfufu/frp-pkgs)
+
+[English](README.md) | 简体中文
+
+为 [fatedier/frp](https://github.com/fatedier/frp) 自动构建的软件包，紧跟官方发布版本。
+
+![Build Status](https://github.com/awfufu/frp-pkgs/actions/workflows/build_publish.yml/badge.svg)
+
+### 安装
+
+#### RHEL / Fedora
+
+```bash
+# 添加仓库
+sudo dnf config-manager addrepo --from-repofile=https://go-frp.awfufu.com/go-frp.repo
+
+# 对于旧版本 dnf
+# sudo dnf config-manager --add-repo https://go-frp.awfufu.com/go-frp.repo
+
+# 更新并安装
+sudo dnf update
+sudo dnf install frpc frps
+```
+
+#### Debian / Ubuntu
+
+```bash
+# 1. 下载并添加 GPG 密钥
+sudo mkdir -p /etc/apt/keyrings
+curl -fsSL https://go-frp.awfufu.com/public.gpg | sudo gpg --dearmor -o /etc/apt/keyrings/go-frp.gpg
+
+# 2. 添加仓库
+echo "deb [arch=amd64,arm64 signed-by=/etc/apt/keyrings/go-frp.gpg] https://go-frp.awfufu.com stable main" | sudo tee /etc/apt/sources.list.d/go-frp.list
+
+# 3. 更新并安装
+sudo apt update
+sudo apt install frpc frps
+```
+
+### 用法
+
+#### 客户端 (frpc)
+
+1. 配置
+
+```bash
+# 编辑配置文件
+sudo vim /etc/frpc/frpc.toml
+```
+
+*对于多个实例，您可以创建单独的配置文件，例如 `/etc/frpc/my-proxy.toml`。*
+
+2. 启动服务
+
+```bash
+# 如果使用默认的 /etc/frpc/frpc.toml：
+sudo systemctl enable --now frpc@frpc
+
+# 如果使用 /etc/frpc/my-proxy.toml：
+sudo systemctl enable --now frpc@my-proxy
+```
+
+3. 查看状态
+
+```bash
+systemctl status frpc@frpc
+```
+
+#### 服务端 (frps)
+
+1. 配置
+
+```bash
+# 编辑配置文件
+sudo vim /etc/frps/frps.toml
+```
+
+2. 启动服务
+
+```bash
+sudo systemctl enable --now frps@frps
+```
+
+### 使用说明
+
+- 本仓库使用 [GitHub Actions](https://github.com/awfufu/frp-pkgs/actions) 自动构建 [fatedier/frp](https://github.com/fatedier/frp) 的 RPM 和 DEB 软件包，并自动上传到由 Cloudflare 托管的静态页面 [go-frp.awfufu.com](https://go-frp.awfufu.com)。
+
+- 本仓库不由 [fatedier/frp](https://github.com/fatedier/frp) 官方维护，仅提供自动打包的软件包。如果您遇到任何问题，请前往官方仓库提交 Issue。
+
+- 安装软件包后，为了防止篡改，建议手动校验可执行文件的哈希值，并与[官方](https://github.com/fatedier/frp/releases)比对。
+
+```bash
+sha256sum /usr/bin/frpc /usr/bin/frps
+```
+