关于UNIX文件系统标准目录与重写安装脚本

[Seele-Vollerei32]

根据 UNIX 文件系统标准, 本人重写了文档中的部分目录与一键安装脚本, 同时重构了一键安装脚本, 现在此向各位征求意见,重写后的目录不仅可以安全兼容绝大部分发行版, 同时可以避免/home不在PATH的问题,使可执行文件随处可用, 而且可以享受系统配置的SELinux/AppAmror, 无需自行配置, 提高部分兼容性.

修改后整个仓库在此: https://github.com/Seele-Vollerei32/natfrp-wiki
修改后的脚本如下

#!/bin/bash

set -e

# ---------------- 日志函数 ----------------
log_I() { echo -e "\e[32m[+] $1\e[0m"; }
log_W() { echo -e "\e[33m[!] $1\e[0m"; }
log_E() { echo -e "\e[31m[-] $1\e[0m"; }

# ---------------- 权限检查 ----------------
check_privilage() {
    if [[ "$EUID" -ne 0 ]]; then
        log_E "请使用 root 用户运行此脚本"
        exit 1
    fi
}

# ---------------- systemd 检查 ----------------
check_systemd() {
    if ! command -v systemctl &>/dev/null || [[ ! -d /run/systemd/system/ ]]; then
        log_W "系统未启用 systemd, 将使用非 systemd 模式"
        USE_SYSTEMD=false
    else
        USE_SYSTEMD=true
    fi
}

# ---------------- 架构识别 ----------------
check_architecture() {
    case $(uname -m) in
        x86_64) ARCH=amd64 ;;
        i386) ARCH=386 ;;
        aarch64) ARCH=arm64 ;;
        armv7l) ARCH=armv7 ;;
        mips) ARCH=mips ;;
        mipsel) ARCH=mipsle ;;
        mips64) ARCH=mips64 ;;
        mips64le) ARCH=mips64le ;;
        riscv64) ARCH=riscv64 ;;
        loongarch64) ARCH=loong64 ;;
        *) log_E "不支持当前系统架构: $(uname -m)"; exit 1 ;;
    esac
}

# ---------------- 安装依赖 ----------------
install_prerequisites() {
    echo -e "${blue}检查并安装必需的依赖...${none}"
    if command -v lsb_release &>/dev/null; then
        os_name=$(lsb_release -si | tr '[:upper:]' '[:lower:]')  # 转换为小写
        case $os_name in
            ubuntu|debian)
                pkg_manager="apt-get update && apt-get install -y "
                ;;
            centos|fedora|rhel)
                if command -v dnf &>/dev/null; then
                    pkg_manager="dnf install -y "
                else
                    pkg_manager="yum install -y "
                fi
                ;;
            opensuse*)
                pkg_manager="zypper install -y "
                ;;
            openwrt)
                pkg_manager="opkg update && opkg install "
                ;;
            alpine)
                pkg_manager="apk --update add "
                ;;
            *)
                pkg_manager=
                ;;
        esac
    # 如果 lsb_release 不可用，回退到 /etc/os-release
    elif [[ -f /etc/os-release ]]; then
        . /etc/os-release  # 加载 os-release 文件中的变量
        os_name=${ID,,}    # 获取 ID 并转换为小写
        case $os_name in
            ubuntu|debian)
                pkg_manager="apt-get update && apt-get install -y "
                ;;
            centos|fedora|rhel)
                if command -v dnf &>/dev/null; then
                    pkg_manager="dnf install -y "
                else
                    pkg_manager="yum install -y "
                fi
                ;;
            opensuse*)
                pkg_manager="zypper install -y "
                ;;
            openwrt)
                pkg_manager="opkg update && opkg install "
                ;;
            alpine)
                pkg_manager="apk --update add "
                ;;
            *)
                pkg_manager=
                ;;
        esac
    fi
    for cmd in curl tar jq; do
        if ! command -v $cmd >/dev/null 2>&1; then
            if [[ -n "$pkg_manager" ]]; then
                $pkg_manager $cmd
            else
                echo -e "${red}缺少依赖 ${cmd}，请手动安装。${none}"
                exit 1
            fi
        fi
    done
    if ! command -v zstd >/dev/null 2>&1; then
        if [[ -n "$pkg_manager" ]]; then
            $pkg_manager zstd
        else
            echo -e "${red}缺少 zstd，请手动安装。${none}"
            exit 1
        fi
    fi
}

