frpc管理工具frpm

背景#

NOTE
你可以跳过这些废话，直接前往具体实现

这个可爱的小工具是我去年运维的时候~~vibe~~写的，今天更新frpc配置的时候挖出来了，~~正好水一篇博客~~

至于为什么没有使用素质更高的toml而是ini，是因为我用的那台机器上装的是旧版frpc，而新版也兼容ini，~~其实就是懒得再写一份~~

为什么需要frpm#

一般情况下，frpc的使用不会有太大问题，因为一般情况下使用者只会有一台服务器用作frps，同时只有少数几个代理，配置大致如下：

1
# 云服务器配置
2
[common]
3
server_addr = 1.1.1.1
4
server_port = 7000
5
token = token_to_auth
6

7
# 代理1
8
[proxy1]
9
type = tcp
10
local_ip = 192.168.1.2
11
local_port = 22
12
remote_port = 12345
13

14
# 代理2
15
[proxy2]
16
type = tcp
17
local_ip = 192.168.1.3
18
local_port = 22
19
remote_port = 12346

但是假如你同时有多个云服务器做frps，他们的addr、port、token各不相同，同时你还有很多很多代理要接入很多主机，那么你的配置文件会变成云服务器数量个除了云服务器配置部分之外完全相同，而且内容极其繁杂的大坨配置文件

1
# placeholder
2
[common]
3
server_addr = n.n.n.n
4
server_port = 7000
5
token = token_n
6

7

8
[proxy1]
9
type = tcp
10
local_ip = 192.168.1.2
11
local_port = 22
12
remote_port = 12345
13
...

很显然，这是非常蠢的，把配置文件拆开是刚需

实现思路#

配置文件要拆是很好拆的，无非把云服务器的配置部分拆成一个文件，把代理按照特定的范围比如主机拆分成多个独立文件，问题是怎么拼起来

~~frpc:搞半天还要自己拼.jpg~~

环境变量渲染配置#

frpc作为用go写的程序，在读配置的时候能使用go自带的配置渲染

同时这个配置渲染使用的变量可以是环境变量，这就给了我们集成的自由度——我们只需把云服务器配置以环境变量的形式导入，在启动服务的时候让frpc自己渲染模版就行了

代理配置原子化与systemd的局限性#

既然云服务器的配置都拆出来了，何不把代理的也拆一拆，我个人喜欢拆到主机级

不过这样一来，启动服务的时候就需要两个参数：云服务器配置id和代理配置id，也就是说需要切参数了，因为systemd模版单元只能接受一个参数，于是不得不引入一个包装脚本，原因是显而易见的：ExecStart对多命令的支持几乎是没有，也不鼓励你这么做

于是使用了常见的包装器脚本切参数方案，使用:作为分隔符，他大概像这样工作：

1
systemctl start frpc@server:proxy
2
# call: wrapper.sh server:proxy
3
#   包装器将 "server:proxy" 以 : 为分隔符切成 server 和 proxy
4
#   随后包装器导入 server 对应的环境变量并使用 proxy 对应的配置文件启动 frpc
5
# frpc 渲染配置并运行

满地鸡毛#

诶你这个傻呗脚本给我的frpc切成大份了，我本来只需要systemctl start frpc或者systemctl start frpc@server就能启动服务，现在你把含有x个云服务器和y个代理的配置拆成了一共x*y个systemctl命令，多的那一大堆命令你帮我敲吗

手敲x*y个命令肯定是不现实的，所以我们要把systemctl再包一层，做成一个简单方便的统一管理入口

我们一开始切配置的大前提是，这x个云服务器配置和y个代理配置不强相关，那么我们写个脚本遍历我们想要的云服务器配置和代理配置不就行了

于是有frpm：

1
❯ frpm --help
2
frpm - FRP 服务管理工具 v1.0.0
3

4
用法: frpm [选项] <命令>
5

6
命令:
7
  enable     启用并启动服务
8
  disable    禁用并停止服务
9
  start      启动服务
10
  stop       停止服务
11
  reload     重载服务配置
12
  status     显示服务状态（表格视图）
13
  help       显示此帮助信息
14

15
选项:
16
  -s, --server <servername>    包含指定的服务器（可多次使用）
17
  -c, --config <configname>    包含指定的配置（可多次使用）
18
  -ns, --no-server <servername> 排除指定的服务器（可多次使用）
19
  -nc, --no-config <configname> 排除指定的配置（可多次使用）
20
  -h, --help                  显示帮助信息
21

22
示例:
23
  frpm enable                     # 启用所有服务组合
24
  frpm status -s server1          # 只显示server1的状态
25
  frpm stop -c config1 -ns server2 # 停止所有使用config1但不包括server2的服务

