Skip to content

Latest commit

 

History

History
320 lines (226 loc) · 11.8 KB

README.md

File metadata and controls

320 lines (226 loc) · 11.8 KB
Raw

NodeStatus

Yet another servers monitor written in TypeScript.

Current Version: 1.2.9-beta

How To Install

If you want to update from v1.1.0 to v1.2.0 or later, you need to rebuild the database to handle the breaking change.

mv /usr/local/NodeStatus/db.sqlite /usr/local/NodeStatus/db.sqlite.bak

Install locally

# Install Node.js
# Using Ubuntu
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

# Using Debian, as root
curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
apt-get install -y nodejs

# RHEL, CentOS, CloudLinux, Amazon Linux or Fedora as root
curl -fsSL https://rpm.nodesource.com/setup_20.x | bash -


#Install From NPM
npm i pm2 -g
# Two cli tools `status-server and status-server-run` will be installed. Default database is located at `file:/usr/local/NodeStatus/server/db.sqlite` so it's needed to add `--unsafe-perm` flag.
# You can set environment variable `DATABASE` to the location in your user's home directory in advance if you don't want to add `--unsafe-perm` flag.
npm i nodestatus-server@latest --unsafe-perm -g 
status-server # start nodestatus-server
status-server-run # start nodestatus-server with pm2
pm2 status # check running status
pm2 log nodestatus # check logs

# How to Update
npm i nodestatus-server@latest --unsafe-perm -g

Install with Docker (Recommended)

# Install Docker with docker-compose v2
curl -fsSL https://get.docker.com | bash -s docker
docker --version
mkdir -p ~/.docker/cli-plugins/
curl -SL https://github.com/docker/compose/releases/latest/download/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose # for x86_64
chmod +x ~/.docker/cli-plugins/docker-compose

# Download docker-compose.yml
mkdir ~/nodestatus
cd ~/nodestatus
wget https://raw.githubusercontent.com/cokemine/nodestatus/master/docker-compose.yml
vim docker-compose.yml #修改环境变量相关配置
docker compose up -d

# How to Update
cd ~/nodestatus
docker compose down
docker pull cokemine/nodestatus:latest
docker compose up -d

Client

Go Version: https://github.com/cokemine/nodestatus-client-go

Node.js Version(Deprecated, Not Recommended): https://github.com/cokemine/nodestatus-client

Environment

关于环境变量的相关配置，如果是使用 Docker 请直接在 docker-compose.yml 配置文件中修改。

若为手动安装，则需要在本地用户目录下新建一个 .nodestatus/.env.local 文件（注意路径），在这个文件填写相关环境变量配置。

INTERVAL : 服务端向前端（浏览器）推送的间隔时间, 默认 1500 (1.5 秒)

DATABASE : 数据库位置文件存放位置, 默认使用 SQLite (Linux): file:/usr/local/NodeStatus/server/db.sqlite，支持的数据库有 SQLite、MySQL、PostgreSQL，请使用对应的正确数据源链接格式填写：SQLite 应以 file: 开头, MySQL 应以 mysql: 开头, PostgreSQL 应以 postgresql: 开头。

PORT : NodeStatus 所用端口, 默认 35601

VERBOSE : 是否输出更多日志信息，默认 false

PING_INTERVAL : 用于心跳检测是否与客户端异常断开连接, 默认 30 (30 秒)

TZ : 用于设置时区，默认 Asia/Shanghai

 

USE_PUSH : 是否使用 Telegram 推送, 默认 true

USE_IPC : 是否需要 IPC 修改服务端配置, 默认 true

USE_WEB : 是否需要开启一个小型 web 面板修改服务端配置, 默认 true

 

WEB_THEME : NodeStatus 前端使用的主题，默认 hotaru-theme , 可选 hotaru-theme | classic-theme

WEB_TITLE : 自定义站点显示标题，默认 Server Status

WEB_SUBTITLE : 自定义站点显示副标题，默认 Servers' Probes Set up with NodeStatus

WEB_HEADTITLE : 用于定义 head 标签中的 title 元素，默认 NodeStatus

 

WEB_USERNAME : WEB 面板用户名，默认 admin

WEB_PASSWORD : WEB 面板密码