# ---------------- 用户输入凭据 ----------------
ask_for_creds() {
    while true; do
        read -e -s -p "请输入 SakuraFrp 的访问密钥: " api_key
        echo
        api_key_respond=$(curl -LI -X 'GET' "https://api.natfrp.com/v4/user/info?token=${api_key}" -o /dev/null -w '%{http_code}\n' -s)
        echo ${api_key_respond}
        if  [[ ${api_key_respond} -eq 200 ]]; then break; fi
        log_E "访问密钥错误"
    done

    while true; do
        while true; do
            read -e -s -p "请输入远程管理密码（至少八个字符）: " remote_pass
            echo
            if [[ ${#remote_pass} -ge 8 ]]; then break; fi
            log_E "远程管理密码至少需要 8 字符"
        done

        read -e -s -p "请再次输入远程管理密码: " remote_pass_confirm
        echo
        if [[ "$remote_pass" == "$remote_pass_confirm" ]]; then break; fi
        log_E "两次输入的远程管理密码不一致"
    done
}

# ---------------- 二进制安装相关 ----------------
create_user() {
    if ! id -u natfrp &>/dev/null; then
        useradd -r -m -s /sbin/nologin natfrp
        log_I "创建用户 natfrp"
    else
        log_W "natfrp 用户已存在"
    fi
}

download_binary() {
    mkdir -p /usr/local/bin && cd /usr/local/bin
    if [[ -f frpc || -f natfrp-service ]]; then
        log_W "已有启动器文件"
        read -p "是否重新下载？[y/N] " choice
        [[ $choice =~ ^[Yy]$ ]] && rm -f frpc natfrp-service
    fi

    log_I "正在下载 natfrp-service 二进制文件..."
    curl -Lo - "https://nya.globalslb.net/natfrp/client/launcher-unix/latest/natfrp-service_linux_${ARCH}.tar.zst" \
        | tar -xI zstd --overwrite
    chmod +x frpc natfrp-service
    chown natfrp: frpc natfrp-service
}

setup_config() {
    mkdir -p /etc/natfrp
    chown natfrp: /etc/natfrp
    config_file=/etc/natfrp/config.json

    remote_key=$(/usr/local/bin/natfrp-service remote-kdf "$remote_pass")

    jq ". + {
        "token": $(echo $api_key | jq -R .),
        "remote_management": true,
        "remote_management_key": $( echp ${remote_key} | jq -R .),
        "log_stdout": true
    }" $config_file >$config_file.tmp
    mv $config_file.tmp $config_file

    chown natfrp: "$config_file"
}

install_systemd_service() {
    cat > "/etc/systemd/system/natfrp.service" <<EOF
[Unit]
Description=SakuraFrp Launcher
After=network.target


[Service]
User=natfrp
Group=natfrp
Type=simple
TimeoutStopSec=20
Restart=always
RestartSec=5s
ExecStart=/usr/local/bin/natfrp-service --daemon -c /etc/natfrp

[Install]
WantedBy=multi-user.target
EOF
    systemctl daemon-reload
    systemctl enable natfrp.service
    systemctl start natfrp.service
}

start_without_systemd() {
    log_I "使用非 systemd 模式启动"
    /usr/local/bin/natfrp-service --daemon -c /etc/natfrp &
    echo $! > /var/run/natfrp.pid
    log_I "已在后台启动，PID: $(cat /var/run/natfrp.pid)"
}

# ---------------- Docker 安装 ----------------
install_docker_mode() {
    log_I "Docker 安装模式选择"
    echo "请选择镜像来源："
    echo "1. 官方 (natfrp.com/launcher)"
    echo "2. GitHub (ghcr.io/natfrp/launcher)"
    echo "3. Docker Hub (natfrp/launcher)"
    read -p "请输入选项 [1-3] (默认1): " source
    case $source in
        2) image="ghcr.io/natfrp/launcher" ;;
        3) image="natfrp/launcher" ;;
        *) image="natfrp.com/launcher" ;;
    esac

    ask_for_creds

    if docker ps -a --format '{{.Names}}' | grep -q '^natfrp$'; then
        log_W "已存在名为 natfrp 的容器"
        read -p " - 是否移除已存在的容器? [y/N] " -r choice
        if [[ $choice =~ ^[Yy]$ ]]; then
            docker kill natfrp 2>/dev/null
            docker rm natfrp 2>/dev/null
        else
            log_E "请手动移除已存在的容器后重新运行脚本"
            exit 1
        fi
    fi

    docker run -d \
        --network=host \
        --restart always \
        --name natfrp \
        --pull=always \
        -v /etc/natfrp:/run \
        -e TOKEN="$api_key" \
        -e REMOTE_PASS="$remote_pass" \
        $image
}

