mirror of
https://github.com/hi2shark/nazhua.git
synced 2026-01-11 22:50:42 +08:00
153 lines
6.0 KiB
Markdown
153 lines
6.0 KiB
Markdown
# Nazhua
|
||
基于哪吒监控(nezha.wiki)v0版本构建的前端主题，目前暂不支持v1版本，关于v1支持需要等待后续版本。
|
||
主题有点重，因为内置了`SarasaTermSC-SemiBold`字体。
|
||
|
||
## 劝退指南 用前必读
|
||
1. 本主题是基于哪吒监控v0版本构建的，不支持v1版本。*未来根据情况可能会支持v1版本*
|
||
2. 本主题是一个纯前端项目，需要解决跨域问题，通常需要一个nginx或者caddy反代请求解决跨域问题。
|
||
3. 我不会提供任何技术支持，如果你有问题，可以提issue，但是我不保证会回答，可能询问GPT会更快。
|
||
|
||
## 关于点阵地图
|
||
点阵地图是一个失真的地图，地图边际与城市位置都不是真实的经纬度坐标，因此无法通过经纬度来定位城市。
|
||
需要在是[Nazhua配置生成器](https://hi2shark.github.io/nazhua-generator/)中，拾取点阵地图上的坐标，然后在`config.js`中配置`customCodeMap`来自定义地图点信息。
|
||
如何指定节点的地理位置？
|
||
在哪吒监控后台，给节点的公开备注对象中，添加一个`customData`对象，并指定`location`的代码；
|
||
关于都有哪些内置的地理位置代码，需要在[Nazhua配置生成器](https://hi2shark.github.io/nazhua-generator/)中查看。
|
||
示例
|
||
```json
|
||
{
|
||
"customData": {
|
||
"location": "HKG"
|
||
}
|
||
}
|
||
```
|
||
对于几个我常见的国别位置，添加了默认映射位置，会自动显示在地图上。（美国太大了，就默认显示在最常买的位置：洛杉矶）
|
||
|
||
## 关于节点slogan和购买链接
|
||
同时，这个`customData`中还可以添加一项`slogan`和`orderLink`字符串，分别用于显示节点的标语和购买链接。
|
||
```json
|
||
{
|
||
"customData": {
|
||
"location": "HKG",
|
||
"slogan": "这是一个香港节点",
|
||
"orderLink": "https://buy.hkvps.com"
|
||
}
|
||
}
|
||
```
|
||
|
||
## 数据来源
|
||
1. 公开的全量配置，其中包括“公开备注”（PublicNote），来着探针主页上暴露的服务器节点列表配置信息。此处是根据正则匹配的方式，获取到的节点列表。在主题项目中，默认将访问`/nezha/`的指向此处。
|
||
2. 实时数据，来着公开的ws服务接口，`/ws`。
|
||
3. 监控数据，来着公开的api接口，`/api/v1/monitor/${id}`。
|
||
|
||
## 部署
|
||
Nazhua主题是一个纯前端项目，可以部署在纯静态服务器上，但需要解决`/api/v1/monitor/${id}`监控数据、`/ws`WS服务和`/`主页的跨域访问。
|
||
通常来说，你需要一个nginx或者caddy反代请求解决跨域问题。
|
||
|
||
### Docker Compose + Cloudflare Tunnels部署
|
||
**请关注备注中的提示内容**
|
||
```yaml
|
||
services:
|
||
nazhua:
|
||
image: ghcr.io/hi2shark/nazhua:latest
|
||
container_name: nazhua
|
||
ports:
|
||
- 80:80
|
||
volumes:
|
||
# - ./favicon.ico:/home/wwwroot/html/favicon.ico:ro # 自定义favicon图标
|
||
# - ./config.js:/home/wwwroot/html/config.js:ro # 自定义配置文件
|
||
# - ./style.css:/home/wwwroot/html/style.css:ro # 自定义样式文件
|
||
environment:
|
||
- DOMAIN=_ # 监听的域名，默认为_（监听所有）
|
||
- NEZHA=http://nezha-dashboard.example.com/ # 可以被反代nezha主页地址
|
||
restart: unless-stopped
|
||
```
|
||
建议通过docker-compose部署服务，然后通过cloudflare的tunnels向外提供服务，可以不用自己配置https证书。
|
||
|
||
### Nginx配置示例
|
||
```nginx
|
||
server {
|
||
listen 80;
|
||
server_name nazhua.example.com;
|
||
|
||
location /ws {
|
||
proxy_pass http://nezha-dashboard.example.com/ws;
|
||
proxy_http_version 1.1;
|
||
proxy_set_header Upgrade $http_upgrade;
|
||
proxy_set_header Connection "upgrade";
|
||
proxy_set_header Host $host;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
}
|
||
|
||
location /api {
|
||
proxy_pass http://nezha-dashboard.example.com/api;
|
||
proxy_set_header Host $host;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header X-Forwarded-Proto $scheme;
|
||
}
|
||
|
||
location /nezha/ {
|
||
proxy_pass http://nezha-dashboard.example.com/;
|
||
proxy_set_header Host $host;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header X-Forwarded-Proto $scheme;
|
||
}
|
||
|
||
location / {
|
||
root /home/wwwroot/html;
|
||
}
|
||
}
|
||
```
|
||
|
||
|
||
## 自定义配置
|
||
可以通过修改根目录下的`config.js`文件来自定义配置
|
||
例如：(*参考内容在文档上不一定是最新，具体参考public/config.js或者[Nazhua配置生成器](https://hi2shark.github.io/nazhua-generator/)*)
|
||
```javascript
|
||
window.$$nazhuaConfig = {
|
||
title: '哪吒监控', // 网站标题
|
||
freeAmount: '', // 免费服务的费用名称
|
||
infinityCycle: '', // 无限周期名称
|
||
hideListItemBill: false, // 隐藏列表项的账单信息
|
||
buyBtnText: '', // 购买按钮文案
|
||
hideWorldMap: false, // 隐藏地图
|
||
hideHomeWorldMap: false, // 隐藏首页地图
|
||
hideDetailWorldMap: false, // 隐藏详情地图
|
||
hideFilter: false, // 隐藏筛选
|
||
hideTag: false, // 隐藏标签
|
||
customCodeMap: {}, // 自定义的地图点信息
|
||
apiMonitorPath: '/api/v1/monitor/{id}',
|
||
wsPath: '/ws',
|
||
nezhaPath: '/nezha/',
|
||
nezhaV0ConfigType: 'servers',
|
||
routeMode: 'h5', // 路由模式 h5 | hash
|
||
};
|
||
```
|
||
可以通过修改根目录下的`style.css`文件来自定义样式
|
||
例如：
|
||
```css
|
||
:root {
|
||
/* 修改颜色 */
|
||
/* 地图上标记点的颜色 */
|
||
--world-map-point-color: #fff;
|
||
/* 列表项显示的价格颜色 */
|
||
--list-item-price-color: #ff6;
|
||
/* 购买链接的主要颜色 */
|
||
--list-item-buy-link-color: #f00;
|
||
}
|
||
```
|
||
可以通过[Nazhua配置生成器](https://hi2shark.github.io/nazhua-generator/)快速生成config.js配置文件
|
||
|
||
|
||
## 二次开发提示
|
||
`.env.development.local`配置变量
|
||
```bash
|
||
WS_HOST=http://127.0.0.1:9288 # 本地nezha ws反代
|
||
API_HOST=http://nezha-dashboard.example.com # 本地nezha api反代
|
||
NEZHA_HOST=http://nezha-dashboard.example.com # 本地nezha主页反代
|
||
NEZHA_HOST_REPACE_PATH=1 # 是否替换主页路径`/nezha/`
|
||
```
|