Linux Installation Guide / Linux 安装指南

English

SFTPxy runs as a portable binary or a systemd service.

Portable run

Download the Linux archive that matches your CPU: linux_amd64 or linux_arm64.
Extract the archive.
Start SFTPxy.

./SFTPxy serve -c .

For a first test, create a temporary admin account:

SFTPXY_DATA_PROVIDER__CREATE_DEFAULT_ADMIN=1 \
SFTPXY_DEFAULT_ADMIN_USERNAME=admin \
SFTPXY_DEFAULT_ADMIN_PASSWORD='change-this-password' \
SFTPXY_COMMON__SECRET_MIN_ENTROPY=0 \
./SFTPxy serve -c .

systemd service

Typical layout:

sudo install -d -m 0755 /etc/SFTPxy /usr/local/bin /srv/SFTPxy/data
sudo install -d -m 0750 /var/lib/SFTPxy /var/log/SFTPxy
sudo install -m 0755 SFTPxy /usr/local/bin/SFTPxy
sudo cp SFTPxy.json /etc/SFTPxy/SFTPxy.json
sudo cp -R templates static openapi /etc/SFTPxy/
sudo cp init/SFTPxy.service /etc/systemd/system/SFTPxy.service

Then add /etc/SFTPxy/SFTPxy.env, enable the service, and remove bootstrap variables after first login.

Default paths

Config: /etc/SFTPxy or /usr/local/etc/SFTPxy
Data: /var/lib/SFTPxy
Logs: /var/log/SFTPxy

中文

SFTPxy 可以直接用可执行文件运行，也可以作为 systemd 服务运行。

便携运行

下载与你的 CPU 匹配的 Linux 压缩包：linux_amd64 或 linux_arm64。
解压文件。
启动 SFTPxy。

./SFTPxy serve -c .

首次测试时可临时创建管理员账号：

SFTPXY_DATA_PROVIDER__CREATE_DEFAULT_ADMIN=1 \
SFTPXY_DEFAULT_ADMIN_USERNAME=admin \
SFTPXY_DEFAULT_ADMIN_PASSWORD='change-this-password' \
SFTPXY_COMMON__SECRET_MIN_ENTROPY=0 \
./SFTPxy serve -c .

systemd 服务

常见目录结构：

sudo install -d -m 0755 /etc/SFTPxy /usr/local/bin /srv/SFTPxy/data
sudo install -d -m 0750 /var/lib/SFTPxy /var/log/SFTPxy
sudo install -m 0755 SFTPxy /usr/local/bin/SFTPxy
sudo cp SFTPxy.json /etc/SFTPxy/SFTPxy.json
sudo cp -R templates static openapi /etc/SFTPxy/
sudo cp init/SFTPxy.service /etc/systemd/system/SFTPxy.service

然后创建 /etc/SFTPxy/SFTPxy.env，启用服务，首次登录后删除临时启动变量。

默认路径

配置：/etc/SFTPxy 或 /usr/local/etc/SFTPxy
数据：/var/lib/SFTPxy
日志：/var/log/SFTPxy