# ---------------- 卸载功能 ----------------
uninstall_natfrp() {
    echo "卸载 natfrp..."
    if docker ps -a --format '{{.Names}}' | grep -q '^natfrp$'; then
	docker stop natfrp || docker kill natfrp 2>/dev/null
	docker rm natfrp 2>/dev/null
    else
    	systemctl stop natfrp.service 2>/dev/null || true
    	systemctl disable natfrp.service 2>/dev/null || true
    	rm -f /etc/systemd/system/natfrp.service
    	rm -f /usr/local/bin/frpc /usr/local/bin/natfrp-service
    	userdel -r natfrp 2>/dev/null || true
    	systemctl daemon-reexec
    fi
    rm -rf /etc/natfrp
    log_I "natfrp 卸载完成"
    exit 0
}

# ---------------- 主流程 ----------------
MODE="binary"

for arg in "$@"; do
    case $arg in
        --docker) MODE="docker" ;;
        --uninstall) uninstall_natfrp ;;
    esac
    shift
done

check_privilage
check_architecture
check_systemd

if [[ "$MODE" == "docker" ]]; then
    install_docker_mode
else
    ask_for_creds
    create_user
    download_binary
    setup_config
    if [[ "$USE_SYSTEMD" == true ]]; then
        install_systemd_service
    else
        start_without_systemd
    fi
fi

log_I "natfrp 安装完成！"
log_I "登录面板管理: https://www.natfrp.com/remote/v2"

[fakeboboliu]

我在看到这个之前有过一版重写，正好借这个 PR 吐槽就被允许接手放出来了。
既然有人认为配置文件应该按 FHS 来，正好写了常量，可以直接改一下丢上去。

在 https://github.com/natfrp/wiki/blob/master/.vuepress/public/launcher.sh

看了一下区别，我说一下按我的理解很多内容在一开始没有被纳入的理由：

Q: 为什么没有进 PATH？
A: service 是为桌面应用设计的，并不是进 PATH 的 cli 应用，Linux 版本的用法做的本身也非常逆天。
在我们看来，纳入 PATH 是会造成环境污染的。

Q: 为什么不用 FHS？
A: service 作者设计是根据 user-specific 应用设计的，且根据他的自身安全习惯不允许 root 运行，
目前的全局用法算是一种 hack，故脱胎于（直接来源于阅读源码的）教程的一键脚本以 XDG 目录为主。

Q: 为什么不支持非 systemd？
A: 我们希望提供一个尽可能不会让人犯错的脚本，原始 PR 是这样想的，我也是认同的。
基于用户群讨论，只要有犯错的可能，就一定会有很多人犯错。
为此可以减少极客系统的支持——真的有这个需求的极客应当有自己做的能力，而不需要一键脚本。

Q: 为什么默认 Docker?
A: 有一说一，我个人认为都应该用 docker 部署，用脚本去拟合无限的环境可能始终是有限的。

我从昨天开始流感了，大脑运转比较困难，上面这一点话就写了20分钟，如果有点问题还请包涵。

[Seele-Vollerei32]

了解了, 但是我也有一些意见相左的地方, 仅供参考