WEB_SECRET : 用于 jsonwebtoken, 建议设为一个随机的字符串

 

PUSH_TIMEOUT : 客户端报警推送超时时间 (在这个时间内无论客户端发生了什么只要重新恢复与客户端的连接就不会推送), 默认 120 (120 秒)

PUSH_DELAY : 报警推送服务启动延迟 (防止重启服务端后导致的集中推送), 默认 15 (15 秒)

 

TGBOT_TOKEN : Telegram Bot Token (从 BotFather 申请到)

TGBOT_CHATID : Telegram Bot 需要推送的 chat_id, 如不清楚可以先启动 NodeStatus, 对 Bot 发送 /start 获取这个 id, 多个请用 , 隔开

TGBOT_PROXY : Telegram 代理服务器配置，例 http://127.0.0.1:10808，仅支持 http 代理

TGBOT_WEBHOOK : Telegram Webhook 配置，不填写默认 Polling,例: https://tz.mydomain.com，使用 Webhook 务必需要开启 https，若你使用了 https，则建议填写你的域名以开启 Webhook, 而非 Polling

部署到容器服务

如果你需要将 NodeStatus 部署到如 Railway 或 Okteto 等容器服务中。请注意数据持久化问题。你应该使用外部的 MySQL 或是 PostgreSQL 而不是本项目默认的 SQLite，因为如果使用 SQLite 在每次重置服务端都会导致原有的配置失效。使用时注意通过调整环境变量以使用可持续存储的数据库服务。

目前本项目还无法部署到如 Vercel 等 Serverless 服务中，因为目前 Serverless 不支持 WebSocket。

修改客户端配置

NodeStatus 有两种方式修改（添加 / 删除）服务器配置。

NodeStatus-cli

若你启用了 IPC, 则可以通过 status-cli 修改服务器相关配置。

npm i nodestatus-cli -g
status-cli help # check cli help

Web

若你启用了 Web, 则可以通过 Web 修改服务器相关配置。不需要手动安装，访问 http://status.domain.com/admin 即可访问面板。

同时通过 Web 面板你可以很简单的从 ServerStatus 迁移至 NodeStatus, 你可以在面板 Import 处将 ServerStatus 的 JSON 文件粘贴过去一键添加服务器。（需要去除多余的 host 字段）

面板开源地址：https://github.com/cokemine/nodestatus/tree/master/web/hotaru-admin

前端样式调整

如果你需要进行比较大规模的 Web 前端样式调整，建议直接修改本项目前端源代码并重新编译。本项目自带 Docker 发布的 CI，CI 环境下修改 Docker Hub 相关环境变量即可发布自定义镜像到自己的 Docker Hub 下方便后续使用，或手动通过 docker build 命令手动构建自定义镜像。

如果仅需进行细微调整，可以创建一个自定义样式表映射到容器内，该样式通过 /custom/style.css 这个 URL 自动引入到前端。

例如若你想删除 hotaru-theme 的头图。可以在当前目录创建一个 assets 目录，在其中创建 style.css 文件填入以下内容。

#header {
  background: none !important;
}

@media (max-width: 768px) {
  #header {
    background: none !important;
  }
}

然后在 docker-compose.yml文件的 volumes 键中，将这个文件映射到容器内部（不要删除原有的映射条目）。

volumes:
  - ./assets/style.css:/app/packages/nodestatus-server/build/dist/hotaru-theme/assets/custom/style.css

现在，你编写的样式表已经可以通过 /custom/style.css 这个 URL 访问，并且自动引入到了对应主题的前端生效。

Telegram Commands

/start 查询当前 chat_id，当前 NodeStatus 版本号

/status [name...] 查询当前某个服务器状态信息，匹配规则为请求为服务器名称的子字符串，多个条件请用空格分隔，若有多个条件只需满足一个条件。

Reverse Proxy

下面是对几种常见 Web 服务器配置反向代理的实例

Nginx v1.25.1+

# Mozilla modern configuration
server {
  listen 80;
  listen [::]:80;
  server_name status.domain.com; # 需要绑定的域名

  location / {
    return 301 https://$host$request_uri;
  }
}