于是frpc配置管理的最后一块拼图被补齐

顺便一提这个status虽然也是vibe的，但是是我寻思的，两个不强相关的量作为两个轴织出一个阵列真那啥吧

status

具体实现#

这部分纯纯把代码贴上来水字数的，复制拿去用就行

配置部分#

代理配置#

头部是公式化的渲染模版

1
[common]
2
server_addr = {{ .Envs.FRP_SERVER_ADDR }}
3
server_port = {{ .Envs.FRP_SERVER_PORT }}
4
token = {{ .Envs.FRP_TOKEN }}
5

6
[proxy-n]
7
type = tcp
8
local_ip = 192.168.1.n
9
local_port = 22
10
remote_port = 12345

云服务器配置#

写成环境变量方便导入

1
export FRP_SERVER_ADDR="n.server.com"
2
export FRP_SERVER_PORT="7000"
3
export FRP_TOKEN="token_n"

服务部分#

systemd单元#

1
[Unit]
2
Description=FRP client for instance %i
3
After=network.target
4

5
[Service]
6
Type=simple
7
User=root
8
ExecStart=/usr/local/bin/frpc-wrapper.sh %i start
9
ExecReload=/usr/local/bin/frpc-wrapper.sh %i reload
10
Restart=on-failure
11
RestartSec=5s
12

13
[Install]
14
WantedBy=multi-user.target

包装脚本#

在这里渲染配置

1
#!/bin/bash
2
set -euo pipefail
3

4
i="$1"
5
action="${2:-start}"
6

7
log() {
8
    echo "[wrapper] $*"
9
}
10

11
if [[ "$i" != *:* ]]; then
12
    log "Error: instance name must be in format servername:confname"
13
    exit 1
14
fi
15

16
servername="${i%%:*}"
17
confname="${i#*:}"
18

19
log "resolved servername:$servername confname:$confname"
20

21
envfile="/etc/frp/servers/${servername}.env"
22
conffile="/etc/frp/${confname}.frpc.ini"
23

24
if [ ! -f "$envfile" ]; then
25
    log "Error: environment file $envfile not found"
26
    exit 1
27
fi
28
if [ ! -f "$conffile" ]; then
29
    log "Error: config file $conffile not found"
30
    exit 1
31
fi
32

33
log "now sourcing $envfile"
34
source "$envfile"
35

36
log "now starting frpc with config $conffile"
37
case "$action" in
38
    start)
39
        exec /usr/sbin/frpc -c "$conffile"
40
        ;;
41
    reload)
42
        exec /usr/sbin/frpc reload -c "$conffile"
43
        ;;
44
    *)
45
        log "Error: unknown action $action"
46
        exit 1
47
        ;;
48
esac

便捷管理脚本#

其实这个才是frpm来的）），不过没有其余部分这玩意也没用，所以无所谓了

1
#!/bin/bash
2

3
# frpm - FRP 服务管理工具
4
VERSION="1.0.0"
5

6
# 启用扩展模式匹配和nullglob
7
shopt -s extglob nullglob
8

9
# 全局变量
10
declare -a SERVER_NAMES CONFIG_NAMES
11
declare -a SELECTED_SERVERS SELECTED_CONFIGS
12
declare -a EXCLUDED_SERVERS EXCLUDED_CONFIGS
13

14
# 显示帮助信息
15
show_help() {
16
    cat << EOF
17
frpm - FRP 服务管理工具 v${VERSION}
18

19
用法: frpm [选项] <命令>
20

21
命令:
22
  enable     启用并启动服务
23
  disable    禁用并停止服务
24
  start      启动服务
25
  stop       停止服务
26
  reload     重载服务配置
27
  status     显示服务状态（表格视图）
28
  help       显示此帮助信息
29

30
选项:
31
  -s, --server <servername>    包含指定的服务器（可多次使用）
32
  -c, --config <configname>    包含指定的配置（可多次使用）
33
  -ns, --no-server <servername> 排除指定的服务器（可多次使用）
34
  -nc, --no-config <configname> 排除指定的配置（可多次使用）
35
  -h, --help                  显示帮助信息
36

37
示例:
38
  frpm enable                     # 启用所有服务组合
39
  frpm status -s server1          # 只显示server1的状态
40
  frpm stop -c config1 -ns server2 # 停止所有使用config1但不包括server2的服务
41
EOF
42
}
43

44
# 显示错误信息并退出
45
die() {
46
    echo "错误: $1" >&2
47
    exit 1
48
}
49

