feat: add README

src/frps/README.md

@@ -0,0 +1,57 @@
+# FRPS (Intranet Penetration Server)
+
+[English](./README.md) | [中文](./README.zh.md)
+
+This is an FRPS (Intranet Penetration Server) service.
+
+## Example
+
+Create a new `frps.toml` configuration file with the following content:
+
+```toml
+bindPort = {{ .Envs.FRP_SERVER_PORT }}
+auth.token = "{{ .Envs.FRP_SERVER_TOKEN }}"
+
+webServer.addr = "0.0.0.0"
+webServer.port = {{ .Envs.FRP_ADMIN_PORT }}
+webServer.user = "{{ .Envs.FRP_ADMIN_USER }}"
+webServer.password = "{{ .Envs.FRP_ADMIN_PASS }}"
+```
+
+Configure secrets and other information in the `.env` file:
+
+```properties
+FRP_SERVER_TOKEN=token
+FRP_ADMIN_USER=admin
+FRP_ADMIN_PASS=password
+```
+
+Start the service to proxy client requests. Note that you need to map the client's port. You can share the service through HOST network or shared network.
+
+To enable HOST mode, use the following method:
+
+```yaml
+services:
+  frps:
+    # ...
+    network_mode: host
+```
+
+## Services
+
+- `frps`: The FRPS server service.
+
+## Configuration
+
+- `FRPS_VERSION`: The version of the FRPS image, default is `0.64.0`.
+- `FRP_SERVER_PORT`: The port for the FRPS server, default is `9870`.
+- `FRP_ADMIN_PORT`: The port for the FRPS admin dashboard, default is `7890`.
+- `FRP_PORT_OVERRIDE_SERVER`: The host port to map to the FRPS server port.
+- `FRP_PORT_OVERRIDE_ADMIN`: The host port to map to the FRPS admin port.
+- `FRP_SERVER_TOKEN`: The token for authenticating clients.
+- `FRP_ADMIN_USER`: The username for the admin dashboard, default is `admin`.
+- `FRP_ADMIN_PASS`: The password for the admin dashboard, default is `password`.
+
+## Volumes
+
+- `frps.toml`: The configuration file for FRPS.

src/frps/README.zh.md

@@ -1,18 +1,21 @@
-# FRPS
+# FRPS (内网穿透服务端)
 
-内网穿透服务端。
+[English](./README.md) | [中文](./README.zh.md)
+
+这是一个 FRPS（内网穿透服务端）服务。
+
+## 示例
 
 新建 `frps.toml` 配置文件，内容如下：
 
 ```toml
-[common]
-bind_port = {{ .Envs.FRP_SERVER_PORT }}
-token     = {{ .Envs.FRP_SERVER_TOKEN }}
+bindPort = {{ .Envs.FRP_SERVER_PORT }}
+auth.token = "{{ .Envs.FRP_SERVER_TOKEN }}"
 
-dashboard_addr = 0.0.0.0
-dashboard_port = {{ .Envs.FRP_ADMIN_PORT }}
-dashboard_user = {{ .Envs.FRP_ADMIN_USER }}
-dashboard_pwd  = {{ .Envs.FRP_ADMIN_PASS }}
+webServer.addr = "0.0.0.0"
+webServer.port = {{ .Envs.FRP_ADMIN_PORT }}
+webServer.user = "{{ .Envs.FRP_ADMIN_USER }}"
+webServer.password = "{{ .Envs.FRP_ADMIN_PASS }}"
 ```
 
 配置密钥等信息到 `.env` 文件中：
@@ -33,3 +36,22 @@ services:
     # ...
     network_mode: host
 ```
+
+## 服务
+
+- `frps`: FRPS 服务端服务。
+
+## 配置
+
+- `FRPS_VERSION`: FRPS 镜像的版本，默认为 `0.64.0`。
+- `FRP_SERVER_PORT`: FRPS 服务端口，默认为 `9870`。
+- `FRP_ADMIN_PORT`: FRPS 管理面板端口，默认为 `7890`。
+- `FRP_PORT_OVERRIDE_SERVER`: 映射到 FRPS 服务端口的主机端口。
+- `FRP_PORT_OVERRIDE_ADMIN`: 映射到 FRPS 管理面板端口的主机端口。
+- `FRP_SERVER_TOKEN`: 用于认证客户端的令牌。
+- `FRP_ADMIN_USER`: 管理面板的用户名，默认为 `admin`。
+- `FRP_ADMIN_PASS`: 管理面板的密码，默认为 `password`。
+
+## 卷
+
+- `frps.toml`: FRPS 的配置文件。