1. 为什么我认为不该默认使用 docker
   docker 是一个很好的技术, 他可以几乎完全避免 "It works on my machine" 这种问题, 但是我认为 frp 不该用 docker 也是由于 docker 的特性: 与主机太过隔离, 以至于处理 docker 的网络变得相当的棘手, 而且根据我自己的经历, 我已经不是第一次把自己困在错误的 docker 配置中了, 同样, docker 的一些默认行为也可能使用户产生疑惑, 特别是一些刚接触 Linux 的用户, 安装 docker 可能都堪比上刑. 至于直接部署时对环境的处理, 我认为只需要处理好一些流行发行版(即那些新用户会初次遇到的发行版)便可以了, 小众发行版的支持可有可无, 因为那些用户大多会自己部署与自己处理问题.

2. 我为什么想支持非 systemd
   这个想法仅是个想法, 我本是打算支持其他守护进程管理工具, 甚至用本脚本代替守护进程, 但是眼高手低没有完善, 只能暂时搁置.

3. 为什么我想将其放进标准目录以及 PATH
   在这之前我其实已经有过尝试, 并且它工作起来很好, ,暂时也没看到对环境的污染, 遂打算向上游同步. 同时这也与我早期使用Linux的哲学有关, 但是随着年纪见长, 现在也感觉有些无所谓了, 对于一些简单的程序我可能还会写 PKGBUILD 打包, 一些复杂的大型项目我可能会直接运行二进制而不在意它在哪了, 因此这个想法也仅供参考.

4. 关于新脚本
   我认为还有一些不完备的地方, 例如机密回显与二进制可执行判断, 我最近如果能腾出时间可能会提出pr, 还请多多关照.

以及最后对您得了流感感到抱歉, 还请多喝温水多休息, 希望早日康复.

[fakeboboliu]

1. 关于 docker 的网络问题
   这也是我们在启动器的教程中使用了 host 网络模式、而且将其他 docker 教程也迁移到了 host 的理由之一，看起来即使很多人在用 openwrt 了，大家普遍对于 Linux 网络栈还是比较困惑的。
2. 关于非 systemd
   我个人其实是 runit 爱好者，感觉让他作为一个 supervisor 非常简洁优雅，但是显然他没什么用户所以我还是放弃私货了。XD
3. 关于标准目录和 PATH
   污染环境指的是 PATH 中有不应该被搜索到执行的二进制，且可能会有和其他的东西（包管理器/上游版 frp 安装）发生冲突的风险。
4. 关于新脚本的完善
   非常欢迎 PR，我的重组基本上是以原脚本组件为主的，没有做很多大的改动，处于能用就行状态。XD

流感最近好些了，打字速度快了一些，感谢关心。

[Seele-Vollerei32]

关于与上游二进制冲突的问题我用了一个比较tricky的方式解决了, 详见以下

PKGBUILD

package() {
    install -Dm755 "${srcdir}/natfrp-service" "${pkgdir}/usr/bin/natfrp-service"
    install -Dm755 "${srcdir}/frpc" "${pkgdir}/usr/bin/natfrpc"

    mkdir -p "${pkgdir}/etc/natfrp"

    install -Dm644 "${srcdir}/natfrp.service" "${pkgdir}/usr/lib/systemd/system/natfrp.service"
}

natfrp.service

[Unit]
Description=SakuraFrp Launcher
After=network.target

[Service]
User=natfrp
Group=natfrp

Type=simple
TimeoutStopSec=20

Restart=always
RestartSec=5s
Environment='NATFRP_SERVICE_WD=/etc/natfrp' 'NATFRP_FRPC_PATH=/usr/bin/natfrpc'  #Use alternative name avoid conflict.

ExecStart=/usr/bin/natfrp-service --daemon

[Install]
WantedBy=multi-user.target

[fakeboboliu]

natfrpc

可以这么做，倒不如说我在 OpenWrt 版本的早期教程里面就是这么做的……
但是对于一个自己要用的系统，我认为不应该往 PATH 里面放平时用不到的东西。

一键脚本更多考虑的是普通用户，而不是极客，极客用户不需要我们指手画脚。

我注意到您将想法以 AUR 发布了，这应当对极客用户能起到一些帮助，非常感谢。