mirror of
https://github.com/JetSprow/J-Board-Lite.git
synced 2026-05-01 01:14:10 +05:30
docs: update repository links for J-Board Lite
This commit is contained in:
@@ -10,9 +10,9 @@ This file is for agents working in this repository. Product, deployment, API, an
|
||||
|
||||
## Project Shape
|
||||
|
||||
J-Board is a Next.js App Router application backed by Prisma/PostgreSQL and Redis. It integrates with 3x-ui rather than replacing it:
|
||||
J-Board Lite is a Next.js App Router application backed by Prisma/SQLite and in-process rate limiting. It integrates with 3x-ui rather than replacing it:
|
||||
|
||||
- J-Board owns users, orders, plans, subscriptions, payments, support, notifications, audit logs, settings, and risk review.
|
||||
- J-Board Lite owns users, orders, plans, subscriptions, payments, support, notifications, audit logs, settings, and risk review.
|
||||
- 3x-ui owns actual inbound runtime configuration and Xray clients.
|
||||
- `agent/jboard-agent` is a read-only sidecar for latency, route trace, and optional Xray access log telemetry.
|
||||
|
||||
@@ -55,4 +55,4 @@ Keep docs factual and operational. Avoid promising features that are not impleme
|
||||
|
||||
Subscription risk and node access telemetry contain sensitive evidence: user IPs, locations, Xray client email, target hosts, timestamps, and admin review decisions. Treat these as sensitive data in logs, docs, screenshots, and tests.
|
||||
|
||||
Agent Xray log telemetry must remain read-only. It may read access logs and post aggregates to J-Board; it must not mutate 3x-ui or Xray runtime configuration.
|
||||
Agent Xray log telemetry must remain read-only. It may read access logs and post aggregates to J-Board Lite; it must not mutate 3x-ui or Xray runtime configuration.
|
||||
|
||||
@@ -64,7 +64,7 @@ J-Board Lite 只保存售卖和展示需要的节点镜像数据。入站协议
|
||||
|
||||
J-Board Lite 面板和 Agent 使用相对独立的版本节奏。
|
||||
|
||||
- 面板代码变更可以只提交到 `lite`,不一定创建 GitHub Release。
|
||||
- 面板代码变更提交到 `main`;对外版本使用 Git tag 和 GitHub Release 发布。
|
||||
- Agent 二进制发生变化时,才需要升级 Agent 版本、打 tag、创建 Release,并上传 `jboard-agent-linux-amd64`、`jboard-agent-linux-arm64`、`SHA256SUMS`。
|
||||
- Agent 安装/升级脚本默认下载 GitHub 最新 Release 中的 Agent 产物。
|
||||
- 不要为了普通网站页面或后台文案改动强行更新 Agent tag。
|
||||
@@ -132,7 +132,7 @@ SMTP 邮件服务、注册邮箱验证开关、支付方式、3x-ui 节点等业
|
||||
适合全新 Linux 服务器。脚本会安装基础依赖、安装 Docker 与 Compose 插件、拉取代码、生成 `.env`、初始化数据库并启动面板。
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/install-jboard-panel.sh)
|
||||
bash <(curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/install-jboard-panel.sh)
|
||||
```
|
||||
|
||||
安装和更新脚本会自动检测 CPU、宿主机内存、Docker 可用内存和 Docker 数据盘空间。常规机器使用 Docker 默认构建策略;1C、低于 2GB 内存或 Docker 可用空间低于 8GB 的小机器会自动进入低资源模式,降低 Compose 并发、npm 编译并发和 Next 构建堆内存,并把镜像分步构建,构建会更慢但峰值占用更低。
|
||||
@@ -152,7 +152,7 @@ bash <(curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/script
|
||||
也可以通过环境变量覆盖默认行为:
|
||||
|
||||
```bash
|
||||
APP_DIR=/opt/jboard GH_REPO=JetSprow/J-Board BRANCH=lite bash <(curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/install-jboard-panel.sh)
|
||||
APP_DIR=/opt/jboard GH_REPO=JetSprow/J-Board-Lite BRANCH=main bash <(curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/install-jboard-panel.sh)
|
||||
```
|
||||
|
||||
构建资源策略也可以手动覆盖:
|
||||
@@ -336,7 +336,7 @@ cat /var/lib/jboard-agent/xray-log-state.json
|
||||
升级 Agent:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/upgrade-jboard-agent.sh | bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/upgrade-jboard-agent.sh | bash
|
||||
```
|
||||
|
||||
如果只想手动运行 Agent:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
BINARY := jboard-agent
|
||||
VERSION := 3.0.2
|
||||
VERSION := 3.1.1
|
||||
LDFLAGS := -s -w
|
||||
|
||||
.PHONY: build build-linux clean
|
||||
|
||||
@@ -49,19 +49,19 @@ Agent 使用 `AUTH_TOKEN` 认证。这个 token 在 J-Board Lite 后台节点页
|
||||
手动安装命令形如:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/install-jboard-agent.sh | SERVER_URL=https://panel.example.com AUTH_TOKEN=你的Token bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/install-jboard-agent.sh | SERVER_URL=https://panel.example.com AUTH_TOKEN=你的Token bash
|
||||
```
|
||||
|
||||
如果需要指定 Agent Release:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/install-jboard-agent.sh | AGENT_TAG=v3.0.2 SERVER_URL=https://panel.example.com AUTH_TOKEN=你的Token bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/install-jboard-agent.sh | AGENT_TAG=v3.1.1 SERVER_URL=https://panel.example.com AUTH_TOKEN=你的Token bash
|
||||
```
|
||||
|
||||
## 升级
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board/lite/scripts/upgrade-jboard-agent.sh | bash
|
||||
curl -fsSL https://raw.githubusercontent.com/JetSprow/J-Board-Lite/main/scripts/upgrade-jboard-agent.sh | bash
|
||||
```
|
||||
|
||||
升级脚本会读取现有 `/etc/jboard-agent.env`,保留服务器地址、Token、探测间隔和 Xray 日志配置,并重新写入当前 systemd service。
|
||||
@@ -75,7 +75,7 @@ journalctl -u jboard-agent -n 30 --no-pager
|
||||
你应该看到类似:
|
||||
|
||||
```text
|
||||
[agent] jboard-agent v3.0.2 starting in probe-only mode
|
||||
[agent] jboard-agent v3.1.1 starting in probe-only mode
|
||||
```
|
||||
|
||||
## 环境变量
|
||||
|
||||
@@ -12,7 +12,7 @@ import (
|
||||
"github.com/jboard/jboard-agent/internal/probe"
|
||||
)
|
||||
|
||||
const version = "3.0.2"
|
||||
const version = "3.1.1"
|
||||
|
||||
func main() {
|
||||
debug.SetGCPercent(50)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board}"
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board-Lite}"
|
||||
AGENT_TAG="${AGENT_TAG:-latest}"
|
||||
INSTALL_DIR="${INSTALL_DIR:-/usr/local/bin}"
|
||||
SERVICE_NAME="${SERVICE_NAME:-jboard-agent}"
|
||||
@@ -24,7 +24,7 @@ trap cleanup EXIT
|
||||
if [ -z "${SERVER_URL:-}" ] || [ -z "${AUTH_TOKEN:-}" ]; then
|
||||
echo "SERVER_URL and AUTH_TOKEN are required." >&2
|
||||
echo "Example:" >&2
|
||||
echo "curl -fsSL https://raw.githubusercontent.com/${GH_REPO}/lite/scripts/install-jboard-agent.sh | SERVER_URL=https://example.com AUTH_TOKEN=token bash" >&2
|
||||
echo "curl -fsSL https://raw.githubusercontent.com/${GH_REPO}/main/scripts/install-jboard-agent.sh | SERVER_URL=https://example.com AUTH_TOKEN=token bash" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board}"
|
||||
BRANCH="${BRANCH:-lite}"
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board-Lite}"
|
||||
BRANCH="${BRANCH:-main}"
|
||||
APP_DIR="${APP_DIR:-}"
|
||||
REWRITE_ENV="${REWRITE_ENV:-}"
|
||||
SKIP_DOCKER_INSTALL="${SKIP_DOCKER_INSTALL:-0}"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board}"
|
||||
GH_REPO="${GH_REPO:-JetSprow/J-Board-Lite}"
|
||||
AGENT_TAG="${AGENT_TAG:-latest}"
|
||||
INSTALL_DIR="${INSTALL_DIR:-/usr/local/bin}"
|
||||
SERVICE_NAME="${SERVICE_NAME:-jboard-agent}"
|
||||
|
||||
Reference in New Issue
Block a user