ServerStatus-Rust Hands-on Deployment Guide on Debian 11

Result#

Preparation#

• TG BOT API

• TG CHAT ID

• Vercel

• VPS

• Domain name (optional)

Deploying the Server#

Get your bot_token from @BotFather. The content pointed to by the red box is your token.

Get your chat_id from @Get My ID.

1
apt install wget curl unzip vim
2
新建目录并且进入
3
mkdir -p /opt/ServerStatus && cd /opt/ServerStatus
4
编辑.sh文件
5
vim server.sh

1
#!/bin/bash
2
set -ex
3

4
WORKSPACE=/opt/ServerStatus
5
mkdir -p ${WORKSPACE}
6
cd ${WORKSPACE}
7

8
# 下载, arm 机器替换 x86_64 为 aarch64
9
OS_ARCH="x86_64"
10
latest_version=$(curl -m 10 -sL "https://api.github.com/repos/zdz/ServerStatus-Rust/releases/latest" | grep "tag_name" | head -n 1 | awk -F ":" '{print $2}' | sed 's/\"//g;s/,//g;s/ //g')
11

12
wget --no-check-certificate -qO "server-${OS_ARCH}-unknown-linux-musl.zip"  "https://github.com/zdz/ServerStatus-Rust/releases/download/${latest_version}/server-${OS_ARCH}-unknown-linux-musl.zip"
13

14
unzip -o "server-${OS_ARCH}-unknown-linux-musl.zip"
15

16
# systemd service
17
mv -v stat_server.service /etc/systemd/system/stat_server.service
18

19
systemctl daemon-reload
20

21
# 启动
22
systemctl start stat_server
23

24
# 状态查看
25
systemctl status stat_server
26

27
# 使用以下命令开机自启
28
systemctl enable stat_server
29

30
# https://fedoraproject.org/wiki/Systemd/zh-cn
31
# https://docs.fedoraproject.org/en-US/quick-docs/understanding-and-administering-systemd/index.html

1
bash -ex server.sh

1
vim /opt/ServerStatus/config.toml

1
# 管理员账号,不设置默认随机生成，用于查看 /detail, /map
2
jwt_secret = "" # 修改这个, 使用 openssl rand -base64 16 生成 secret 第8行
3
admin_user = ""  第9行
4
admin_pass = "" 第10行
5
hosts =  第22行
6
# 开关 true 打开
7
enabled = false  第60行
8
bot_token = "<tg bot token>" 第61行
9
chat_id = "<chat id>" 第62行

1
# 测试配置文件是否有效
2
./stat_server -c config.toml -t
3
# 根据配置发送测试消息，验证通知是否生效
4
./stat_server -c config.toml --notify-test

1
systemctl restart stat_server

Theme Configuration#

Theme configuration is implemented via frontend–backend separation, with the frontend deployed on Vercel.

First fork HinataKato/hotaru_theme_for_RustVersion: The frontend of ServerStatus-Hotaru based on Vue 3.0 (github.com) to your own account:

Import this repo into Vercel:

Just deploy directly; no need to modify anything. After deployment finishes, open the forked repository in GitHub and use Codespaces to modify the project.

Create vercel.json in the repo root directory. The file content is as follows. Replace http://xxx.com/ with your own domain name or IP:port. If you support HTTPS, remember to change all http:// to https://:

1
{
2
    "routes": [
3
        {
4
            "src": "/json/stats.json",
5
            "dest": "http://ip:端口/json/stats.json"
6
        },
7
        {
8
            "src": "/detail",
9
            "dest": "http://ip:端口/detail"
10
        },
11
        {
12
            "src": "/map",
13
            "dest": "http://ip:端口/map"
14
        },
15
        {
16
            "src": "/i",
17
            "dest": "http://ip:端口/i"
18
        },
19
        {
20
            "src": "/report",
21
            "dest": "http://ip:端口/report"
22
        }
23
    ]
24
}

Commit and push the branch with any message you like.

Wait for it to redeploy and connect to the backend.

Add your own domain name:

Wait a bit for it to take effect and the deployment is complete.

Deploying the Client#

Create the directory:

1
cd
2
apt install wget curl unzip vim vnstat
3
mkdir -p /opt/ServerStatus && cd /opt/ServerStatus