server {
  listen 443 ssl;
  listen [::]:443 ssl;
  # 开启 HTTP/3
  listen 443 quic reuseport;
  listen [::]:443 quic reuseport;
  # 开启 HTTP/2
  http2 on;
    
  server_name status.domain.com; # 需要绑定的域名
  access_log /var/log/nginx/status.domain.com_nginx.log combined; # 日志位置, 目录如果不存在需要提前创建好  
    
  ssl_certificate /etc/nginx/conf.d/ssl/status.domain.com.crt; # SSL 证书路径
  ssl_certificate_key /etc/nginx/conf.d/ssl/status.domain.com.key; # SSL Key 证书路径
  # ssl_trusted_certificate /etc/nginx/conf.d/ssl/status.domain.com.ca.crt; # SSL CA
  ssl_session_timeout 1d;
  ssl_session_cache shared:MozSSL:10m; # about 40000 sessions
  ssl_session_tickets off;

  # modern configuration
  ssl_protocols TLSv1.3;
  ssl_prefer_server_ciphers off;

  # HSTS (ngx_http_headers_module is required) (63072000 seconds)
  add_header Strict-Transport-Security "max-age=63072000" always;

  ssl_stapling on;
  ssl_stapling_verify on;

  location / {
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_set_header X-NginX-Proxy true;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_pass http://127.0.0.1:35601; # 反代地址
    proxy_http_version 1.1;
  }
}

Caddy V2

https://status.domain.com {
  encode zstd gzip
  # tls your_cert_file your_key_file
  # tls your_email
  reverse_proxy http://127.0.0.1:35601
}

Caddy V1

https://status.domain.com {
  gzip
  # tls your_cert_file your_key_file
  # tls your_email
  proxy / http://127.0.0.1:35601 {
  	websocket
  	transparent
  }
}

How To Debug

npm i pnpm -g
git clone https://github.com/cokemine/nodestatus.git
cd nodestatus
pnpm install
pnpm dev

CLI Options

Usage: NodeStatus [options]

Options:
  -p, --port <port>                             Web server listening port (default: 35601, env: PORT)
  -i, --interval <interval>                     Update interval (default: 1500, env: INTERVAL)
  -v, --verbose                                 Verbose mode (default: false, env: VERBOSE)
  -pi, --ping-interval <pingInterval>           Ping interval (default: 30, env: PING_INTERVAL)
  -ipc, --use-ipc                               Use IPC (default: true, env: USE_IPC)
  -web, --use-web                               Use Web (default: true, env: USE_WEB)
  -push, --use-push                             Use Push (default: true, env: USE_PUSH)
  -wt, --web-theme <webTheme>                   Web theme (default: "hotaru-theme", env: THEME)
  -wmt, --web-title <webTitle>                  Web title (default: "Server Status", env: WEB_TITLE)
  -wst, --web-subtitle <webSubtitle>            Web subtitle (default: "Servers' Probes Set up with NodeStatus", env: WEB_SUBTITLE)
  -wht, --web-headtitle <webHeadtitle>          Web head title (default: "NodeStatus", env: WEB_HEADTITLE)
  -wu, --web-username <webUsername>             Web username (default: "admin", env: WEB_USERNAME)
  -wp, --web-password <webPassword>             Web password (default: "", env: WEB_PASSWORD)
  -ws, --web-secret <webSecret>                 Web jwt secret (default: "node-secret", env: WEB_SECRET)
  -ia, --ipc-address <ipcAddress>               IPC address (default: "\\\\.\\pipe\\status_ipc", env: IPC_ADDRESS)
  -pt, --push-timeout <pushTimeout>             Push timeout (default: 120, env: PUSH_TIMEOUT)
  -pd, --push-delay <pushDelay>                 Push delay (default: 15, env: PUSH_DELAY)
  -ti, --telegram-bot-token <telegramBotToken>  Telegram bot token (default: "", env: TGBOT_TOKEN)
  -tc, --telegram-chat-id <telegramChatId>      Telegram chat id (default: "", env: TGBOT_CHATID)
  -tp, --telegram-proxy <telegramProxy>         Telegram proxy (env: TGBOT_PROXY)
  -tw, --telegram-web-hook <telegramWebHook>    Telegram web hook (env: TGBOT_WEBHOOK)
  -h, --help                                    display help for command