50
# 从文件系统读取可用的服务器和配置
51
read_available_items() {
52
    # 读取服务器列表
53
    SERVER_NAMES=()
54
    for server_file in /etc/frp/servers/*.env; do
55
        servername=$(basename "$server_file" .env)
56
        SERVER_NAMES+=("$servername")
57
    done
58

59
    # 读取配置列表
60
    CONFIG_NAMES=()
61
    for config_file in /etc/frp/*.frpc.ini; do
62
        confname=$(basename "$config_file" .frpc.ini)
63
        CONFIG_NAMES+=("$confname")
64
    done
65

66
    if [ ${#SERVER_NAMES[@]} -eq 0 ]; then
67
        die "在 /etc/frp/servers/ 目录下未找到任何 .env 文件"
68
    fi
69

70
    if [ ${#CONFIG_NAMES[@]} -eq 0 ]; then
71
        die "在 /etc/frp/ 目录下未找到任何 .frpc.ini 文件"
72
    fi
73
}
74

75
# 应用筛选条件
76
apply_filters() {
77
    SELECTED_SERVERS=("${SERVER_NAMES[@]}")
78
    SELECTED_CONFIGS=("${CONFIG_NAMES[@]}")
79

80
    # 应用包含筛选
81
    if [ ${#INCLUDE_SERVERS[@]} -gt 0 ]; then
82
        SELECTED_SERVERS=()
83
        for server in "${SERVER_NAMES[@]}"; do
84
            for included in "${INCLUDE_SERVERS[@]}"; do
85
                if [[ "$server" == "$included" ]]; then
86
                    SELECTED_SERVERS+=("$server")
87
                    break
88
                fi
89
            done
90
        done
91
    fi
92

93
    if [ ${#INCLUDE_CONFIGS[@]} -gt 0 ]; then
94
        SELECTED_CONFIGS=()
95
        for config in "${CONFIG_NAMES[@]}"; do
96
            for included in "${INCLUDE_CONFIGS[@]}"; do
97
                if [[ "$config" == "$included" ]]; then
98
                    SELECTED_CONFIGS+=("$config")
99
                    break
100
                fi
101
            done
102
        done
103
    fi
104

105
    # 应用排除筛选
106
    if [ ${#EXCLUDE_SERVERS[@]} -gt 0 ]; then
107
        TEMP_SERVERS=()
108
        for server in "${SELECTED_SERVERS[@]}"; do
109
            excluded=false
110
            for excluded_server in "${EXCLUDE_SERVERS[@]}"; do
111
                if [[ "$server" == "$excluded_server" ]]; then
112
                    excluded=true
113
                    break
114
                fi
115
            done
116
            if ! $excluded; then
117
                TEMP_SERVERS+=("$server")
118
            fi
119
        done
120
        SELECTED_SERVERS=("${TEMP_SERVERS[@]}")
121
    fi
122

123
    if [ ${#EXCLUDE_CONFIGS[@]} -gt 0 ]; then
124
        TEMP_CONFIGS=()
125
        for config in "${SELECTED_CONFIGS[@]}"; do
126
            excluded=false
127
            for excluded_config in "${EXCLUDE_CONFIGS[@]}"; do
128
                if [[ "$config" == "$excluded_config" ]]; then
129
                    excluded=true
130
                    break
131
                fi
132
            done
133
            if ! $excluded; then
134
                TEMP_CONFIGS+=("$config")
135
            fi
136
        done
137
        SELECTED_CONFIGS=("${TEMP_CONFIGS[@]}")
138
    fi
139

140
    if [ ${#SELECTED_SERVERS[@]} -eq 0 ]; then
141
        die "筛选后没有可用的服务器"
142
    fi
143

144
    if [ ${#SELECTED_CONFIGS[@]} -eq 0 ]; then
145
        die "筛选后没有可用的配置"
146
    fi
147
}
148

149
# 执行systemctl命令
150
execute_systemctl() {
151
    local command="$1"
152
    local service_name
153
    local -a failed_services=()
154

155
    for server in "${SELECTED_SERVERS[@]}"; do
156
        for config in "${SELECTED_CONFIGS[@]}"; do
157
            service_name="frpc-new@${server}:${config}"
158
            echo "执行: systemctl $command $service_name"
159

160
            if ! systemctl "$command" "$service_name"; then
161
                failed_services+=("$service_name")
162
            fi
163
        done
164
    done
165

166
    if [ ${#failed_services[@]} -gt 0 ]; then
167
        echo "警告: 以下服务执行失败:" >&2
168
        printf '  %s\n' "${failed_services[@]}" >&2
169
        return 1
170
    fi
171

172
    return 0
173
}
174

175
# 显示服务状态表格
176
show_status_table() {
177
    # 收集所有服务状态
178
    declare -A status_map
179
    local max_server_len=0
180
    local max_config_len=0
181

182
    # 确定最大长度用于表格格式化
183
    for server in "${SELECTED_SERVERS[@]}"; do
184
        if [ ${#server} -gt $max_server_len ]; then
185
            max_server_len=${#server}
186
        fi
187
    done
188

189
    for config in "${SELECTED_CONFIGS[@]}"; do
190
        if [ ${#config} -gt $max_config_len ]; then
191
            max_config_len=${#config}
192
        fi
193
    done
194

195
    # 获取所有服务的状态
196
    for server in "${SELECTED_SERVERS[@]}"; do
197
        for config in "${SELECTED_CONFIGS[@]}"; do
198
            service_name="frpc-new@${server}:${config}"
199
            status=$(systemctl is-active "$service_name" 2>/dev/null)
200
            status="${status:-unknown}"
201
            status_map["${server}:${config}"]=$status
202
        done
203
    done
204

205
    # 打印表头
206
    printf "%${max_config_len}s" ""
207
    for server in "${SELECTED_SERVERS[@]}"; do
208
        printf "  %-${max_server_len}s" "$server"
209
    done
210
    echo
211

212
    # 打印表格内容
213
    for config in "${SELECTED_CONFIGS[@]}"; do
214
        printf "%-${max_config_len}s" "$config"
215
        for server in "${SELECTED_SERVERS[@]}"; do
216
            status=${status_map["${server}:${config}"]}
217
            # 根据状态着色
218
            case "$status" in
219
                active) color="\033[32m" ;;  # 绿色
220
                inactive) color="\033[31m" ;; # 红色
221
                activating) color="\033[33m" ;; # 黄色
222
                deactivating) color="\033[33m" ;; # 黄色
223
                failed) color="\033[31m" ;; # 红色
224
                *) color="\033[90m" ;; # 灰色
225
            esac
226
            printf "  ${color}%-${max_server_len}s\033[0m" "$status"
227
        done
228
        echo
229
    done
230

231
    # 图例
232
    echo
233
    echo "图例:"
234
    echo -e "  \033[32mactive\033[0m - 服务正在运行"
235
    echo -e "  \033[31minactive\033[0m - 服务未运行"
236
    echo -e "  \033[33mactivating/deactivating\033[0m - 服务正在启动/停止"
237
    echo -e "  \033[31mfailed\033[0m - 服务启动失败"
238
    echo -e "  \033[90munknown\033[0m - 服务状态未知或服务不存在"
239
}
240

241
# 主函数
242
main() {
243
    local command=""
244
    declare -a INCLUDE_SERVERS INCLUDE_CONFIGS
245
    declare -a EXCLUDE_SERVERS EXCLUDE_CONFIGS
246

247
    # 解析命令行参数
248
    while [[ $# -gt 0 ]]; do
249
        case "$1" in
250
            enable|disable|start|stop|reload|status|help)
251
                command="$1"
252
                shift
253
                ;;
254
            -s|--server)
255
                if [ -z "$2" ]; then
256
                    die "选项 $1 需要一个参数"
257
                fi
258
                INCLUDE_SERVERS+=("$2")
259
                shift 2
260
                ;;
261
            -c|--config)
262
                if [ -z "$2" ]; then
263
                    die "选项 $1 需要一个参数"
264
                fi
265
                INCLUDE_CONFIGS+=("$2")
266
                shift 2
267
                ;;
268
            -ns|--no-server)
269
                if [ -z "$2" ]; then
270
                    die "选项 $1 需要一个参数"
271
                fi
272
                EXCLUDE_SERVERS+=("$2")
273
                shift 2
274
                ;;
275
            -nc|--no-config)
276
                if [ -z "$2" ]; then
277
                    die "选项 $1 需要一个参数"
278
                fi
279
                EXCLUDE_CONFIGS+=("$2")
280
                shift 2
281
                ;;
282
            -h|--help)
283
                show_help
284
                exit 0
285
                ;;
286
            -*)
287
                die "未知选项: $1"
288
                ;;
289
            *)
290
                die "未知参数: $1"
291
                ;;
292
        esac
293
    done
294

295
    # 如果没有指定命令，显示帮助
296
    if [ -z "$command" ]; then
297
        show_help
298
        exit 1
299
    fi
300

301
    # 处理help命令
302
    if [ "$command" = "help" ]; then
303
        show_help
304
        exit 0
305
    fi
306

307
    # 读取可用项并应用筛选
308
    read_available_items
309
    apply_filters
310

311
    # 执行请求的命令
312
    case "$command" in
313
        enable|disable|start|stop|reload)
314
            execute_systemctl "$command"
315
            ;;
316
        status)
317
            show_status_table
318
            ;;
319
        *)
320
            die "未知命令: $command"
321
            ;;
322
    esac
323
}
324

325
# 运行主函数
326
main "$@"