Add Nezha server with Argo English readme.

2023-08-07 18:00:50 +00:00
parent 72c1d27d11
commit a43d78002b
3 changed files with 302 additions and 19 deletions
@@ -1,11 +1,11 @@
-# Nezha server over Argo tunnel 
-使用 Argo 隧道的哪吒服务端
+# 使用 Argo 隧道的哪吒服务端
+
 贡献者:  
 + [fscarmen](https://github.com/fscarmen2)

 项目地址：[Argo-Nezha-Service-Container](https://github.com/fscarmen2/Argo-Nezha-Service-Container)  

-镜像备份（非实时更新）：[Argo-Nezha-Service-Container](https://github.com/nezhahq/Argo-Nezha-Service-Container)  
+镜像备份（非实时更新）：[Argo-Nezha-Service-Container](https://github.com/nezhahq/Argo-Nezha-Service-Container)
 * * *

 # 目录
@@ -16,6 +16,10 @@
 - [VPS 部署实例](case5.md#VPS-部署实例)
 - [客户端接入](case5.md#客户端接入)
 - [SSH 接入](case5.md#ssh-接入)
+- [自动还原备份](case5.md#自动还原备份)
+- [手动还原备份](case5.md#手动还原备份)
+- [完美搬家](case5.md#完美搬家)
+- [主体目录文件及说明](case5.md#主体目录文件及说明)
 - [鸣谢下列作者的文章和项目](case5.md#鸣谢下列作者的文章和项目)
 - [免责声明](case5.md#免责声明)

@@ -23,14 +27,16 @@

 ## 项目特点:
 * 适用范围更广 --- 只要能连通网络，就能安装哪吒服务端，如 Nas 虚拟机 , Container PaaS 等
-* Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法
+* Argo 隧道突破需要公网入口的限制 --- 传统的哪吒需要有两个公网端口，一个用于面板的访问，另一个用于客户端上报数据，本项目借用 Cloudflare Argo 隧道，使用内网穿透的办法
 * IPv4 / v6 具备更高的灵活性 --- 传统哪吒需要处理服务端和客户端的 IPv4/v6 兼容性问题，还需要通过 warp 等工具来解决不对应的情况。然而，本项目可以完全不需要考虑这些问题，可以任意对接，更加方便和简便
 * 一条 Argo 隧道分流多个域名和协议 --- 建立一条内网穿透的 Argo 隧道，即可分流三个域名(hostname)和协议(protocal)，分别用于面板的访问(http)，客户端上报数据(tcp)和 ssh（可选）
 * Nginx 反向代理的 gRPC 数据端口 --- 配上证书做 tls 终结，然后 Argo 的隧道配置用 https 服务指向这个反向代理，启用http2回源，grpc(nezha)->h2(nginx)->argo->cf cdn edge->agent
-* 每天自动备份 --- 每天 0 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 30 天数据；鉴于内容十分重要，必须要放在私库
+* 每天自动备份 --- 北京时间每天 4 时 0 分自动备份整个哪吒面板文件夹到指定的 github 私库，包括面板主题，面板设置，探针数据和隧道信息，备份保留近 5 天数据；鉴于内容十分重要，必须要放在私库
+* 手/自一体还原备份 --- 每分钟检测一次在线还原文件的内容，遇到有更新立刻还原
+* 默认内置本机探针 --- 能很方便的监控自身服务器信息
 * 数据更安全 --- Argo 隧道使用TLS加密通信，可以将应用程序流量安全地传输到 Cloudflare 网络，提高了应用程序的安全性和可靠性。此外，Argo Tunnel也可以防止IP泄露和DDoS攻击等网络威胁

-<img width="1298" alt="image" src="https://user-images.githubusercontent.com/92626977/233363248-e2caa687-b513-448c-a92f-c870db0e4236.png">
+<img width="1298" alt="image" src="https://github.com/fscarmen2/Argo-Nezha-Service-Container/assets/92626977/6535a060-2138-4c72-9ffa-1175dc6f5c25.png">


 ## 准备需要用的变量
@@ -38,13 +44,13 @@

 <img width="1040" alt="image" src="https://user-images.githubusercontent.com/92626977/231084930-02e3c2de-c52b-420d-b39c-9f135d040b3b.png">

-* 到 Cloudflare 官方，在相应的域名 `DNS` 记录里加上客户端上报数据(tcp)和 ssh（可选）的域名，打开橙色云启用 CDN
+* 到 Cloudflare 官网，在相应的域名 `DNS` 记录里加上客户端上报数据(tcp)和 ssh（可选）的域名，打开橙色云启用 CDN

-<img width="1666" alt="image" src="https://user-images.githubusercontent.com/92626977/231087110-85ddab87-076b-45c9-97d1-c8b051dcb5b0.png">
+<img width="1651" alt="image" src="https://github.com/fscarmen2/Argo-Nezha-Service-Container/assets/92626977/d5efb33d-b2a3-484c-b058-346c3e229088">

-<img width="1627" alt="image" src="https://user-images.githubusercontent.com/92626977/231087714-e5a45eb9-bc47-4c38-8f5b-a4a9fb492d0d.png">
+<img width="1618" alt="image" src="https://github.com/fscarmen2/Argo-Nezha-Service-Container/assets/92626977/c44b638f-9984-47a7-a342-166549f6092e">

-* 到 Cloudflare 官方，选择使用的域名，打开 `网络` 选项将 `gRPC` 开关打开
+* 到 Cloudflare 官网，选择使用的域名，打开 `网络` 选项将 `gRPC` 开关打开

 <img width="1590" alt="image" src="https://user-images.githubusercontent.com/92626977/233138703-faab8596-a64a-40bb-afe6-52711489fbcf.png">

@@ -77,7 +83,8 @@
  | GH_USER        | 是 | github 的用户名，用于面板管理授权 |
  | GH_CLIENTID    | 是 | 在 github 上申请 |
  | GH_CLIENTSECRET| 是 | 在 github 上申请 |
-  | GH_REPO        | 否 | 在 github 上备份哪吒服务端数据库文件的库 |
+  | GH_BACKUP_USER  | 否 | 在 github 上备份哪吒服务端数据库的 github 用户名，不填则与面板管理授权的账户 GH_USER 一致  |
+  | GH_REPO        | 否 | 在 github 上备份哪吒服务端数据库文件的 github 库 |
  | GH_EMAIL       | 否 | github 的邮箱，用于备份的 git 推送到远程库 |
  | GH_PAT         | 否 | github 的 PAT |
  | ARGO_JSON      | 是 | 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json |
@@ -86,7 +93,9 @@
  | SSH_DOMAIN     | 否 | ssh 用的 argo 域名 |
  | SSH_PASSWORD   | 否 | ssh 的密码，只有在设置 SSH_JSON 后才生效，默认值 password |

-1.Koyeb
+Koyeb
+
+[![Deploy to Koyeb](https://www.koyeb.com/static/images/deploy/button.svg)](https://app.koyeb.com/deploy?type=docker&name=nezha&ports=80;http;/&env[GH_USER]=&env[GH_CLIENTID]=&env[GH_CLIENTSECRET]=&env[GH_REPO]=&env[GH_EMAIL]=&env[GH_PAT]=&env[ARGO_JSON]=&env[DATA_DOMAIN]=&env[WEB_DOMAIN]=&env[SSH_DOMAIN]=&env[SSH_PASSWORD]=&image=docker.io/fscarmen/argo-nezha)

 <img width="927" alt="image" src="https://user-images.githubusercontent.com/92626977/231088411-fbac3e6e-a8a6-4661-bcf8-7c777aa8ffeb.png">
 <img width="750" alt="image" src="https://user-images.githubusercontent.com/92626977/231088973-7134aefd-4c80-4559-8e40-17c3be11d27d.png">
@@ -98,15 +107,14 @@
 ## VPS 部署实例
 * 注意: ARGO_JSON= 后面需要有单引号，不能去掉
 * 如果 VPS 是 IPv6 only 的，请先安装 WARP IPv4 或者双栈: https://github.com/fscarmen/warp
+* 备份目录为当前路径的 dashboard 文件夹

 ### docker 部署

-
 ```
 docker run -dit \
           --name nezha_dashboard \
           --restart always \
-           -v ./dashboard:/dashboard \
           -e GH_USER=<填 github 用户名> \
           -e GH_EMAIL=<填 github 邮箱> \
           -e GH_PAT=<填获取的> \
@@ -129,8 +137,6 @@ services:
        image: fscarmen/argo-nezha
        container_name: nezha_dashboard
        restart: always
-        volumes:
-            - ./dashboard:/dashboard
        environment:
            - GH_USER=<填 github 用户名>
            - GH_EMAIL=<<填 github 邮箱>
@@ -166,14 +172,60 @@ curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -
 <img width="955" alt="image" src="https://user-images.githubusercontent.com/92626977/233350802-754624e0-8456-4353-8577-1f5385fb8723.png">


-## 
+## 自动还原备份
+* 把需要还原的文件名改到 github 备份库里的 `README.md`，定时服务会每分钟检测更新，并把上次同步的文件名记录在本地 `/dbfile` 处以与在线的文件内容作比对
+
+下图为以还原文件名为 `dashboard-2023-04-23-13:08:37.tar.gz` 作示例
+
+![image](https://user-images.githubusercontent.com/92626977/233822466-c24e94f6-ba8a-47c9-b77d-aa62a56cc929.png)
+
+
+## 手动还原备份
+* ssh 进入容器后运行，github 备份库里的 tar.gz 文件名，格式: dashboard-2023-04-22-21:42:10.tar.gz
+```
+bash /dashboard/restore.sh <文件名>
+```
+<img width="1209" alt="image" src="https://user-images.githubusercontent.com/92626977/233792709-fb37b79c-c755-4db1-96ec-1039309ff932.png">
+
+## 完美搬家
+* 备份原哪吒的 `/dashboard` 文件夹，压缩备份为 `dashboard.tar.gz` 文件
+```
+tar czvf dashboard.tar.gz /dashboard
+```
+* 下载文件并放入私库，这个私库名要与新哪吒 <GH_REPO> 完全一致，并把该库的 README.md 的内容编辑为 `dashboard.tar.gz`
+* 部署本项目新哪吒，完整填入变量即可。部署完成后，自动还原脚本会每分钟作检测，发现有新的内容即会自动还原，全程约 3 分钟
+
+
+## 主体目录文件及说明
+```
+.
+|-- dashboard
+|   |-- app                  # 哪吒面板主程序
+|   |-- argo.json            # Argo 隧道 json 文件，记录着使用隧道的信息
+|   |-- argo.yml             # Argo 隧道 yml 文件，用于在一同隧道下，根据不同域名来分流 web, gRPC 和 ssh 协议的作用
+|   |-- backup.sh            # 备份数据脚本
+|   |-- data
+|   |   |-- config.yaml      # 哪吒面板的配置，如 Github OAuth2 / gRPC 域名 / 端口 / 是否启用 TLS 等信息
+|   |   `-- sqlite.db        # SQLite 数据库文件，记录着面板设置的所有 severs 和 cron 等信息
+|   |-- entrypoint.sh        # 主脚本，容器运行后执行
+|   |-- nezha-agent          # 哪吒客户端，用于监控本地 localhost
+|   |-- nezha.csr            # SSL/TLS 证书签名请求
+|   |-- nezha.key            # SSL/TLS 证书的私钥信息
+|   |-- nezha.pem            # SSL/TLS 隐私增强邮件
+|   `-- restore.sh           # 还原备份脚本
+`-- dbfile                   # 记录最新的还原或备份文件名
+```
+
+
 ## 鸣谢下列作者的文章和项目:
 * 热心的朝阳群众 Robin，讨论哪吒服务端与客户端的关系，从而诞生了此项目
 * 哪吒官网: https://nezha.wiki/ , TG 群: https://t.me/nezhamonitoring
 * 共穷国际老中医: http://solitud.es/
 * Akkia's Blog: https://blog.akkia.moe/
+* HiFeng's Blog: https://www.hicairo.com/
 * 用 Cloudflare Tunnel 进行内网穿透: https://blog.outv.im/2021/cloudflared-tunnel/

+
 ## 免责声明:
 * 本程序仅供学习了解, 非盈利目的，请于下载后 24 小时内删除, 不得用作任何商业用途, 文字、数据及图片均有所属版权, 如转载须注明来源。
-* 使用本程序必循遵守部署免责声明。使用本程序必循遵守部署服务器所在地、所在国家和用户所在国家的法律法规, 程序作者不对使用者任何不当行为负责。
+* 使用本程序必循遵守部署免责声明。使用本程序必循遵守部署服务器所在地、所在国家和用户所在国家的法律法规, 程序作者不对使用者任何不当行为负责。