Edit the .sh file:

1
vim client.sh

If you are deploying on ARM architecture, remember to modify the OS_ARCH variable as indicated in the comment. File content is as follows:

1
#!/bin/bash
2
set -ex
3

4
WORKSPACE=/opt/ServerStatus
5
mkdir -p ${WORKSPACE}
6
cd ${WORKSPACE}
7

8
# 下载, arm 机器替换 x86_64 为 aarch64
9
OS_ARCH="x86_64"
10
latest_version=$(curl -m 10 -sL "https://api.github.com/repos/zdz/ServerStatus-Rust/releases/latest" | grep "tag_name" | head -n 1 | awk -F ":" '{print $2}' | sed 's/\"//g;s/,//g;s/ //g')
11

12
wget --no-check-certificate -qO "client-${OS_ARCH}-unknown-linux-musl.zip"  "https://github.com/zdz/ServerStatus-Rust/releases/download/${latest_version}/client-${OS_ARCH}-unknown-linux-musl.zip"
13

14
unzip -o "client-${OS_ARCH}-unknown-linux-musl.zip"
15

16
# systemd service
17
mv -v stat_client.service /etc/systemd/system/stat_client.service
18

19
systemctl daemon-reload
20

21
# 启动
22
systemctl start stat_client
23

24
# 状态查看
25
systemctl status stat_client
26

27
# 使用以下命令开机自启
28
systemctl enable stat_client
29

30
# 停止
31
# systemctl stop stat_client
32

33
# https://fedoraproject.org/wiki/Systemd/zh-cn
34
# https://docs.fedoraproject.org/en-US/quick-docs/understanding-and-administering-systemd/index.html
35

36
# 修改 /etc/systemd/system/stat_client.service 文件，将IP改为你服务器的IP或你的域名

Run the .sh file:

1
bash -ex client.sh

If you need to use vnStat data, follow zdz/ServerStatus-Rust: ✨ Rust 版 ServerStatus 探针、威力加强版 (github.com) to install and configure vnStat:

1
# 在client端安装 vnstat
2
## Centos
3
sudo yum install epel-release -y
4
sudo yum install -y vnstat
5
## Ubuntu/Debian
6
sudo apt install -y vnstat
7

8
# 修改 /etc/vnstat.conf
9
# 一般来说只要修改BandwidthDetection和MaxBandwidth就够了
10
# BandwidthDetection 0
11
# MaxBandwidth 0
12
# 默认不是 eth0 网口的需要置空 Interface 来自动选择网口
13
# 没报错一般不需要改
14
# Interface ""
15
systemctl restart vnstat
16

17
# 确保 version >= 2.6
18
vnstat --version
19
# 测试查看月流量 (刚安装可能需等一小段时间来采集数据)
20
vnstat -m
21
vnstat --json m

Before editing the configuration file, you can first test whether your service works. (Here the domain is the one where you deployed on Vercel; the username and password correspond to the host.)

1
./stat_client -a https://probe.catcat.blog/report -u 用户名 -p 密码

If it works, you can edit the stat_client.service configuration file:

1
vim /etc/systemd/system/stat_client.service

Refer to the following and only modify the line ExecStart=/opt/ServerStatus/stat_client. If you’re using HTTP, remember to change https to http. If you don’t use vnStat, remove -n, i.e. only keep -a "https://probe.catcat.blog/report" -u 用户名 -p 密码.

1
[Unit]
2
Description=ServerStatus-Rust Client
3
After=network.target
4

5
[Service]
6
User=root
7
Group=root
8
Environment="RUST_BACKTRACE=1"
9
WorkingDirectory=/opt/ServerStatus
10
# EnvironmentFile=/opt/ServerStatus/.env
11
ExecStart=/opt/ServerStatus/stat_client -a "https://probe.catcat.blog/report" -u 用户名 -p 密码 -n
12
ExecReload=/bin/kill -HUP $MAINPID
13
Restart=on-failure
14

15
[Install]
16
WantedBy=multi-user.target
17

18
# /etc/systemd/system/stat_client.service
19
# journalctl -u stat_client -f -n 100

After editing, reload the unit file and then restart the client service:

1
systemctl daemon-reload && systemctl restart stat_client

Check the service status with systemctl status stat_client.