From 1b2bc3ac68940aefbb20c44869ec0e246788ff66 Mon Sep 17 00:00:00 2001 From: naiba Date: Sat, 2 Dec 2023 16:27:14 +0000 Subject: [PATCH] deploy: 5e2d707c3889a19a3c718288c31bbc68b919ab6d --- 404.html | 2 +- ....10924026.js => case_case1.md.6f827984.js} | 2 +- ...lean.js => case_case1.md.6f827984.lean.js} | 2 +- ....98fa8429.js => case_case2.md.0f994f85.js} | 2 +- ...lean.js => case_case2.md.0f994f85.lean.js} | 2 +- ....8673f8b5.js => case_case3.md.2815791d.js} | 2 +- ...lean.js => case_case3.md.2815791d.lean.js} | 2 +- ....69b133d8.js => case_case4.md.3d19dff7.js} | 2 +- ...lean.js => case_case4.md.3d19dff7.lean.js} | 2 +- assets/case_case5.md.895ea2d3.js | 47 +++++++++++++++ assets/case_case5.md.895ea2d3.lean.js | 1 + assets/case_case5.md.93900c94.js | 53 ----------------- assets/case_case5.md.93900c94.lean.js | 1 - ....0419435e.js => case_index.md.e7243c50.js} | 2 +- ...lean.js => case_index.md.e7243c50.lean.js} | 2 +- ...673e.js => developer_index.md.0a6fbe67.js} | 2 +- ...js => developer_index.md.0a6fbe67.lean.js} | 2 +- ...b7f23.js => developer_l10n.md.06ab96bd.js} | 2 +- ....js => developer_l10n.md.06ab96bd.lean.js} | 2 +- ...687e.js => developer_theme.md.8c7acb53.js} | 2 +- ...js => developer_theme.md.8c7acb53.lean.js} | 2 +- ...188.js => en_US_case_case1.md.628438cc.js} | 2 +- ...s => en_US_case_case1.md.628438cc.lean.js} | 2 +- ...080.js => en_US_case_case2.md.c9576b87.js} | 2 +- ...s => en_US_case_case2.md.c9576b87.lean.js} | 2 +- ...4c8.js => en_US_case_case3.md.a5875c00.js} | 2 +- ...s => en_US_case_case3.md.a5875c00.lean.js} | 2 +- ...e31.js => en_US_case_case4.md.b3a4b972.js} | 2 +- ...s => en_US_case_case4.md.b3a4b972.lean.js} | 2 +- assets/en_US_case_case5.md.3404425e.js | 47 +++++++++++++++ assets/en_US_case_case5.md.3404425e.lean.js | 1 + assets/en_US_case_case5.md.635f3c8f.js | 53 ----------------- assets/en_US_case_case5.md.635f3c8f.lean.js | 1 - ...cf1.js => en_US_case_index.md.464e1cf1.js} | 2 +- ...s => en_US_case_index.md.464e1cf1.lean.js} | 2 +- ...s => en_US_developer_index.md.5e431eca.js} | 2 +- ...en_US_developer_index.md.5e431eca.lean.js} | 2 +- ...js => en_US_developer_l10n.md.88ba36b5.js} | 2 +- ... en_US_developer_l10n.md.88ba36b5.lean.js} | 2 +- ...s => en_US_developer_theme.md.ab8eaaf4.js} | 2 +- ...en_US_developer_theme.md.ab8eaaf4.lean.js} | 2 +- ...f7.js => en_US_guide_agent.md.6683a40f.js} | 2 +- ... => en_US_guide_agent.md.6683a40f.lean.js} | 2 +- ...3.js => en_US_guide_agentq.md.f3d60b04.js} | 2 +- ...=> en_US_guide_agentq.md.f3d60b04.lean.js} | 2 +- ...89f2.js => en_US_guide_api.md.7c016679.js} | 2 +- ...js => en_US_guide_api.md.7c016679.lean.js} | 2 +- ...s => en_US_guide_dashboard.md.7413067e.js} | 2 +- ...en_US_guide_dashboard.md.7413067e.lean.js} | 2 +- ... => en_US_guide_dashboardq.md.ac655fb7.js} | 2 +- ...n_US_guide_dashboardq.md.ac655fb7.lean.js} | 2 +- ...3.js => en_US_guide_loginq.md.2cd38989.js} | 2 +- ...=> en_US_guide_loginq.md.2cd38989.lean.js} | 2 +- ... en_US_guide_notifications.md.c66257b2.js} | 2 +- ...S_guide_notifications.md.c66257b2.lean.js} | 2 +- ...5499d.js => en_US_guide_q2.md.ef5213fa.js} | 2 +- ....js => en_US_guide_q2.md.ef5213fa.lean.js} | 2 +- ...79386.js => en_US_guide_q3.md.9878dfb9.js} | 2 +- ....js => en_US_guide_q3.md.9878dfb9.lean.js} | 2 +- ...c7d75.js => en_US_guide_q4.md.39c1f69c.js} | 2 +- ....js => en_US_guide_q4.md.39c1f69c.lean.js} | 2 +- ...8c8cd.js => en_US_guide_q5.md.ab9624d6.js} | 2 +- ....js => en_US_guide_q5.md.ab9624d6.lean.js} | 2 +- ...100ad.js => en_US_guide_q6.md.d8f23d35.js} | 2 +- ....js => en_US_guide_q6.md.d8f23d35.lean.js} | 2 +- ...0e21a.js => en_US_guide_q7.md.1a0316cc.js} | 2 +- ....js => en_US_guide_q7.md.1a0316cc.lean.js} | 2 +- ....js => en_US_guide_servers.md.19b9de10.js} | 2 +- ...> en_US_guide_servers.md.19b9de10.lean.js} | 2 +- ...js => en_US_guide_services.md.88b6205c.js} | 2 +- ... en_US_guide_services.md.88b6205c.lean.js} | 2 +- ...js => en_US_guide_settings.md.1abc055b.js} | 2 +- ... en_US_guide_settings.md.1abc055b.lean.js} | 2 +- ...40.js => en_US_guide_tasks.md.dfe9cb41.js} | 2 +- ... => en_US_guide_tasks.md.dfe9cb41.lean.js} | 2 +- ...56b31086.js => en_US_index.md.99e7e7d6.js} | 2 +- ...ean.js => en_US_index.md.99e7e7d6.lean.js} | 2 +- ...1cf2f21a.js => guide_agent.md.85008d4e.js} | 2 +- ...ean.js => guide_agent.md.85008d4e.lean.js} | 2 +- ...b93c69b.js => guide_agentq.md.e4748933.js} | 2 +- ...an.js => guide_agentq.md.e4748933.lean.js} | 2 +- ...d.b4d4c043.js => guide_api.md.10955d00.js} | 2 +- ....lean.js => guide_api.md.10955d00.lean.js} | 2 +- ...f029.js => guide_dashboard.md.cf138dd1.js} | 2 +- ...js => guide_dashboard.md.cf138dd1.lean.js} | 2 +- ...e44.js => guide_dashboardq.md.9e79f90f.js} | 2 +- ...s => guide_dashboardq.md.9e79f90f.lean.js} | 2 +- ...4973bfb.js => guide_loginq.md.dd090780.js} | 2 +- ...an.js => guide_loginq.md.dd090780.lean.js} | 2 +- ....js => guide_notifications.md.f36c695a.js} | 2 +- ...> guide_notifications.md.f36c695a.lean.js} | 2 +- ...md.ba9dbf6b.js => guide_q1.md.97e2cb27.js} | 2 +- ...b.lean.js => guide_q1.md.97e2cb27.lean.js} | 2 +- ...md.abd5be0b.js => guide_q2.md.27a2f8de.js} | 2 +- ...b.lean.js => guide_q2.md.27a2f8de.lean.js} | 2 +- ...md.ab30d47b.js => guide_q3.md.ac1531fd.js} | 2 +- ...b.lean.js => guide_q3.md.ac1531fd.lean.js} | 2 +- ...md.74ddc32e.js => guide_q4.md.1e055927.js} | 2 +- ...e.lean.js => guide_q4.md.1e055927.lean.js} | 2 +- ...md.94b09336.js => guide_q5.md.1499e8bb.js} | 2 +- ...6.lean.js => guide_q5.md.1499e8bb.lean.js} | 2 +- ...md.242c74d0.js => guide_q6.md.5919ae50.js} | 2 +- ...0.lean.js => guide_q6.md.5919ae50.lean.js} | 2 +- ...md.6e5b4509.js => guide_q7.md.110e0752.js} | 2 +- ...9.lean.js => guide_q7.md.110e0752.lean.js} | 2 +- ...593d54.js => guide_servers.md.5c3323d1.js} | 2 +- ...n.js => guide_servers.md.5c3323d1.lean.js} | 2 +- ...14a7e.js => guide_services.md.e571bf06.js} | 2 +- ....js => guide_services.md.e571bf06.lean.js} | 2 +- ...29b8c.js => guide_settings.md.eddaca0c.js} | 2 +- ....js => guide_settings.md.eddaca0c.lean.js} | 2 +- ...00d2bf18.js => guide_tasks.md.aae399a8.js} | 2 +- ...ean.js => guide_tasks.md.aae399a8.lean.js} | 2 +- ...ex.md.3437873f.js => index.md.7decbfa6.js} | 2 +- ...873f.lean.js => index.md.7decbfa6.lean.js} | 2 +- case/case1.html | 6 +- case/case2.html | 6 +- case/case3.html | 6 +- case/case4.html | 6 +- case/case5.html | 58 +++++++++---------- case/index.html | 4 +- developer/index.html | 4 +- developer/l10n.html | 6 +- developer/theme.html | 6 +- en_US/case/case1.html | 6 +- en_US/case/case2.html | 6 +- en_US/case/case3.html | 6 +- en_US/case/case4.html | 6 +- en_US/case/case5.html | 58 +++++++++---------- en_US/case/index.html | 4 +- en_US/developer/index.html | 4 +- en_US/developer/l10n.html | 6 +- en_US/developer/theme.html | 6 +- en_US/guide/agent.html | 6 +- en_US/guide/agentq.html | 6 +- en_US/guide/api.html | 6 +- en_US/guide/dashboard.html | 6 +- en_US/guide/dashboardq.html | 6 +- en_US/guide/loginq.html | 6 +- en_US/guide/notifications.html | 6 +- en_US/guide/q2.html | 6 +- en_US/guide/q3.html | 6 +- en_US/guide/q4.html | 6 +- en_US/guide/q5.html | 6 +- en_US/guide/q6.html | 6 +- en_US/guide/q7.html | 6 +- en_US/guide/servers.html | 6 +- en_US/guide/services.html | 6 +- en_US/guide/settings.html | 6 +- en_US/guide/tasks.html | 6 +- en_US/index.html | 4 +- guide/agent.html | 6 +- guide/agentq.html | 6 +- guide/api.html | 6 +- guide/dashboard.html | 6 +- guide/dashboardq.html | 6 +- guide/loginq.html | 6 +- guide/notifications.html | 6 +- guide/q1.html | 6 +- guide/q2.html | 6 +- guide/q3.html | 6 +- guide/q4.html | 6 +- guide/q5.html | 6 +- guide/q6.html | 6 +- guide/q7.html | 6 +- guide/servers.html | 6 +- guide/services.html | 6 +- guide/settings.html | 6 +- guide/tasks.html | 6 +- hashmap.json | 2 +- index.html | 4 +- 171 files changed, 409 insertions(+), 433 deletions(-) rename assets/{case_case1.md.10924026.js => case_case1.md.6f827984.js} (95%) rename assets/{case_case1.md.10924026.lean.js => case_case1.md.6f827984.lean.js} (85%) rename assets/{case_case2.md.98fa8429.js => case_case2.md.0f994f85.js} (97%) rename assets/{case_case2.md.98fa8429.lean.js => case_case2.md.0f994f85.lean.js} (87%) rename assets/{case_case3.md.8673f8b5.js => case_case3.md.2815791d.js} (98%) rename assets/{case_case3.md.8673f8b5.lean.js => case_case3.md.2815791d.lean.js} (86%) rename assets/{case_case4.md.69b133d8.js => case_case4.md.3d19dff7.js} (94%) rename assets/{case_case4.md.69b133d8.lean.js => case_case4.md.3d19dff7.lean.js} (79%) create mode 100644 assets/case_case5.md.895ea2d3.js create mode 100644 assets/case_case5.md.895ea2d3.lean.js delete mode 100644 assets/case_case5.md.93900c94.js delete mode 100644 assets/case_case5.md.93900c94.lean.js rename assets/{case_index.md.0419435e.js => case_index.md.e7243c50.js} (88%) rename assets/{case_index.md.0419435e.lean.js => case_index.md.e7243c50.lean.js} (88%) rename assets/{developer_index.md.fb38673e.js => developer_index.md.0a6fbe67.js} (92%) rename assets/{developer_index.md.fb38673e.lean.js => developer_index.md.0a6fbe67.lean.js} (92%) rename assets/{developer_l10n.md.e16b7f23.js => developer_l10n.md.06ab96bd.js} (95%) rename assets/{developer_l10n.md.e16b7f23.lean.js => developer_l10n.md.06ab96bd.lean.js} (84%) rename assets/{developer_theme.md.5883687e.js => developer_theme.md.8c7acb53.js} (96%) rename assets/{developer_theme.md.5883687e.lean.js => developer_theme.md.8c7acb53.lean.js} (84%) rename assets/{en_US_case_case1.md.9a8ad188.js => en_US_case_case1.md.628438cc.js} (95%) rename assets/{en_US_case_case1.md.9a8ad188.lean.js => en_US_case_case1.md.628438cc.lean.js} (86%) rename assets/{en_US_case_case2.md.77f26080.js => en_US_case_case2.md.c9576b87.js} (97%) rename assets/{en_US_case_case2.md.77f26080.lean.js => en_US_case_case2.md.c9576b87.lean.js} (87%) rename assets/{en_US_case_case3.md.c8bf14c8.js => en_US_case_case3.md.a5875c00.js} (98%) rename assets/{en_US_case_case3.md.c8bf14c8.lean.js => en_US_case_case3.md.a5875c00.lean.js} (87%) rename assets/{en_US_case_case4.md.87565e31.js => en_US_case_case4.md.b3a4b972.js} (94%) rename assets/{en_US_case_case4.md.87565e31.lean.js => en_US_case_case4.md.b3a4b972.lean.js} (85%) create mode 100644 assets/en_US_case_case5.md.3404425e.js create mode 100644 assets/en_US_case_case5.md.3404425e.lean.js delete mode 100644 assets/en_US_case_case5.md.635f3c8f.js delete mode 100644 assets/en_US_case_case5.md.635f3c8f.lean.js rename assets/{en_US_case_index.md.51e3fcf1.js => en_US_case_index.md.464e1cf1.js} (95%) rename assets/{en_US_case_index.md.51e3fcf1.lean.js => en_US_case_index.md.464e1cf1.lean.js} (95%) rename assets/{en_US_developer_index.md.494894a7.js => en_US_developer_index.md.5e431eca.js} (91%) rename assets/{en_US_developer_index.md.494894a7.lean.js => en_US_developer_index.md.5e431eca.lean.js} (91%) rename assets/{en_US_developer_l10n.md.f30e1696.js => en_US_developer_l10n.md.88ba36b5.js} (96%) rename assets/{en_US_developer_l10n.md.f30e1696.lean.js => en_US_developer_l10n.md.88ba36b5.lean.js} (85%) rename assets/{en_US_developer_theme.md.fec1d800.js => en_US_developer_theme.md.ab8eaaf4.js} (96%) rename assets/{en_US_developer_theme.md.fec1d800.lean.js => en_US_developer_theme.md.ab8eaaf4.lean.js} (84%) rename assets/{en_US_guide_agent.md.27bff8f7.js => en_US_guide_agent.md.6683a40f.js} (99%) rename assets/{en_US_guide_agent.md.27bff8f7.lean.js => en_US_guide_agent.md.6683a40f.lean.js} (84%) rename assets/{en_US_guide_agentq.md.eb2f5013.js => en_US_guide_agentq.md.f3d60b04.js} (96%) rename assets/{en_US_guide_agentq.md.eb2f5013.lean.js => en_US_guide_agentq.md.f3d60b04.lean.js} (84%) rename assets/{en_US_guide_api.md.5bfd89f2.js => en_US_guide_api.md.7c016679.js} (99%) rename assets/{en_US_guide_api.md.5bfd89f2.lean.js => en_US_guide_api.md.7c016679.lean.js} (84%) rename assets/{en_US_guide_dashboard.md.d3da906a.js => en_US_guide_dashboard.md.7413067e.js} (99%) rename assets/{en_US_guide_dashboard.md.d3da906a.lean.js => en_US_guide_dashboard.md.7413067e.lean.js} (85%) rename assets/{en_US_guide_dashboardq.md.60106923.js => en_US_guide_dashboardq.md.ac655fb7.js} (98%) rename assets/{en_US_guide_dashboardq.md.60106923.lean.js => en_US_guide_dashboardq.md.ac655fb7.lean.js} (70%) rename assets/{en_US_guide_loginq.md.6e1954e3.js => en_US_guide_loginq.md.2cd38989.js} (98%) rename assets/{en_US_guide_loginq.md.6e1954e3.lean.js => en_US_guide_loginq.md.2cd38989.lean.js} (84%) rename assets/{en_US_guide_notifications.md.88d86f03.js => en_US_guide_notifications.md.c66257b2.js} (99%) rename assets/{en_US_guide_notifications.md.88d86f03.lean.js => en_US_guide_notifications.md.c66257b2.lean.js} (71%) rename assets/{en_US_guide_q2.md.d795499d.js => en_US_guide_q2.md.ef5213fa.js} (96%) rename assets/{en_US_guide_q2.md.d795499d.lean.js => en_US_guide_q2.md.ef5213fa.lean.js} (84%) rename assets/{en_US_guide_q3.md.0d779386.js => en_US_guide_q3.md.9878dfb9.js} (99%) rename assets/{en_US_guide_q3.md.0d779386.lean.js => en_US_guide_q3.md.9878dfb9.lean.js} (84%) rename assets/{en_US_guide_q4.md.847c7d75.js => en_US_guide_q4.md.39c1f69c.js} (94%) rename assets/{en_US_guide_q4.md.847c7d75.lean.js => en_US_guide_q4.md.39c1f69c.lean.js} (94%) rename assets/{en_US_guide_q5.md.7df8c8cd.js => en_US_guide_q5.md.ab9624d6.js} (94%) rename assets/{en_US_guide_q5.md.7df8c8cd.lean.js => en_US_guide_q5.md.ab9624d6.lean.js} (94%) rename assets/{en_US_guide_q6.md.fe3100ad.js => en_US_guide_q6.md.d8f23d35.js} (95%) rename assets/{en_US_guide_q6.md.fe3100ad.lean.js => en_US_guide_q6.md.d8f23d35.lean.js} (84%) rename assets/{en_US_guide_q7.md.5d20e21a.js => en_US_guide_q7.md.1a0316cc.js} (97%) rename assets/{en_US_guide_q7.md.5d20e21a.lean.js => en_US_guide_q7.md.1a0316cc.lean.js} (84%) rename assets/{en_US_guide_servers.md.a92b7c67.js => en_US_guide_servers.md.19b9de10.js} (96%) rename assets/{en_US_guide_servers.md.a92b7c67.lean.js => en_US_guide_servers.md.19b9de10.lean.js} (70%) rename assets/{en_US_guide_services.md.c882e01a.js => en_US_guide_services.md.88b6205c.js} (98%) rename assets/{en_US_guide_services.md.c882e01a.lean.js => en_US_guide_services.md.88b6205c.lean.js} (85%) rename assets/{en_US_guide_settings.md.7d38802c.js => en_US_guide_settings.md.1abc055b.js} (99%) rename assets/{en_US_guide_settings.md.7d38802c.lean.js => en_US_guide_settings.md.1abc055b.lean.js} (85%) rename assets/{en_US_guide_tasks.md.e1820240.js => en_US_guide_tasks.md.dfe9cb41.js} (98%) rename assets/{en_US_guide_tasks.md.e1820240.lean.js => en_US_guide_tasks.md.dfe9cb41.lean.js} (84%) rename assets/{en_US_index.md.56b31086.js => en_US_index.md.99e7e7d6.js} (95%) rename assets/{en_US_index.md.56b31086.lean.js => en_US_index.md.99e7e7d6.lean.js} (95%) rename assets/{guide_agent.md.1cf2f21a.js => guide_agent.md.85008d4e.js} (99%) rename assets/{guide_agent.md.1cf2f21a.lean.js => guide_agent.md.85008d4e.lean.js} (84%) rename assets/{guide_agentq.md.4b93c69b.js => guide_agentq.md.e4748933.js} (96%) rename assets/{guide_agentq.md.4b93c69b.lean.js => guide_agentq.md.e4748933.lean.js} (84%) rename assets/{guide_api.md.b4d4c043.js => guide_api.md.10955d00.js} (99%) rename assets/{guide_api.md.b4d4c043.lean.js => guide_api.md.10955d00.lean.js} (84%) rename assets/{guide_dashboard.md.b839f029.js => guide_dashboard.md.cf138dd1.js} (99%) rename assets/{guide_dashboard.md.b839f029.lean.js => guide_dashboard.md.cf138dd1.lean.js} (70%) rename assets/{guide_dashboardq.md.5a078e44.js => guide_dashboardq.md.9e79f90f.js} (98%) rename assets/{guide_dashboardq.md.5a078e44.lean.js => guide_dashboardq.md.9e79f90f.lean.js} (70%) rename assets/{guide_loginq.md.c4973bfb.js => guide_loginq.md.dd090780.js} (98%) rename assets/{guide_loginq.md.c4973bfb.lean.js => guide_loginq.md.dd090780.lean.js} (84%) rename assets/{guide_notifications.md.e73d0084.js => guide_notifications.md.f36c695a.js} (99%) rename assets/{guide_notifications.md.e73d0084.lean.js => guide_notifications.md.f36c695a.lean.js} (85%) rename assets/{guide_q1.md.ba9dbf6b.js => guide_q1.md.97e2cb27.js} (99%) rename assets/{guide_q1.md.ba9dbf6b.lean.js => guide_q1.md.97e2cb27.lean.js} (83%) rename assets/{guide_q2.md.abd5be0b.js => guide_q2.md.27a2f8de.js} (95%) rename assets/{guide_q2.md.abd5be0b.lean.js => guide_q2.md.27a2f8de.lean.js} (83%) rename assets/{guide_q3.md.ab30d47b.js => guide_q3.md.ac1531fd.js} (99%) rename assets/{guide_q3.md.ab30d47b.lean.js => guide_q3.md.ac1531fd.lean.js} (83%) rename assets/{guide_q4.md.74ddc32e.js => guide_q4.md.1e055927.js} (93%) rename assets/{guide_q4.md.74ddc32e.lean.js => guide_q4.md.1e055927.lean.js} (93%) rename assets/{guide_q5.md.94b09336.js => guide_q5.md.1499e8bb.js} (93%) rename assets/{guide_q5.md.94b09336.lean.js => guide_q5.md.1499e8bb.lean.js} (93%) rename assets/{guide_q6.md.242c74d0.js => guide_q6.md.5919ae50.js} (95%) rename assets/{guide_q6.md.242c74d0.lean.js => guide_q6.md.5919ae50.lean.js} (83%) rename assets/{guide_q7.md.6e5b4509.js => guide_q7.md.110e0752.js} (97%) rename assets/{guide_q7.md.6e5b4509.lean.js => guide_q7.md.110e0752.lean.js} (83%) rename assets/{guide_servers.md.bf593d54.js => guide_servers.md.5c3323d1.js} (95%) rename assets/{guide_servers.md.bf593d54.lean.js => guide_servers.md.5c3323d1.lean.js} (70%) rename assets/{guide_services.md.bc514a7e.js => guide_services.md.e571bf06.js} (98%) rename assets/{guide_services.md.bc514a7e.lean.js => guide_services.md.e571bf06.lean.js} (84%) rename assets/{guide_settings.md.47429b8c.js => guide_settings.md.eddaca0c.js} (99%) rename assets/{guide_settings.md.47429b8c.lean.js => guide_settings.md.eddaca0c.lean.js} (70%) rename assets/{guide_tasks.md.00d2bf18.js => guide_tasks.md.aae399a8.js} (98%) rename assets/{guide_tasks.md.00d2bf18.lean.js => guide_tasks.md.aae399a8.lean.js} (84%) rename assets/{index.md.3437873f.js => index.md.7decbfa6.js} (95%) rename assets/{index.md.3437873f.lean.js => index.md.7decbfa6.lean.js} (95%) diff --git a/404.html b/404.html index 3b5075f4..c4762232 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@
Skip to content

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
- diff --git a/assets/case_case1.md.10924026.js b/assets/case_case1.md.6f827984.js similarity index 95% rename from assets/case_case1.md.10924026.js rename to assets/case_case1.md.6f827984.js index 044c65ee..b1db1d1b 100644 --- a/assets/case_case1.md.10924026.js +++ b/assets/case_case1.md.6f827984.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1698375851000}'),o={name:"case/case1.md"},_=r('

自建一个TG机器人来查询服务器信息

贡献者:

项目地址:nezha_api_tgbot

镜像备份(非实时更新):nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

',5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; +import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1701534410000}'),o={name:"case/case1.md"},_=r('

自建一个TG机器人来查询服务器信息

贡献者:

项目地址:nezha_api_tgbot

镜像备份(非实时更新):nezha_api_tgbot
机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板

',5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; diff --git a/assets/case_case1.md.10924026.lean.js b/assets/case_case1.md.6f827984.lean.js similarity index 85% rename from assets/case_case1.md.10924026.lean.js rename to assets/case_case1.md.6f827984.lean.js index 16ea89cc..c7dbc34b 100644 --- a/assets/case_case1.md.10924026.lean.js +++ b/assets/case_case1.md.6f827984.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1698375851000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; +import{_ as e,o as t,c as a,R as r}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"自建一个TG机器人来查询服务器信息","description":"","frontmatter":{},"headers":[],"relativePath":"case/case1.md","filePath":"case/case1.md","lastUpdated":1701534410000}'),o={name:"case/case1.md"},_=r("",5),s=[_];function i(n,c,p,h,l,d){return t(),a("div",null,s)}const g=e(o,[["render",i]]);export{b as __pageData,g as default}; diff --git a/assets/case_case2.md.98fa8429.js b/assets/case_case2.md.0f994f85.js similarity index 97% rename from assets/case_case2.md.98fa8429.js rename to assets/case_case2.md.0f994f85.js index 5e006013..d2cf376d 100644 --- a/assets/case_case2.md.98fa8429.js +++ b/assets/case_case2.md.0f994f85.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1698375851000}'),o={name:"case/case2.md"},c=t('

在iOS/MacOS中使用Siri运行快捷指令查询服务器状态

当前版本:V1.0
贡献者:

获取快捷指令

使用iPhone或iPad扫描以下二维码,获取快捷指令

coode

MacOS用户请访问这里,获取快捷指令

使用说明

WARNING

每个快捷指令只能监控一台服务器,如需要监控多个服务器,请多次复制此快捷指令并分别配置,然后分别修改快捷指令名称,如;一号服务器状态、二号服务器状态等

',8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1701534410000}'),o={name:"case/case2.md"},c=t('

在iOS/MacOS中使用Siri运行快捷指令查询服务器状态

当前版本:V1.0
贡献者:

获取快捷指令

使用iPhone或iPad扫描以下二维码,获取快捷指令

coode

MacOS用户请访问这里,获取快捷指令

使用说明

WARNING

每个快捷指令只能监控一台服务器,如需要监控多个服务器,请多次复制此快捷指令并分别配置,然后分别修改快捷指令名称,如;一号服务器状态、二号服务器状态等

',8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case2.md.98fa8429.lean.js b/assets/case_case2.md.0f994f85.lean.js similarity index 87% rename from assets/case_case2.md.98fa8429.lean.js rename to assets/case_case2.md.0f994f85.lean.js index 630fee79..43752c12 100644 --- a/assets/case_case2.md.98fa8429.lean.js +++ b/assets/case_case2.md.0f994f85.lean.js @@ -1 +1 @@ -import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1698375851000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; +import{_ as a}from"./chunks/qrcode.59c44dde.js";import{_ as e,o as r,c as i,R as t}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"在iOS/MacOS中使用Siri运行快捷指令查询服务器状态","description":"","frontmatter":{},"headers":[],"relativePath":"case/case2.md","filePath":"case/case2.md","lastUpdated":1701534410000}'),o={name:"case/case2.md"},c=t("",8),s=[c];function l(d,n,h,_,p,m){return r(),i("div",null,s)}const S=e(o,[["render",l]]);export{b as __pageData,S as default}; diff --git a/assets/case_case3.md.8673f8b5.js b/assets/case_case3.md.2815791d.js similarity index 98% rename from assets/case_case3.md.8673f8b5.js rename to assets/case_case3.md.2815791d.js index 615d7285..dbaabb93 100644 --- a/assets/case_case3.md.8673f8b5.js +++ b/assets/case_case3.md.2815791d.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1698375851000}'),d={name:"case/case3.md"},l=r('

自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人

贡献者:

项目地址:nezha_telegram_bot

镜像备份(非实时更新):nezha_telegram_bot

项目特色

开源Telegram机器人项目,可以基于API实时查询哪吒面板的服务器信息。

命令列表

命令功能仅私聊
start开始使用键盘主菜单✔️
help帮助列表
add添加面板链接和token✔️
url添加面板链接✔️
token添加面板token✔️
info获取保存的面板链接和token✔️
delete删除保存的面板链接和token✔️
id命令后面添加整数id,来进行单个服务器信息查询(私聊带刷新按钮,群聊不带)
all查询所有服务器的统计信息
search在服务器名字中搜索关键字(支持多个,用空格分开)

效果展示

imageimage

',12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; +import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1701534410000}'),d={name:"case/case3.md"},l=r('

自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人

贡献者:

项目地址:nezha_telegram_bot

镜像备份(非实时更新):nezha_telegram_bot

项目特色

开源Telegram机器人项目,可以基于API实时查询哪吒面板的服务器信息。

命令列表

命令功能仅私聊
start开始使用键盘主菜单✔️
help帮助列表
add添加面板链接和token✔️
url添加面板链接✔️
token添加面板token✔️
info获取保存的面板链接和token✔️
delete删除保存的面板链接和token✔️
id命令后面添加整数id,来进行单个服务器信息查询(私聊带刷新按钮,群聊不带)
all查询所有服务器的统计信息
search在服务器名字中搜索关键字(支持多个,用空格分开)

效果展示

imageimage

',12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case3.md.8673f8b5.lean.js b/assets/case_case3.md.2815791d.lean.js similarity index 86% rename from assets/case_case3.md.8673f8b5.lean.js rename to assets/case_case3.md.2815791d.lean.js index d8ddcb7f..272ef7c0 100644 --- a/assets/case_case3.md.8673f8b5.lean.js +++ b/assets/case_case3.md.2815791d.lean.js @@ -1 +1 @@ -import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1698375851000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; +import{_ as t,o as e,c as a,R as r}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"自建使用 API 来进行查询,且支持多语言的 Telegram 查询机器人","description":"","frontmatter":{},"headers":[],"relativePath":"case/case3.md","filePath":"case/case3.md","lastUpdated":1701534410000}'),d={name:"case/case3.md"},l=r("",12),i=[l];function o(h,n,c,s,_,m){return e(),a("div",null,i)}const b=t(d,[["render",o]]);export{f as __pageData,b as default}; diff --git a/assets/case_case4.md.69b133d8.js b/assets/case_case4.md.3d19dff7.js similarity index 94% rename from assets/case_case4.md.69b133d8.js rename to assets/case_case4.md.3d19dff7.js index 6ecbf89f..a8675246 100644 --- a/assets/case_case4.md.69b133d8.js +++ b/assets/case_case4.md.3d19dff7.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1698375851000}'),_={name:"case/case4.md"},i=a('

重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑



2

还在因为自己的小鸡配置太差被朋友嘲笑吗?
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗?
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗?


今天开始!找回自信!

来自南京的名老中医 dysf888 独家秘方!让你找回男人本色,激情畅享!
安装 Fake Agent,可随意修改服务器监测数据的倍数上传到 Dashboard,让你的小鸡 脱!胎!换!骨! 让你在 MJJ 面前起来!

镜像备份(非实时更新):Fake Agent

哪吒监控创始人奶爸也在用:
5


男人用了都说好:
6
4



1

',12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; +import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1701534410000}'),_={name:"case/case4.md"},i=a('

重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑



2

还在因为自己的小鸡配置太差被朋友嘲笑吗?
还在想参加以针会友活动却因为小鸡不够排面而觉得羞耻吗?
还在因为在哪吒TG群里机器人排名太低而觉得自己低人一等吗?


今天开始!找回自信!

来自南京的名老中医 dysf888 独家秘方!让你找回男人本色,激情畅享!
安装 Fake Agent,可随意修改服务器监测数据的倍数上传到 Dashboard,让你的小鸡 脱!胎!换!骨! 让你在 MJJ 面前起来!

镜像备份(非实时更新):Fake Agent

哪吒监控创始人奶爸也在用:
5


男人用了都说好:
6
4



1

',12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; diff --git a/assets/case_case4.md.69b133d8.lean.js b/assets/case_case4.md.3d19dff7.lean.js similarity index 79% rename from assets/case_case4.md.69b133d8.lean.js rename to assets/case_case4.md.3d19dff7.lean.js index dbfbac87..b50ab7d3 100644 --- a/assets/case_case4.md.69b133d8.lean.js +++ b/assets/case_case4.md.3d19dff7.lean.js @@ -1 +1 @@ -import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1698375851000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; +import{_ as s,o as t,c as e,R as a}from"./chunks/framework.44fd0451.js";const r="/assets/2.38c2ea56.png",n="/assets/5.23139306.png",o="/assets/6.22a61698.png",p="/assets/4.fe6a4e7a.jpg",c="/assets/1.b4b4591f.jpeg",y=JSON.parse('{"title":"重磅推荐!一秒拥有宇宙级算力!让你在人前,不!再!自!卑","description":"","frontmatter":{},"headers":[],"relativePath":"case/case4.md","filePath":"case/case4.md","lastUpdated":1701534410000}'),_={name:"case/case4.md"},i=a("",12),l=[i];function g(f,b,h,m,d,k){return t(),e("div",null,l)}const z=s(_,[["render",g]]);export{y as __pageData,z as default}; diff --git a/assets/case_case5.md.895ea2d3.js b/assets/case_case5.md.895ea2d3.js new file mode 100644 index 00000000..77b5bba5 --- /dev/null +++ b/assets/case_case5.md.895ea2d3.js @@ -0,0 +1,47 @@ +import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1701534410000}'),l={name:"case/case5.md"},n=t(`

使用 Argo 隧道的哪吒服务端

贡献者:

项目地址:Argo-Nezha-Service-Container

镜像备份(非实时更新):Argo-Nezha-Service-Container


目录


项目特点:

image

准备需要用的变量

image

面板域名加上 https:// 开头,回调地址再加上 /oauth2/callback 结尾

imageimageimageimageimage

Argo 认证的获取方式: json 或 token

Argo 隧道认证方式有 json 和 token,使用两个方式其中之一。推荐前者,理由脚本会处理好所有的 Argo 隧道参数和路径,后者需要到 Cloudflare 官网手动设置,容易出错。

(方式 1 - Json):

通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc

image

(方式 2 - Token): 通过 Cloudflare 官网,手动生成 Argo 隧道 token 信息

到 cf 官网:https://dash.cloudflare.com/

imageimageimageimageimageimageimage

PaaS 部署实例

镜像 fscarmen/argo-nezha:latest , 支持 amd64 和 arm64 架构

用到的变量

变量名是否必须备注
GH_USERgithub 的用户名,用于面板管理授权
GH_CLIENTID在 github 上申请
GH_CLIENTSECRET在 github 上申请
GH_BACKUP_USER在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致
GH_REPO在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAILgithub 的邮箱,用于备份的 git 推送到远程库
GH_PATgithub 的 PAT
ARGO_AUTHJson: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取
ARGO_DOMAINArgo 域名

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS 部署方式 1 --- docker

docker 部署

docker run -dit \\
+           --name nezha_dashboard \\
+           --pull always \\
+           --restart always \\
+           -e GH_USER=<填 github 用户名> \\
+           -e GH_EMAIL=<填 github 邮箱> \\
+           -e GH_PAT=<填获取的> \\
+           -e GH_REPO=<填自定义的> \\
+           -e GH_CLIENTID=<填获取的>  \\
+           -e GH_CLIENTSECRET=<填获取的> \\
+           -e ARGO_AUTH='<填获取的 Argo json 或者 token>' \\
+           -e ARGO_DOMAIN=<填自定义的> \\
+           -e GH_BACKUP_USER=<如与 GH_USER 一致,可以不要该环境变量> \\
+           fscarmen/argo-nezha

docker-compose 部署

version: '3.8'
+services:
+    argo-nezha:
+        image: fscarmen/argo-nezha
+        pull: always
+        container_name: nezha_dashboard
+        restart: always
+        environment:
+            - GH_USER=<填 github 用户名>
+            - GH_EMAIL=<<填 github 邮箱>
+            - GH_PAT=<填获取的>
+            - GH_REPO=<填自定义的>
+            - GH_CLIENTID=<填获取的>
+            - GH_CLIENTSECRET=<填获取的>
+            - ARGO_AUTH='<填获取的 Argo json 或者 token>'
+            - ARGO_DOMAIN=<填自定义的>
+            - GH_BACKUP_USER=<如与 GH_USER 一致,可以不要该环境变量>

VPS 部署方式 2 --- 宿主机

bash <(wget -qO- https://raw.githubusercontent.com/fscarmen2/Argo-Nezha-Service-Container/main/dashboard.sh)

客户端接入

通过gRPC传输,无需额外配置。使用面板给到的安装方式,举例

curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh install_agent nezha.seales.nom.za 443 eAxO9IF519fKFODlW0 --tls

SSH 接入

<file path>/cloudflared access ssh --hostname nezha.seales.nom.za/<GH_CLIENTID>
imageimageimage

手动备份数据

方法一: 把 Github 备份库里的 README.md 文件内容改为 backup

image

方法二: ssh 进去后,容器版本运行 /dashboard/backup.sh; 非容器版本运行 /opt/nezha/dashboard/backup.sh

自动还原备份

下图为以还原文件名为 dashboard-2023-04-23-13:08:37.tar.gz 作示例

image

手动还原备份

bash /dashboard/restore.sh <文件名>
image

完美搬家

tar czvf dashboard.tar.gz /dashboard

主体目录文件及说明

/dashboard/
+|-- app                  # 哪吒面板主程序
+|-- argo.json            # Argo 隧道 json 文件,记录着使用隧道的信息
+|-- argo.yml             # Argo 隧道 yml 文件,用于在一同隧道下,根据不同域名来分流 web, gRPC 和 ssh 协议的作用
+|-- backup.sh            # 备份数据脚本
+|-- restore.sh           # 还原备份脚本
+|-- dbfile               # 记录最新的还原或备份文件名
+|-- resource             # 面板主题、语言和旗帜等资料的文件夹
+|-- data
+|   |-- config.yaml      # 哪吒面板的配置,如 Github OAuth2 / gRPC 域名 / 端口 / 是否启用 TLS 等信息
+|   \`-- sqlite.db        # SQLite 数据库文件,记录着面板设置的所有 severs 和 cron 等信息
+|-- entrypoint.sh        # 主脚本,容器运行后执行
+|-- nezha.csr            # SSL/TLS 证书签名请求
+|-- nezha.key            # SSL/TLS 证书的私钥信息
+|-- nezha.pem            # SSL/TLS 证书文件
+|-- cloudflared          # Cloudflare Argo 隧道主程序
+|-- grpcwebproxy         # gRPC 反代主程序
+\`-- nezha-agent          # 哪吒客户端,用于监控本地 localhost

鸣谢下列作者的文章和项目:

免责声明:

`,89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/case_case5.md.895ea2d3.lean.js b/assets/case_case5.md.895ea2d3.lean.js new file mode 100644 index 00000000..8c10b3e8 --- /dev/null +++ b/assets/case_case5.md.895ea2d3.lean.js @@ -0,0 +1 @@ +import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1701534410000}'),l={name:"case/case5.md"},n=t("",89),r=[n];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const u=a(l,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/case_case5.md.93900c94.js b/assets/case_case5.md.93900c94.js deleted file mode 100644 index 956f0413..00000000 --- a/assets/case_case5.md.93900c94.js +++ /dev/null @@ -1,53 +0,0 @@ -import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1698375851000}'),n={name:"case/case5.md"},l=t(`

使用 Argo 隧道的哪吒服务端

贡献者:

项目地址:Argo-Nezha-Service-Container

镜像备份(非实时更新):Argo-Nezha-Service-Container


目录


项目特点:

image

Argo 认证的获取方式: json 或 token

Argo 隧道认证方式有 json 和 token,使用两个方式其中之一

(方式 1 - Josn):

通过 Cloudflare Json 生成网轻松获取 Argo 隧道 json 信息: https://fscarmen.cloudflare.now.cc

image

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

imageimage

(方式 2 - Token): 通过 Cloudflare 官网,手动生成 Argo 隧道 token 信息

到 cf 官网:https://dash.cloudflare.com/ ,进入 zero trust 里生成 token 隧道和信息。

imageimageimageimageimageimageimage

准备需要用的变量

image

面板域名加上 https:// 开头,回调地址再加上 /oauth2/callback 结尾

imageimageimageimageimage

PaaS 部署实例

镜像 fscarmen/argo-nezha:latest , 支持 amd64 和 arm64 架构

用到的变量

变量名是否必须备注
GH_USERgithub 的用户名,用于面板管理授权
GH_CLIENTID在 github 上申请
GH_CLIENTSECRET在 github 上申请
GH_BACKUP_USER在 github 上备份哪吒服务端数据库的 github 用户名,不填则与面板管理授权的账户 GH_USER 一致
GH_REPO在 github 上备份哪吒服务端数据库文件的 github 库
GH_EMAILgithub 的邮箱,用于备份的 git 推送到远程库
GH_PATgithub 的 PAT
ARGO_AUTHJson: 从 https://fscarmen.cloudflare.now.cc 获取的 Argo Json
Token: 从 Cloudflare 官网获取
DATA_DOMAIN客户端与服务端的通信 argo 域名
WEB_DOMAIN面板 argo 域名
SSH_DOMAINssh 用的 argo 域名
SSH_PASSWORDssh 的密码,只有在设置 SSH_JSON 后才生效,默认值 password

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS 部署实例

docker 部署

docker run -dit \\
-           --name nezha_dashboard \\
-           --restart always \\
-           -e GH_USER=<填 github 用户名> \\
-           -e GH_EMAIL=<填 github 邮箱> \\
-           -e GH_PAT=<填获取的> \\
-           -e GH_REPO=<填自定义的> \\
-           -e GH_CLIENTID=<填获取的>  \\
-           -e GH_CLIENTSECRET=<填获取的> \\
-           -e ARGO_AUTH='<填获取的 Argo json 或者 token>' \\
-           -e WEB_DOMAIN=<填自定义的> \\
-           -e DATA_DOMAIN=<填自定义的> \\
-           -e SSH_DOMAIN=<填自定义的> \\
-           -e SSH_PASSWORD=<填自定义的> \\
-           fscarmen/argo-nezha

docker-compose 部署

version: '3.8'
-services:
-    argo-nezha:
-        image: fscarmen/argo-nezha
-        container_name: nezha_dashboard
-        restart: always
-        environment:
-            - GH_USER=<填 github 用户名>
-            - GH_EMAIL=<<填 github 邮箱>
-            - GH_PAT=<填获取的>
-            - GH_REPO=<填自定义的>
-            - GH_CLIENTID=<填获取的>
-            - GH_CLIENTSECRET=<填获取的>
-            - ARGO_AUTH='<填获取的 Argo json 或者 token>'
-            - WEB_DOMAIN=<填自定义的>
-            - DATA_DOMAIN=<填自定义的>
-            - SSH_DOMAIN=<填自定义的>
-            - SSH_PASSWORD=<填自定义的>

客户端接入

通过gRPC传输,无需额外配置。使用面板给到的安装方式,举例

curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh install_agent data.seales.nom.za 443 eAxO9IF519fKFODlW0 --tls

SSH 接入

<file path>/cloudflared access ssh --hostname ssh.seales.nom.za
imageimageimage

自动还原备份

下图为以还原文件名为 dashboard-2023-04-23-13:08:37.tar.gz 作示例

image

手动还原备份

bash /dashboard/restore.sh <文件名>
image

完美搬家

tar czvf dashboard.tar.gz /dashboard

主体目录文件及说明

.
-|-- 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.csr            # SSL/TLS 证书签名请求
-|   |-- nezha.key            # SSL/TLS 证书的私钥信息
-|   |-- nezha.pem            # SSL/TLS 隐私增强邮件
-|   \`-- restore.sh           # 还原备份脚本
-|-- usr
-|   \`-- local
-|       \`-- bin
-|           |-- cloudflared  # Cloudflare Argo 隧道主程序
-|           |-- grpcwebproxy # gRPC 反代主程序
-|           \`-- nezha-agent  # 哪吒客户端,用于监控本地 localhost
-|-- dbfile                   # 记录最新的还原或备份文件名
-\`-- version                  # 记录当前的面板 app 版本

鸣谢下列作者的文章和项目:

免责声明:

`,85),r=[l];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const b=a(n,[["render",o]]);export{u as __pageData,b as default}; diff --git a/assets/case_case5.md.93900c94.lean.js b/assets/case_case5.md.93900c94.lean.js deleted file mode 100644 index b18d4e7d..00000000 --- a/assets/case_case5.md.93900c94.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as a,o as e,c as s,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"使用 Argo 隧道的哪吒服务端","description":"","frontmatter":{},"headers":[],"relativePath":"case/case5.md","filePath":"case/case5.md","lastUpdated":1698375851000}'),n={name:"case/case5.md"},l=t("",85),r=[l];function o(c,i,p,h,d,g){return e(),s("div",null,r)}const b=a(n,[["render",o]]);export{u as __pageData,b as default}; diff --git a/assets/case_index.md.0419435e.js b/assets/case_index.md.e7243c50.js similarity index 88% rename from assets/case_index.md.0419435e.js rename to assets/case_index.md.e7243c50.js index 3b1b76f5..092ad86b 100644 --- a/assets/case_index.md.0419435e.js +++ b/assets/case_index.md.e7243c50.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1698375851000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1701534410000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; diff --git a/assets/case_index.md.0419435e.lean.js b/assets/case_index.md.e7243c50.lean.js similarity index 88% rename from assets/case_index.md.0419435e.lean.js rename to assets/case_index.md.e7243c50.lean.js index 3b1b76f5..092ad86b 100644 --- a/assets/case_index.md.0419435e.lean.js +++ b/assets/case_index.md.e7243c50.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1698375851000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const p=JSON.parse('{"title":"哪吒监控","titleTemplate":"社区项目","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"社区项目","hero":{"name":"哪吒监控社区项目","text":"社区贡献的相关项目","tagline":"为哪吒监控提供了更多扩展","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"查看项目 →","link":"/case/case1"}]},"features":[{"title":"提交项目","details":"我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜"},{"title":"注意事项","details":"所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任"}]},"headers":[],"relativePath":"case/index.md","filePath":"case/index.md","lastUpdated":1701534410000}'),s={name:"case/index.md"};function n(i,r,c,o,d,l){return t(),a("div")}const _=e(s,[["render",n]]);export{p as __pageData,_ as default}; diff --git a/assets/developer_index.md.fb38673e.js b/assets/developer_index.md.0a6fbe67.js similarity index 92% rename from assets/developer_index.md.fb38673e.js rename to assets/developer_index.md.0a6fbe67.js index a555f601..281b1f24 100644 --- a/assets/developer_index.md.fb38673e.js +++ b/assets/developer_index.md.0a6fbe67.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1698375851000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1701534410000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; diff --git a/assets/developer_index.md.fb38673e.lean.js b/assets/developer_index.md.0a6fbe67.lean.js similarity index 92% rename from assets/developer_index.md.fb38673e.lean.js rename to assets/developer_index.md.0a6fbe67.lean.js index a555f601..281b1f24 100644 --- a/assets/developer_index.md.fb38673e.lean.js +++ b/assets/developer_index.md.0a6fbe67.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1698375851000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const m=JSON.parse('{"title":"哪吒监控","titleTemplate":"开发手册","description":"","frontmatter":{"layout":"home","title":"哪吒监控","titleTemplate":"开发手册","hero":{"name":"开发手册","text":"哪吒监控开发手册","tagline":"我们欢迎你提出高质量的Pull Request,帮助哪吒监控变得更好!","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"开始使用 →","link":"/developer/theme"}]}},"headers":[],"relativePath":"developer/index.md","filePath":"developer/index.md","lastUpdated":1701534410000}'),r={name:"developer/index.md"};function n(o,s,i,d,l,c){return t(),a("div")}const h=e(r,[["render",n]]);export{m as __pageData,h as default}; diff --git a/assets/developer_l10n.md.e16b7f23.js b/assets/developer_l10n.md.06ab96bd.js similarity index 95% rename from assets/developer_l10n.md.e16b7f23.js rename to assets/developer_l10n.md.06ab96bd.js index 28005851..551b49cb 100644 --- a/assets/developer_l10n.md.e16b7f23.js +++ b/assets/developer_l10n.md.06ab96bd.js @@ -1 +1 @@ -import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1698375851000}'),l={name:"developer/l10n.md"},r=t('

哪吒监控的 Dashboard 已经添加本地化,支持多个语言,你可以在开发新功能时遵循以下步骤来支持本地化

介绍

  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本,请参考 zh-CN.toml 的配置文本,将新文本拉取到 zh-CN.toml 等其他语言的配置文件中,并添加翻译

新本地化文本的添加

  1. /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; +import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1701534410000}'),l={name:"developer/l10n.md"},r=t('

哪吒监控的 Dashboard 已经添加本地化,支持多个语言,你可以在开发新功能时遵循以下步骤来支持本地化

介绍

  1. 你可以直接使用 /resource/l10n/zh-CN.toml 中已有的文本配置来替换新功能中的文本
  2. 如果新功能中有新增文本,请参考 zh-CN.toml 的配置文本,将新文本拉取到 zh-CN.toml 等其他语言的配置文件中,并添加翻译

新本地化文本的添加

  1. /resource/l10n/ 中添加新的语言文本配置
  2. 在新的语言文本配置中拉取其他语言已有的文本配置
  3. 为新的语言文本配置添加翻译
',5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; diff --git a/assets/developer_l10n.md.e16b7f23.lean.js b/assets/developer_l10n.md.06ab96bd.lean.js similarity index 84% rename from assets/developer_l10n.md.e16b7f23.lean.js rename to assets/developer_l10n.md.06ab96bd.lean.js index 859b8850..e828f342 100644 --- a/assets/developer_l10n.md.e16b7f23.lean.js +++ b/assets/developer_l10n.md.06ab96bd.lean.js @@ -1 +1 @@ -import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1698375851000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; +import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/l10n.md","filePath":"developer/l10n.md","lastUpdated":1701534410000}'),l={name:"developer/l10n.md"},r=t("",5),c=[r];function d(n,i,s,_,h,p){return o(),a("div",null,c)}const f=e(l,[["render",d]]);export{u as __pageData,f as default}; diff --git a/assets/developer_theme.md.5883687e.js b/assets/developer_theme.md.8c7acb53.js similarity index 96% rename from assets/developer_theme.md.5883687e.js rename to assets/developer_theme.md.8c7acb53.js index d61e9731..1d8c2b4b 100644 --- a/assets/developer_theme.md.5883687e.js +++ b/assets/developer_theme.md.8c7acb53.js @@ -1 +1 @@ -import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1698375851000}'),c={name:"developer/theme.md"},l=t('

哪吒主题开发环境

哪吒面板提供了主题开发环境,你可以使用它来创建新的哪吒监控主题

WARNING

请注意: 此开发环境仅支持 dashboard v0.13.16 及更新版本。

使用说明

  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置(回调连接可以填 http://localhost
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom 放置到服务器上的 /opt/nezha/dashboard/theme-custom 位置

FAQ

',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default}; +import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1701534410000}'),c={name:"developer/theme.md"},l=t('

哪吒主题开发环境

哪吒面板提供了主题开发环境,你可以使用它来创建新的哪吒监控主题

WARNING

请注意: 此开发环境仅支持 dashboard v0.13.16 及更新版本。

使用说明

  1. 克隆此仓库到本地
  2. 修改 data/config.yaml 中的 Oauth2 配置(回调连接可以填 http://localhost
  3. 运行 docker-compose up
  4. 开始开发
  5. 主题制作完成之后可以将 theme-custom 放置到服务器上的 /opt/nezha/dashboard/theme-custom 位置

FAQ

',7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/developer_theme.md.5883687e.lean.js b/assets/developer_theme.md.8c7acb53.lean.js similarity index 84% rename from assets/developer_theme.md.5883687e.lean.js rename to assets/developer_theme.md.8c7acb53.lean.js index 221c259e..57d6714a 100644 --- a/assets/developer_theme.md.5883687e.lean.js +++ b/assets/developer_theme.md.8c7acb53.lean.js @@ -1 +1 @@ -import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1698375851000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default}; +import{_ as e,o,c as a,R as t}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"developer/theme.md","filePath":"developer/theme.md","lastUpdated":1701534410000}'),c={name:"developer/theme.md"},l=t("",7),d=[l];function r(s,i,h,n,m,_){return o(),a("div",null,d)}const f=e(c,[["render",r]]);export{u as __pageData,f as default}; diff --git a/assets/en_US_case_case1.md.9a8ad188.js b/assets/en_US_case_case1.md.628438cc.js similarity index 95% rename from assets/en_US_case_case1.md.9a8ad188.js rename to assets/en_US_case_case1.md.628438cc.js index a31df23b..56cf0281 100644 --- a/assets/en_US_case_case1.md.9a8ad188.js +++ b/assets/en_US_case_case1.md.628438cc.js @@ -1 +1 @@ -import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1698375851000}'),a={name:"en_US/case/case1.md"},n=o('

Build your own Telegram bot to query server information

Contributors:

Project: nezha_api_tgbot (Chinese)

Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)

The bot can request server status information from the Dashboard through the API, and then send the information to the user.
You can build this bot to easily view the current status of a given server without opening the Dashboard.

',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; +import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1701534410000}'),a={name:"en_US/case/case1.md"},n=o('

Build your own Telegram bot to query server information

Contributors:

Project: nezha_api_tgbot (Chinese)

Mirror backup, non-real-time update: nezha_api_tgbot (Chinese)

The bot can request server status information from the Dashboard through the API, and then send the information to the user.
You can build this bot to easily view the current status of a given server without opening the Dashboard.

',6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; diff --git a/assets/en_US_case_case1.md.9a8ad188.lean.js b/assets/en_US_case_case1.md.628438cc.lean.js similarity index 86% rename from assets/en_US_case_case1.md.9a8ad188.lean.js rename to assets/en_US_case_case1.md.628438cc.lean.js index 0259b55b..24e4838f 100644 --- a/assets/en_US_case_case1.md.9a8ad188.lean.js +++ b/assets/en_US_case_case1.md.628438cc.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1698375851000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; +import{_ as e,o as t,c as r,R as o}from"./chunks/framework.44fd0451.js";const d=JSON.parse('{"title":"Build your own Telegram bot to query server information","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case1.md","filePath":"en_US/case/case1.md","lastUpdated":1701534410000}'),a={name:"en_US/case/case1.md"},n=o("",6),i=[n];function s(h,_,l,u,c,p){return t(),r("div",null,i)}const m=e(a,[["render",s]]);export{d as __pageData,m as default}; diff --git a/assets/en_US_case_case2.md.77f26080.js b/assets/en_US_case_case2.md.c9576b87.js similarity index 97% rename from assets/en_US_case_case2.md.77f26080.js rename to assets/en_US_case_case2.md.c9576b87.js index 6556ef95..09862051 100644 --- a/assets/en_US_case_case2.md.77f26080.js +++ b/assets/en_US_case_case2.md.c9576b87.js @@ -1 +1 @@ -import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1698375851000}'),a={name:"en_US/case/case2.md"},c=s('

Use Siri to run shortcut to check server status in iOS/MacOS

Current Version:V1.0 (Chinese)
Contributor:

Get shortcut command

Scan the following QR code with your iPhone or iPad to get the shortcut

coode


MacOS users please visit here to get the shortcut

How to use

WARNING

Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.

',8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; +import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1701534410000}'),a={name:"en_US/case/case2.md"},c=s('

Use Siri to run shortcut to check server status in iOS/MacOS

Current Version:V1.0 (Chinese)
Contributor:

Get shortcut command

Scan the following QR code with your iPhone or iPad to get the shortcut

coode


MacOS users please visit here to get the shortcut

How to use

WARNING

Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.

',8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; diff --git a/assets/en_US_case_case2.md.77f26080.lean.js b/assets/en_US_case_case2.md.c9576b87.lean.js similarity index 87% rename from assets/en_US_case_case2.md.77f26080.lean.js rename to assets/en_US_case_case2.md.c9576b87.lean.js index 5f816ca4..bc7e4319 100644 --- a/assets/en_US_case_case2.md.77f26080.lean.js +++ b/assets/en_US_case_case2.md.c9576b87.lean.js @@ -1 +1 @@ -import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1698375851000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; +import{_ as e}from"./chunks/qrcode.59c44dde.js";import{_ as t,o as r,c as o,R as s}from"./chunks/framework.44fd0451.js";const f=JSON.parse('{"title":"Use Siri to run shortcut to check server status in iOS/MacOS","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case2.md","filePath":"en_US/case/case2.md","lastUpdated":1701534410000}'),a={name:"en_US/case/case2.md"},c=s("",8),i=[c];function h(n,u,l,d,m,_){return r(),o("div",null,i)}const b=t(a,[["render",h]]);export{f as __pageData,b as default}; diff --git a/assets/en_US_case_case3.md.c8bf14c8.js b/assets/en_US_case_case3.md.a5875c00.js similarity index 98% rename from assets/en_US_case_case3.md.c8bf14c8.js rename to assets/en_US_case_case3.md.a5875c00.js index 01349b5e..3bca0b88 100644 --- a/assets/en_US_case_case3.md.c8bf14c8.js +++ b/assets/en_US_case_case3.md.a5875c00.js @@ -1 +1 @@ -import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1698375851000}'),d={name:"en_US/case/case3.md"},i=a('

Build your own server status query Telegram bot with multi-language and multi-user support

Contributor:

GitHub project: nezha_telegram_bot(English is already supported)

Mirror backup, non-real-time update : nezha_telegram_bot(English is already supported)

Features

Commands list

CommandDescriptionPrivate chat only
startGetting started with the keyboard main menu✔️
helphelp message
addAdd Nezha monitoring url link and token✔️
urlAdd Nezha monitoring url link✔️
tokenAdd Nezha monitoring token✔️
infoGet saved Nezha monitoring url link and token✔️
deleteDelete saved Nezha monitoring url link and token✔️
idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)
allQuery statistics for all servers
searchSearch for keywords in server names (multiple keywords supported, split by spaces)
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; +import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1701534410000}'),d={name:"en_US/case/case3.md"},i=a('

Build your own server status query Telegram bot with multi-language and multi-user support

Contributor:

GitHub project: nezha_telegram_bot(English is already supported)

Mirror backup, non-real-time update : nezha_telegram_bot(English is already supported)

Features

Commands list

CommandDescriptionPrivate chat only
startGetting started with the keyboard main menu✔️
helphelp message
addAdd Nezha monitoring url link and token✔️
urlAdd Nezha monitoring url link✔️
tokenAdd Nezha monitoring token✔️
infoGet saved Nezha monitoring url link and token✔️
deleteDelete saved Nezha monitoring url link and token✔️
idAdd an integer id after the command to query the information of a single server (refresh button only available in private chat)
allQuery statistics for all servers
searchSearch for keywords in server names (multiple keywords supported, split by spaces)
',9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; diff --git a/assets/en_US_case_case3.md.c8bf14c8.lean.js b/assets/en_US_case_case3.md.a5875c00.lean.js similarity index 87% rename from assets/en_US_case_case3.md.c8bf14c8.lean.js rename to assets/en_US_case_case3.md.a5875c00.lean.js index 503c61d0..ae3459a6 100644 --- a/assets/en_US_case_case3.md.c8bf14c8.lean.js +++ b/assets/en_US_case_case3.md.a5875c00.lean.js @@ -1 +1 @@ -import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1698375851000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; +import{_ as t,o as e,c as r,R as a}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Build your own server status query Telegram bot with multi-language and multi-user support","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case3.md","filePath":"en_US/case/case3.md","lastUpdated":1701534410000}'),d={name:"en_US/case/case3.md"},i=a("",9),o=[i];function s(l,n,u,h,p,m){return e(),r("div",null,o)}const _=t(d,[["render",s]]);export{g as __pageData,_ as default}; diff --git a/assets/en_US_case_case4.md.87565e31.js b/assets/en_US_case_case4.md.b3a4b972.js similarity index 94% rename from assets/en_US_case_case4.md.87565e31.js rename to assets/en_US_case_case4.md.b3a4b972.js index 5990701c..4d903db1 100644 --- a/assets/en_US_case_case4.md.87565e31.js +++ b/assets/en_US_case_case4.md.b3a4b972.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1698375851000}'),n={name:"en_US/case/case4.md"},o=r('

Fake-agent, monitoring data cheater

Contributor:

GitHub project: fake-nezha-agent(Chinese)
Mirror backup, non-real-time update :fake-nezha-agent(Chinese)

You can modify the monitoring data uploaded to Dashboard by the Agent
Use it for cheating 😈

',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; +import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1701534410000}'),n={name:"en_US/case/case4.md"},o=r('

Fake-agent, monitoring data cheater

Contributor:

GitHub project: fake-nezha-agent(Chinese)
Mirror backup, non-real-time update :fake-nezha-agent(Chinese)

You can modify the monitoring data uploaded to Dashboard by the Agent
Use it for cheating 😈

',5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; diff --git a/assets/en_US_case_case4.md.87565e31.lean.js b/assets/en_US_case_case4.md.b3a4b972.lean.js similarity index 85% rename from assets/en_US_case_case4.md.87565e31.lean.js rename to assets/en_US_case_case4.md.b3a4b972.lean.js index 1b71db34..f01127a8 100644 --- a/assets/en_US_case_case4.md.87565e31.lean.js +++ b/assets/en_US_case_case4.md.b3a4b972.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1698375851000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; +import{_ as e,o as a,c as t,R as r}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Fake-agent, monitoring data cheater","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case4.md","filePath":"en_US/case/case4.md","lastUpdated":1701534410000}'),n={name:"en_US/case/case4.md"},o=r("",5),i=[o];function s(c,h,_,d,f,l){return a(),t("div",null,i)}const m=e(n,[["render",s]]);export{g as __pageData,m as default}; diff --git a/assets/en_US_case_case5.md.3404425e.js b/assets/en_US_case_case5.md.3404425e.js new file mode 100644 index 00000000..896d956b --- /dev/null +++ b/assets/en_US_case_case5.md.3404425e.js @@ -0,0 +1,47 @@ +import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1701534410000}'),n={name:"en_US/case/case5.md"},o=s(`

Nezha server over Argo tunnel

Contributors:

GitHub project: Argo-Nezha-Service-Container

Mirror backup (not live update): Argo-Nezha-Service-Container


Catalog


Project Features.

image

Prepare variables to be used

image

Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.

imageimageimageimageimage

How to get Argo authentication: json or token

Argo tunnel authentication methods include json and token, use one of the two methods. The former is recommended because the script will handle all the Argo tunnel parameters and paths, while the latter needs to be set manually on the Cloudflare website and is prone to errors.

(Methods 1 - Json):

Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

image

(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.

Go to the cf website: https://dash.cloudflare.com/

imageimageimageimageimageimageimage

PaaS Deployment Example

Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.

Variables used

Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
GH_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
ARGO_DOMAINYesArgo domain

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS Deployment Method 1 --- docker

docker deployment

docker run -dit \\
+           --name nezha_dashboard \\
+           --pull always \\
+           --restart always \\
+           -e GH_USER=<fill in github username> \\
+           -e GH_EMAIL=<fill in github email> \\
+           -e GH_PAT=<fill in the obtained> \\
+           -e GH_REPO=<fill in customized> \\
+           -e GH_CLIENTID=<fill in acquired> \\
+           -e GH_CLIENTSECRET=<fill in acquired> \\
+           -e ARGO_AUTH='<Fill in the fetched Argo json or token>' \\
+           -e ARGO_DOMAIN=<fill in customized> \\
+           -e GH_BACKUP_USER=<If it is consistent with GH_USER, you can leave it blank> \\
+           fscarmen/argo-nezha

docker-compose deployment

version: '3.8'
+services.
+    argo-nezha.
+        image: fscarmen/argo-nezha
+        --pull always
+        container_name: nezha_dashboard
+        restart: always
+        environment:
+            - GH_USER=<fill in github username>
+            - GH_EMAIL=<fill in your github email>
+            - GH_PAT=<<fill in obtained>
+            - GH_REPO=<fill in customized>
+            - GH_CLIENTID=<fill in obtained>
+            - GH_CLIENTSECRET=<fill in fetched>
+            - ARGO_AUTH='<Fill in the fetched Argo json or token>'
+            - ARGO_DOMAIN=<fill in customized>
+            - GH_BACKUP_USER=<If it is consistent with GH_USER, you can leave it blank>

VPS Deployment Method 2 --- hosts

bash <(wget -qO- https://raw.githubusercontent.com/fscarmen2/Argo-Nezha-Service-Container/main/dashboard.sh)

Client Access

Transfer via gRPC, no additional configuration required. Use the installation method given in the panel, for example

curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh install_agent data.seales.nom.za 443 eAxO9IF519fKFODlW0 --tls

SSH access

<filepath>/cloudflared access ssh --hostname ssh.seals.nom.za/<GH_CLIENTID>
imageimageimage

Manually backing up your data

Method 1: Change the contents of the README.md file in the Github backup repository to backup

image

Method 2: After ssh, run /dashboard/backup.sh for container version; /opt/nezha/dashboard/backup.sh for VPS host version.

Automatically restore backups

The following is an example of restoring a file with the name dashboard-2023-04-23-13:08:37.tar.gz.

! image

Manually restore the backup

bash /dashboard/restore.sh <filename>
image

Migrating data

tar czvf dashboard.tar.gz /dashboard

Main catalog files and descriptions

/dashboard/
+|-- app                  # Nezha panel main program
+|-- argo.json            # Argo tunnel json file, which records information about using the tunnel.
+|-- argo.yml             # Argo tunnel yml file, used for streaming web, gRPC and ssh protocols under a single tunnel with different domains.
+|-- backup.sh            # Backup data scripts
+|-- restore.sh           # Restore backup scripts
+|-- dbfile               # Record the name of the latest restore or backup file
+|-- resource             # Folders of information on panel themes, languages, flags, etc.
+|-- data
+|   |-- config.yaml      # Configuration for the Nezha panel, e.g. Github OAuth2 / gRPC domain / port / TLS enabled or not.
+|   \`-- sqlite.db        # SQLite database file that records all severs and cron settings for the panel.
+|-- entrypoint.sh        # The main script, which is executed after the container is run.
+|-- nezha.csr            # SSL/TLS certificate signing request
+|-- nezha.key            # Private key information for SSL/TLS certificate.
+|-- nezha.pem            # SSL/TLS certificate file.
+|-- cloudflared          # Cloudflare Argo tunnel main program.
+|-- grpcwebproxy         # gRPC reverse proxy main program.
+\`-- nezha-agent          # Nezha client, used to monitor the localhost.

Acknowledgements for articles and projects by

Disclaimer

`,89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/en_US_case_case5.md.3404425e.lean.js b/assets/en_US_case_case5.md.3404425e.lean.js new file mode 100644 index 00000000..a437fe1c --- /dev/null +++ b/assets/en_US_case_case5.md.3404425e.lean.js @@ -0,0 +1 @@ +import{_ as e,o as a,c as t,R as s}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1701534410000}'),n={name:"en_US/case/case5.md"},o=s("",89),r=[o];function l(i,c,h,p,d,u){return a(),t("div",null,r)}const f=e(n,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/en_US_case_case5.md.635f3c8f.js b/assets/en_US_case_case5.md.635f3c8f.js deleted file mode 100644 index aa7d68fb..00000000 --- a/assets/en_US_case_case5.md.635f3c8f.js +++ /dev/null @@ -1,53 +0,0 @@ -import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1698375851000}'),s={name:"en_US/case/case5.md"},o=n(`

Nezha server over Argo tunnel

Contributors:

GitHub project: Argo-Nezha-Service-Container

Mirror backup (not live update): Argo-Nezha-Service-Container


Catalog


Project Features.

image

How to get Argo authentication: json or token

The Argo Tunnel authentication methods are json and token, use one of the two methods.

(Methods 1 - Josn):

Easily get Argo tunnel json information through Cloudflare Json Generation Network: https://fscarmen.cloudflare.now.cc

image

Visit Cloudflare website, add the domain name of the client reporting data (tcp) and ssh (optional) in the DNS record of the corresponding domain, and turn on Orange Cloud to enable CDN.

imageimage

(Methods 2 - Token): Manually generate Argo tunnel token information via Cloudflare website.

Go to the cf website: https://dash.cloudflare.com/ and go to zero trust to generate token tunnels and messages.

imageimageimageimageimageimageimage

Prepare variables to be used

image

Add https:// to the beginning of the panel's domain name and /oauth2/callback to the end of the callback address.

imageimageimageimageimage

PaaS Deployment Example

Image fscarmen/argo-nezha:latest, supports amd64 and arm64 architectures.

Variables used

Variable NameRequiredRemarks
GH_USERYesgithub username for panel admin authorization
GH_CLIENTIDyesapply on github
GH_CLIENTSECRETyesapply on github
GH_BACKUP_USERNoThe github username for backing up Nezha's server-side database on github, if not filled in, it is the same as the account GH_USER for panel management authorization
GH_REPONoThe github repository for backing up Nezha's server-side database files on github
GH_EMAILNogithub's mailbox for git push backups to remote repositories
GH_PATNogithub's PAT
ARGO_AUTHYesArgo Json from https://fscarmen.cloudflare.now.cc
Argo token from Cloudflare official website
DATA_DOMAINYesClient-server communication argo domain name
WEB_DOMAINYesPanel argo domain
SSH_DOMAINNossh for argo domain
SSH_PASSWORDnopassword for ssh, only works after setting SSH_JSON, default password

Koyeb

Deploy to Koyeb

imageimageimageimageimage

VPS Deployment Example

docker deployment

docker run -dit \\
-           --name nezha_dashboard \\
-           --restart always \\
-           -e GH_USER=<fill in github username> \\
-           -e GH_EMAIL=<fill in github email> \\
-           -e GH_PAT=<fill in the obtained> \\
-           -e GH_REPO=<fill in customized> \\
-           -e GH_CLIENTID=<fill in acquired> \\
-           -e GH_CLIENTSECRET=<fill in acquired> \\
-           -e ARGO_AUTH='<Fill in the fetched Argo json or token>' \\
-           -e WEB_DOMAIN=<fill in customized> \\
-           -e DATA_DOMAIN=<fill in customized> \\
-           -e SSH_DOMAIN=<fill in customized> \\
-           -e SSH_PASSWORD=<insert customized> \\
-           fscarmen/argo-nezha

docker-compose deployment

version: '3.8'
-services.
-    argo-nezha.
-        image: fscarmen/argo-nezha
-        container_name: nezha_dashboard
-        restart: always
-        environment:
-            - GH_USER=<fill in github username>
-            - GH_EMAIL=<fill in your github email>
-            - GH_PAT=<<fill in obtained>
-            - GH_REPO=<fill in customized>
-            - GH_CLIENTID=<fill in obtained>
-            - GH_CLIENTSECRET=<fill in fetched>
-            - ARGO_AUTH='<Fill in the fetched Argo json or token>'
-            - WEB_DOMAIN=<fill customized>
-            - DATA_DOMAIN=<fill in customized>
-            - SSH_DOMAIN=<insert customized>
-            - SSH_PASSWORD=<fill customized>

Client Access

Transfer via gRPC, no additional configuration required. Use the installation method given in the panel, for example

curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh install_agent data.seales.nom.za 443 eAxO9IF519fKFODlW0 --tls

SSH access

<filepath>/cloudflared access ssh --hostname ssh.seals.nom.za
imageimageimage

Automatically restore backups

The following is an example of restoring a file with the name dashboard-2023-04-23-13:08:37.tar.gz.

! image

Manually restore the backup

bash /dashboard/restore.sh <filename>
image

Migrating data

tar czvf dashboard.tar.gz /dashboard

Main catalog files and descriptions

.
-|-- dashboard
-|   |-- app                  # Nezha panel main program
-|   |-- argo.json            # Argo tunnel json file, which records information about using the tunnel.
-|   |-- argo.yml             # Argo tunnel yml file, used for streaming web, gRPC and ssh protocols under a single tunnel with different domains.
-|   |-- backup.sh            # Backup data scripts
-|   |-- data
-|   |   |-- config.yaml      # Configuration for the Nezha panel, e.g. Github OAuth2 / gRPC domain / port / TLS enabled or not.
-|   |   \`-- sqlite.db        # SQLite database file that records all severs and cron settings for the panel.
-|   |-- entrypoint.sh        # The main script, which is executed after the container is run.
-|   |-- nezha.csr            # SSL/TLS certificate signing request
-|   |-- nezha.key            # Private key information for SSL/TLS certificate.
-|   |-- nezha.pem            # SSL/TLS Privacy Enhancement Email
-|   \`-- restore.sh           # Restore backup scripts
-|-- usr
-|   \`-- local
-|       \`-- bin
-|           |-- cloudflared  # Cloudflare Argo tunnel main program.
-|           |-- grpcwebproxy # gRPC reverse proxy main program.
-|           \`-- nezha-agent  # Nezha client, used to monitor the localhost.
-|-- dbfile                   # Record the name of the latest restore or backup file
-\`-- version                  # Record the current panel app version

Acknowledgements for articles and projects by

Disclaimer

`,85),r=[o];function l(i,c,h,d,p,m){return a(),t("div",null,r)}const f=e(s,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/en_US_case_case5.md.635f3c8f.lean.js b/assets/en_US_case_case5.md.635f3c8f.lean.js deleted file mode 100644 index 8eefc8ed..00000000 --- a/assets/en_US_case_case5.md.635f3c8f.lean.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"Nezha server over Argo tunnel","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/case/case5.md","filePath":"en_US/case/case5.md","lastUpdated":1698375851000}'),s={name:"en_US/case/case5.md"},o=n("",85),r=[o];function l(i,c,h,d,p,m){return a(),t("div",null,r)}const f=e(s,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/en_US_case_index.md.51e3fcf1.js b/assets/en_US_case_index.md.464e1cf1.js similarity index 95% rename from assets/en_US_case_index.md.51e3fcf1.js rename to assets/en_US_case_index.md.464e1cf1.js index 92f4805f..a2201167 100644 --- a/assets/en_US_case_index.md.51e3fcf1.js +++ b/assets/en_US_case_index.md.464e1cf1.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1698375851000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1701534410000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/en_US_case_index.md.51e3fcf1.lean.js b/assets/en_US_case_index.md.464e1cf1.lean.js similarity index 95% rename from assets/en_US_case_index.md.51e3fcf1.lean.js rename to assets/en_US_case_index.md.464e1cf1.lean.js index 92f4805f..a2201167 100644 --- a/assets/en_US_case_index.md.51e3fcf1.lean.js +++ b/assets/en_US_case_index.md.464e1cf1.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1698375851000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const u=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Community Project","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Community Project","hero":{"name":"Nezha Monitoring","text":"Community Project","tagline":"Nezha Monitoring has benefited from various projects contributed by the community, which have provided it with additional extensions.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Learn More →","link":"/en_US/case/case1"}]},"features":[{"title":"Submit a project","details":"We welcome you to submit your own project. Please join the Telegram group to contact the administrator for further information."},{"title":"Important Notes","details":"All projects are contributed by community members. Please be aware that the Nezha Monitoring Team cannot assume responsibility for community projects, including but not limited to warranty, availability, security, etc."}]},"headers":[],"relativePath":"en_US/case/index.md","filePath":"en_US/case/index.md","lastUpdated":1701534410000}'),o={name:"en_US/case/index.md"};function i(n,r,s,c,m,l){return t(),a("div")}const h=e(o,[["render",i]]);export{u as __pageData,h as default}; diff --git a/assets/en_US_developer_index.md.494894a7.js b/assets/en_US_developer_index.md.5e431eca.js similarity index 91% rename from assets/en_US_developer_index.md.494894a7.js rename to assets/en_US_developer_index.md.5e431eca.js index 943ba6d7..10d3a5ec 100644 --- a/assets/en_US_developer_index.md.494894a7.js +++ b/assets/en_US_developer_index.md.5e431eca.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1698375851000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1701534410000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; diff --git a/assets/en_US_developer_index.md.494894a7.lean.js b/assets/en_US_developer_index.md.5e431eca.lean.js similarity index 91% rename from assets/en_US_developer_index.md.494894a7.lean.js rename to assets/en_US_developer_index.md.5e431eca.lean.js index 943ba6d7..10d3a5ec 100644 --- a/assets/en_US_developer_index.md.494894a7.lean.js +++ b/assets/en_US_developer_index.md.5e431eca.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1698375851000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; +import{_ as e,o as t,c as a}from"./chunks/framework.44fd0451.js";const c=JSON.parse('{"title":"Nezha Monitoring","titleTemplate":"Development Manual","description":"","frontmatter":{"layout":"home","title":"Nezha Monitoring","titleTemplate":"Development Manual","hero":{"name":"Development Manual","text":"Nezha Monitoring Development Manual.","image":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","actions":[{"theme":"brand","text":"Start Now →","link":"/en_US/developer/theme"}]}},"headers":[],"relativePath":"en_US/developer/index.md","filePath":"en_US/developer/index.md","lastUpdated":1701534410000}'),n={name:"en_US/developer/index.md"};function o(r,i,l,s,p,d){return t(),a("div")}const _=e(n,[["render",o]]);export{c as __pageData,_ as default}; diff --git a/assets/en_US_developer_l10n.md.f30e1696.js b/assets/en_US_developer_l10n.md.88ba36b5.js similarity index 96% rename from assets/en_US_developer_l10n.md.f30e1696.js rename to assets/en_US_developer_l10n.md.88ba36b5.js index 0bd3c514..7b5abaf8 100644 --- a/assets/en_US_developer_l10n.md.f30e1696.js +++ b/assets/en_US_developer_l10n.md.88ba36b5.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1698375851000}'),o={name:"en_US/developer/l10n.md"},i=n('

Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features

Introduction

  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. If there is new text in the new feature, please refer to the configuration text in en-US.toml, pull the new text into the configuration files of other languages such as en-US.toml, and add translations.

Adding a new localized text file

  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; +import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1701534410000}'),o={name:"en_US/developer/l10n.md"},i=n('

Nezha Monitoring's Dashboard has added localization to support multiple languages, and you can follow these steps to support localization when developing new features

Introduction

  1. You can directly use the text configuration already available in /resource/l10n/en-US.toml to replace the text in the new feature.
  2. If there is new text in the new feature, please refer to the configuration text in en-US.toml, pull the new text into the configuration files of other languages such as en-US.toml, and add translations.

Adding a new localized text file

  1. Add a new language text configuration in /resource/l10n/.
  2. Pull existing text configurations from other languages in the new language text configuration.
  3. Add translations for the new language text configuration.
',5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; diff --git a/assets/en_US_developer_l10n.md.f30e1696.lean.js b/assets/en_US_developer_l10n.md.88ba36b5.lean.js similarity index 85% rename from assets/en_US_developer_l10n.md.f30e1696.lean.js rename to assets/en_US_developer_l10n.md.88ba36b5.lean.js index c8751284..ac752d61 100644 --- a/assets/en_US_developer_l10n.md.f30e1696.lean.js +++ b/assets/en_US_developer_l10n.md.88ba36b5.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1698375851000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; +import{_ as e,o as t,c as a,R as n}from"./chunks/framework.44fd0451.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/l10n.md","filePath":"en_US/developer/l10n.md","lastUpdated":1701534410000}'),o={name:"en_US/developer/l10n.md"},i=n("",5),l=[i];function r(d,c,s,u,h,f){return t(),a("div",null,l)}const p=e(o,[["render",r]]);export{g as __pageData,p as default}; diff --git a/assets/en_US_developer_theme.md.fec1d800.js b/assets/en_US_developer_theme.md.ab8eaaf4.js similarity index 96% rename from assets/en_US_developer_theme.md.fec1d800.js rename to assets/en_US_developer_theme.md.ab8eaaf4.js index aa64b527..259aa3fc 100644 --- a/assets/en_US_developer_theme.md.fec1d800.js +++ b/assets/en_US_developer_theme.md.ab8eaaf4.js @@ -1 +1 @@ -import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1698375851000}'),n={name:"en_US/developer/theme.md"},c=a('

Nezha Theme Development Environment

Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes

WARNING

Please note: This development environment only supports dashboard v0.13.16 and newer versions.

How to use

  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml(The callback connection can be filled with http://localhost
  3. Run docker-compose up
  4. Start development
  5. Once the theme has been created, you can place theme-custom in /opt/nezha/dashboard/theme-custom on the server

FAQ

',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; +import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1701534410000}'),n={name:"en_US/developer/theme.md"},c=a('

Nezha Theme Development Environment

Nezha Monitoring provides a theme development environment that you can use to create new Nezha Monitoring themes

WARNING

Please note: This development environment only supports dashboard v0.13.16 and newer versions.

How to use

  1. Clone this repository to local
  2. Modify the Oauth2 configuration in data/config.yaml(The callback connection can be filled with http://localhost
  3. Run docker-compose up
  4. Start development
  5. Once the theme has been created, you can place theme-custom in /opt/nezha/dashboard/theme-custom on the server

FAQ

',7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; diff --git a/assets/en_US_developer_theme.md.fec1d800.lean.js b/assets/en_US_developer_theme.md.ab8eaaf4.lean.js similarity index 84% rename from assets/en_US_developer_theme.md.fec1d800.lean.js rename to assets/en_US_developer_theme.md.ab8eaaf4.lean.js index ebaaa026..0685702e 100644 --- a/assets/en_US_developer_theme.md.fec1d800.lean.js +++ b/assets/en_US_developer_theme.md.ab8eaaf4.lean.js @@ -1 +1 @@ -import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1698375851000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; +import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/theme.md","filePath":"en_US/developer/theme.md","lastUpdated":1701534410000}'),n={name:"en_US/developer/theme.md"},c=a("",7),r=[c];function l(i,h,d,s,m,p){return o(),t("div",null,r)}const v=e(n,[["render",l]]);export{_ as __pageData,v as default}; diff --git a/assets/en_US_guide_agent.md.27bff8f7.js b/assets/en_US_guide_agent.md.6683a40f.js similarity index 99% rename from assets/en_US_guide_agent.md.27bff8f7.js rename to assets/en_US_guide_agent.md.6683a40f.js index 3c1ed317..dc313f38 100644 --- a/assets/en_US_guide_agent.md.27bff8f7.js +++ b/assets/en_US_guide_agent.md.6683a40f.js @@ -1,4 +1,4 @@ -import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1698375851000}'),o={name:"en_US/guide/agent.md"},e=l(`

The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard

TIP

Agent binary repository: https://github.com/nezhahq/agent/releases

Install Agent using one-click script

Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server

Preparation

First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name "data.example.com" mentioned earlier for demonstration
Enter the administration panel, go to the "Settings" page, in the item "CDN Bypassed Domain/IP ", fill in the communication domain name, and then click "Save"

One-click installation on Linux (Ubuntu, Debian, CentOS)

One-click installation on Windows

Other ways to install Agent


Installing Agent on Linux (Ubuntu, Debian, CentOS)

bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh

Installing Agent on other Linux (such as alpine use oprec not systemd)

Contributed by unknown0054

shell
cat >/etc/init.d/nezha-agent<< EOF
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1701534410000}'),o={name:"en_US/guide/agent.md"},e=l(`

The service in the monitored server is called Agent. This document will describe how to install the Agent on the monitored server and connect it with Dashboard

TIP

Agent binary repository: https://github.com/nezhahq/agent/releases

Install Agent using one-click script

Nezha Monitoring now supports one-click installation of the Agent on Windows and Linux. Follow the steps in this document and you can easily deploy it on your server

Preparation

First of all, you need to set up the communication domain name in the settings page of the admin panel, this domain name can not connect to the CDN, here is the sample communication domain name "data.example.com" mentioned earlier for demonstration
Enter the administration panel, go to the "Settings" page, in the item "CDN Bypassed Domain/IP ", fill in the communication domain name, and then click "Save"

One-click installation on Linux (Ubuntu, Debian, CentOS)

  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Run the copied one-click installation command on the monitored server, wait for the installation to complete, and then return to the Dashboard home page to see if the server is online.

One-click installation on Windows

  • First add a server in the admin panel
  • Click on the green Linux icon button next to the newly added server and copy the one-click installation command
  • Login to Windows Server, open PowerShell, and run the copied installation command in PowerShell
  • If you encounter the prompt "Implement Policy Change" please select Y
  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online



Other ways to install Agent


Installing Agent on Linux (Ubuntu, Debian, CentOS)

  • First add a server in the admin panel
  • In the monitored server, run the script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • Select “Install_agent”

  • Input the communication domain name, e.g. "data.example.com"

  • Input RPC port, default is 5555

  • Input the Agent Secret, which is generated when adding a server in the administration panel and can be found in the " Servers " page of the administration panel

  • Wait for the installation to complete and return to the Dashboard home page to see if the server is online

Installing Agent on other Linux (such as alpine use oprec not systemd)

Contributed by unknown0054

  • Edit SERVER,SECRET,TLS then run it in Shell
shell
cat >/etc/init.d/nezha-agent<< EOF
 #!/sbin/openrc-run
 SERVER="" #Dashboard address ip:port
 SECRET="" #SECRET
diff --git a/assets/en_US_guide_agent.md.27bff8f7.lean.js b/assets/en_US_guide_agent.md.6683a40f.lean.js
similarity index 84%
rename from assets/en_US_guide_agent.md.27bff8f7.lean.js
rename to assets/en_US_guide_agent.md.6683a40f.lean.js
index d91732f9..357f974b 100644
--- a/assets/en_US_guide_agent.md.27bff8f7.lean.js
+++ b/assets/en_US_guide_agent.md.6683a40f.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1698375851000}'),o={name:"en_US/guide/agent.md"},e=l("",53),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default};
+import{_ as s,o as n,c as a,R as l}from"./chunks/framework.44fd0451.js";const h=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agent.md","filePath":"en_US/guide/agent.md","lastUpdated":1701534410000}'),o={name:"en_US/guide/agent.md"},e=l("",53),p=[e];function t(r,c,i,D,y,C){return n(),a("div",null,p)}const u=s(o,[["render",t]]);export{h as __pageData,u as default};
diff --git a/assets/en_US_guide_agentq.md.eb2f5013.js b/assets/en_US_guide_agentq.md.f3d60b04.js
similarity index 96%
rename from assets/en_US_guide_agentq.md.eb2f5013.js
rename to assets/en_US_guide_agentq.md.f3d60b04.js
index f69eff5e..875bd322 100644
--- a/assets/en_US_guide_agentq.md.eb2f5013.js
+++ b/assets/en_US_guide_agentq.md.f3d60b04.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1698375851000}'),o={name:"en_US/guide/agentq.md"},i=n('

Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Please check Dashboard - Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Error on one-click script installation

curl: Failed to connect to raw.githubusercontent.com...

Please check if your server can connect to Github, try again, or check Other ways to install Agent

sudo: command not found

Please install sudo first

',7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default}; +import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1701534410000}'),o={name:"en_US/guide/agentq.md"},i=n('

Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Please check Dashboard - Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

Error on one-click script installation

curl: Failed to connect to raw.githubusercontent.com...

Please check if your server can connect to Github, try again, or check Other ways to install Agent

sudo: command not found

Please install sudo first

',7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default}; diff --git a/assets/en_US_guide_agentq.md.eb2f5013.lean.js b/assets/en_US_guide_agentq.md.f3d60b04.lean.js similarity index 84% rename from assets/en_US_guide_agentq.md.eb2f5013.lean.js rename to assets/en_US_guide_agentq.md.f3d60b04.lean.js index b4fb6fe5..f1e05ec1 100644 --- a/assets/en_US_guide_agentq.md.eb2f5013.lean.js +++ b/assets/en_US_guide_agentq.md.f3d60b04.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1698375851000}'),o={name:"en_US/guide/agentq.md"},i=n("",7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default}; +import{_ as e,o as a,c as t,R as n}from"./chunks/framework.44fd0451.js";const _=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/agentq.md","filePath":"en_US/guide/agentq.md","lastUpdated":1701534410000}'),o={name:"en_US/guide/agentq.md"},i=n("",7),r=[i];function c(h,d,l,s,u,p){return a(),t("div",null,r)}const f=e(o,[["render",c]]);export{_ as __pageData,f as default}; diff --git a/assets/en_US_guide_api.md.5bfd89f2.js b/assets/en_US_guide_api.md.7c016679.js similarity index 99% rename from assets/en_US_guide_api.md.5bfd89f2.js rename to assets/en_US_guide_api.md.7c016679.js index d9c5ae8b..45c904a3 100644 --- a/assets/en_US_guide_api.md.5bfd89f2.js +++ b/assets/en_US_guide_api.md.7c016679.js @@ -1,4 +1,4 @@ -import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1698375851000}'),t={name:"en_US/guide/api.md"},e=o(`

Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API

Create Token

API allows Token authentication method and Cookies authentication method
To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
Click "Add Token" and after customizing the notes, click "Add"
To delete a Token, please select the corresponding Token and click the delete icon on the right

WARNING

Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others

Authentication method

Token authentication method:

Request Headers:  
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1701534410000}'),t={name:"en_US/guide/api.md"},e=o(`

Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API

Create Token

API allows Token authentication method and Cookies authentication method
To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page
Click "Add Token" and after customizing the notes, click "Add"
To delete a Token, please select the corresponding Token and click the delete icon on the right

WARNING

Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others

Authentication method

Token authentication method:

Request Headers:  
 Authorization: Token

How to use

WARNING

The negative timestamp in the example below is (0000-00-00)
It is currently used to indicate that the Agent has never reported since the Dashboard went live
However, it is not recommended to use positivity or negativity to determine the status

TIP

The request method is Get and the return format is JSON.

  • Get a list of servers: GET /api/v1/server/list?tag=
    query: tag (ServerTag means the group of servers, if this value is provided, only the servers in this group are queried)

JSON Return Example:

{
     "code": 0,
     "message": "success",
diff --git a/assets/en_US_guide_api.md.5bfd89f2.lean.js b/assets/en_US_guide_api.md.7c016679.lean.js
similarity index 84%
rename from assets/en_US_guide_api.md.5bfd89f2.lean.js
rename to assets/en_US_guide_api.md.7c016679.lean.js
index 676ae0f6..234fe5a6 100644
--- a/assets/en_US_guide_api.md.5bfd89f2.lean.js
+++ b/assets/en_US_guide_api.md.7c016679.lean.js
@@ -1 +1 @@
-import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1698375851000}'),t={name:"en_US/guide/api.md"},e=o("",16),l=[e];function p(u,c,i,r,q,C){return n(),a("div",null,l)}const d=s(t,[["render",p]]);export{y as __pageData,d as default};
+import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1701534410000}'),t={name:"en_US/guide/api.md"},e=o("",16),l=[e];function p(u,c,i,r,q,C){return n(),a("div",null,l)}const d=s(t,[["render",p]]);export{y as __pageData,d as default};
diff --git a/assets/en_US_guide_dashboard.md.d3da906a.js b/assets/en_US_guide_dashboard.md.7413067e.js
similarity index 99%
rename from assets/en_US_guide_dashboard.md.d3da906a.js
rename to assets/en_US_guide_dashboard.md.7413067e.js
index 7b1e193e..ba9807d1 100644
--- a/assets/en_US_guide_dashboard.md.d3da906a.js
+++ b/assets/en_US_guide_dashboard.md.7413067e.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1698375851000}'),s={name:"en_US/guide/dashboard.md"},n=o(`

Preparations

To setup a Nezha monitorning Dashboard, you need these things:

  1. A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios
  2. A domain name that has been set up with an A record that resolves to the Dashboard server IP

TIP

If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.
This document uses "cdn.example.com" and "data.example.com" domains to demonstrate respectively

  1. A Github or Gitlab account

This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only

WARNING

This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.
If you don't think it's necessary to use port 80 or 443 to access Dashboard, you don't even need to install NginX and you can just use the install script.



Get the Client ID and Client Secret on Github/Gitlab

Nezha Monitor uses a Github account as the login account for the admin panel

  • First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App "
    Application name - Fill in as you like
    Homepage URL - Fill in the panel's access domain name, such as: "http://cdn.example.com"
    Authorization callback URL - Fill in the callback address, e.g., "http://cdn.example.com/oauth2/callback"
  • Click on "Registration Application"
  • Remember the Client ID in the page, then click "Generate a new client secret" to create a new Client Secret, the new secret will be displayed only once, please save it properly

  • If you're using Gitlab, you'll need to go to https://gitlab.com/-/profile/applications to create a new application
  • Fill in Redirect URL with the callback address
  • In Scopes, select read_user and read_api
  • Once created, save the Application ID and Secret

Installing Dashboard on the server

  • In the panel server, run the installation script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • After waiting for the Docker installation to complete, input the following settings:
    OAuth2 provider - Github or Gitlab
    Client ID - Previously saved Client ID
    Client Secret - Previously saved secret
    GitHub/Gitee login name - Github o Gitlab username
    Site title - Custom site title
    Site access port - Public access port, customizable, default 8008
    RPC port - The communication port between Agent and Dashboard, default 5555

  • After the input is complete, wait to pull the mirror
    After the installation, if everything is fine, you can visit the domain + port number, such as "http://cdn.example.com:8008" to view the Dashboard

  • In the future, if you need to run the script again, you can run:

bash
./nezha.sh

to open the management script


Configure reverse proxy

  • Create a new site in the aaPanel, fill in the public access domain name, such as "http://cdn.example.com", then click "Settings" to enter the site settings option, select " Reverse proxy" - "New reverse proxy"

  • Customize a proxy name, fill in http://127.0.0.1 in the "Target URL" and click "Save"

  • Open the " configuration" to the right of the new reverse proxy you just created and replace the configuration file with the following:

nginx
#PROXY-START/
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1701534410000}'),s={name:"en_US/guide/dashboard.md"},n=o(`

Preparations

To setup a Nezha monitorning Dashboard, you need these things:

  1. A VPS that can connect to the Internet, firewall and security policies need to open ports 8008 and 5555, otherwise it will be inaccessible and unable to receive data. A 1 core 512MB RAM server is sufficient for most usage scenarios
  2. A domain name that has been set up with an A record that resolves to the Dashboard server IP

TIP

If you want to use CDN, please prepare two domains, one connect to CDN for public access, CDN needs to support WebSocket protocol; the other domain should not connect to CDN, use it as Agent to send data to Dashboard.
This document uses "cdn.example.com" and "data.example.com" domains to demonstrate respectively

  1. A Github or Gitlab account

This document will use the aaPanel as an example, with future versions of the changes, some of the features may change, this document is for reference only

WARNING

This project does not rely on aaPanel, you can choose to use any server panel you like, and if you are capable enough, you can manually install NginX or Caddy to configure SSL and reverse proxy.
If you don't think it's necessary to use port 80 or 443 to access Dashboard, you don't even need to install NginX and you can just use the install script.



Get the Client ID and Client Secret on Github/Gitlab

Nezha Monitor uses a Github account as the login account for the admin panel

  • First we need to create a new authentication application, after logging into Github, open https://github.com/settings/developers and select "OAuth Apps" - "New OAuth App "
    Application name - Fill in as you like
    Homepage URL - Fill in the panel's access domain name, such as: "http://cdn.example.com"
    Authorization callback URL - Fill in the callback address, e.g., "http://cdn.example.com/oauth2/callback"
  • Click on "Registration Application"
  • Remember the Client ID in the page, then click "Generate a new client secret" to create a new Client Secret, the new secret will be displayed only once, please save it properly

  • If you're using Gitlab, you'll need to go to https://gitlab.com/-/profile/applications to create a new application
  • Fill in Redirect URL with the callback address
  • In Scopes, select read_user and read_api
  • Once created, save the Application ID and Secret

Installing Dashboard on the server

  • In the panel server, run the installation script:
bash
curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install_en.sh  -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh
  • After waiting for the Docker installation to complete, input the following settings:
    OAuth2 provider - Github or Gitlab
    Client ID - Previously saved Client ID
    Client Secret - Previously saved secret
    GitHub/Gitee login name - Github o Gitlab username
    Site title - Custom site title
    Site access port - Public access port, customizable, default 8008
    RPC port - The communication port between Agent and Dashboard, default 5555

  • After the input is complete, wait to pull the mirror
    After the installation, if everything is fine, you can visit the domain + port number, such as "http://cdn.example.com:8008" to view the Dashboard

  • In the future, if you need to run the script again, you can run:

bash
./nezha.sh

to open the management script


Configure reverse proxy

  • Create a new site in the aaPanel, fill in the public access domain name, such as "http://cdn.example.com", then click "Settings" to enter the site settings option, select " Reverse proxy" - "New reverse proxy"

  • Customize a proxy name, fill in http://127.0.0.1 in the "Target URL" and click "Save"

  • Open the " configuration" to the right of the new reverse proxy you just created and replace the configuration file with the following:

nginx
#PROXY-START/
 location / {
     proxy_pass http://127.0.0.1:8008;
     proxy_set_header Host $http_host;
diff --git a/assets/en_US_guide_dashboard.md.d3da906a.lean.js b/assets/en_US_guide_dashboard.md.7413067e.lean.js
similarity index 85%
rename from assets/en_US_guide_dashboard.md.d3da906a.lean.js
rename to assets/en_US_guide_dashboard.md.7413067e.lean.js
index be9aa0b2..82e9e817 100644
--- a/assets/en_US_guide_dashboard.md.d3da906a.lean.js
+++ b/assets/en_US_guide_dashboard.md.7413067e.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1698375851000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default};
+import{_ as e,o as a,c as t,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboard.md","filePath":"en_US/guide/dashboard.md","lastUpdated":1701534410000}'),s={name:"en_US/guide/dashboard.md"},n=o("",41),l=[n];function r(i,p,c,d,h,u){return a(),t("div",null,l)}const m=e(s,[["render",r]]);export{y as __pageData,m as default};
diff --git a/assets/en_US_guide_dashboardq.md.60106923.js b/assets/en_US_guide_dashboardq.md.ac655fb7.js
similarity index 98%
rename from assets/en_US_guide_dashboardq.md.60106923.js
rename to assets/en_US_guide_dashboardq.md.ac655fb7.js
index d5724c49..a04a6eaf 100644
--- a/assets/en_US_guide_dashboardq.md.60106923.js
+++ b/assets/en_US_guide_dashboardq.md.ac655fb7.js
@@ -1,4 +1,4 @@
-import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1698375851000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`

Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.

TIP

To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server

You can also test the exit IP by running the following command in the Agent server:

shell
curl https://ipapi.co/ip/
+import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1701534410000}'),t={name:"en_US/guide/dashboardq.md"},n=o(`

Why the IP displayed in the admin panel and the actual IP of the Agent are not the same?

First of all, explain how the IP displayed in the admin panel is gotten: the Agent will request the IP-API every once in a while, get the IP information and report it to the Dashboard, the IP-API currently used can be viewed here: myip.go
If you find that the IP displayed in the admin panel is not the same as the IP provided to you by the service provider, the biggest possibility is that the service provider gave you the entry IP, but the Agent tested out your exit IP. This problem may also occur in BGP servers and Leased line.

TIP

To take a simple and very common example, the service provider to provide you a anti-DDoS server, in order to meet the goals of both DDoS protection and low network disruption rate, the IP provided to you may be the mapped anti-DDoS IP and not the real exit IP of your server

You can also test the exit IP by running the following command in the Agent server:

shell
curl https://ipapi.co/ip/
 curl ip.sb
 curl ip-api.com

Forgot your access password or deleted your access password

Please view or edit the /opt/nezha/dashboard/data/config.yaml file.
The password is located in the site-viewpassword item.

Dashboard install/restart/update failed: iptables ......

First, try restarting docker and retrying again

shell
systemctl status docker
 systemctl restart docker
diff --git a/assets/en_US_guide_dashboardq.md.60106923.lean.js b/assets/en_US_guide_dashboardq.md.ac655fb7.lean.js
similarity index 70%
rename from assets/en_US_guide_dashboardq.md.60106923.lean.js
rename to assets/en_US_guide_dashboardq.md.ac655fb7.lean.js
index e40ecbc2..6b9cc958 100644
--- a/assets/en_US_guide_dashboardq.md.60106923.lean.js
+++ b/assets/en_US_guide_dashboardq.md.ac655fb7.lean.js
@@ -1 +1 @@
-import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1698375851000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",18),l=[n];function r(i,p,c,d,h,y){return a(),s("div",null,l)}const g=e(t,[["render",r]]);export{b as __pageData,g as default};
+import{_ as e,o as a,c as s,R as o}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/dashboardq.md","filePath":"en_US/guide/dashboardq.md","lastUpdated":1701534410000}'),t={name:"en_US/guide/dashboardq.md"},n=o("",18),l=[n];function r(i,p,c,d,h,y){return a(),s("div",null,l)}const g=e(t,[["render",r]]);export{b as __pageData,g as default};
diff --git a/assets/en_US_guide_loginq.md.6e1954e3.js b/assets/en_US_guide_loginq.md.2cd38989.js
similarity index 98%
rename from assets/en_US_guide_loginq.md.6e1954e3.js
rename to assets/en_US_guide_loginq.md.2cd38989.js
index a07462b9..e5983ee6 100644
--- a/assets/en_US_guide_loginq.md.6e1954e3.js
+++ b/assets/en_US_guide_loginq.md.2cd38989.js
@@ -1 +1 @@
-import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1698375851000}'),r={name:"en_US/guide/loginq.md"},i=a('

Page refuses to connect or timeout after login callback

  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.

TIP

What is a protocol?
In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.

How do I check if my callback URL is wrong?

Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
Please make sure your path is /oauth2/callback, all lowercase.

Dashboard errors after login

  1. Clear your browser cookies and log in again, or change your browser.
  2. Check the callback address to ensure that your callback address is correct and that both the port and protocol are correct! The address from which the request is initiated needs to be in the same domain as the callback address, and the port, protocol, and domain name (or IP) all need to be consistent.

lookup xxx

DNS resolution failure, in most cases, is due to iptables-related configuration changes.
It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
This problem may also be related to the kernel, please try to change the official kernel.

The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked

Suggest changing the authentication method to Github/Gitlab.

oauth2: server response missing access_token

It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
If you can't solve it, we suggest changing the authentication method to Github/Gitlab.

This user is not the administrator or cannot login

You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.

dial tcp xxx:443 i/o timeout

If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
You can also change to another OAuth method if necessary.

net/http: TLS handshake timeout

Same as above.

',20),s=[i];function n(l,c,h,d,u,m){return o(),t("div",null,s)}const k=e(r,[["render",n]]);export{b as __pageData,k as default}; +import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1701534410000}'),r={name:"en_US/guide/loginq.md"},i=a('

Page refuses to connect or timeout after login callback

  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.

TIP

What is a protocol?
In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.

How do I check if my callback URL is wrong?

Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
Please make sure your path is /oauth2/callback, all lowercase.

Dashboard errors after login

  1. Clear your browser cookies and log in again, or change your browser.
  2. Check the callback address to ensure that your callback address is correct and that both the port and protocol are correct! The address from which the request is initiated needs to be in the same domain as the callback address, and the port, protocol, and domain name (or IP) all need to be consistent.

lookup xxx

DNS resolution failure, in most cases, is due to iptables-related configuration changes.
It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
This problem may also be related to the kernel, please try to change the official kernel.

The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked

Suggest changing the authentication method to Github/Gitlab.

oauth2: server response missing access_token

It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
If you can't solve it, we suggest changing the authentication method to Github/Gitlab.

This user is not the administrator or cannot login

You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.

dial tcp xxx:443 i/o timeout

If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
You can also change to another OAuth method if necessary.

net/http: TLS handshake timeout

Same as above.

',20),s=[i];function n(l,c,h,d,u,m){return o(),t("div",null,s)}const k=e(r,[["render",n]]);export{b as __pageData,k as default}; diff --git a/assets/en_US_guide_loginq.md.6e1954e3.lean.js b/assets/en_US_guide_loginq.md.2cd38989.lean.js similarity index 84% rename from assets/en_US_guide_loginq.md.6e1954e3.lean.js rename to assets/en_US_guide_loginq.md.2cd38989.lean.js index 81228a03..00ae94b7 100644 --- a/assets/en_US_guide_loginq.md.6e1954e3.lean.js +++ b/assets/en_US_guide_loginq.md.2cd38989.lean.js @@ -1 +1 @@ -import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1698375851000}'),r={name:"en_US/guide/loginq.md"},i=a("",20),s=[i];function n(l,c,h,d,u,m){return o(),t("div",null,s)}const k=e(r,[["render",n]]);export{b as __pageData,k as default}; +import{_ as e,o,c as t,R as a}from"./chunks/framework.44fd0451.js";const b=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/loginq.md","filePath":"en_US/guide/loginq.md","lastUpdated":1701534410000}'),r={name:"en_US/guide/loginq.md"},i=a("",20),s=[i];function n(l,c,h,d,u,m){return o(),t("div",null,s)}const k=e(r,[["render",n]]);export{b as __pageData,k as default}; diff --git a/assets/en_US_guide_notifications.md.88d86f03.js b/assets/en_US_guide_notifications.md.c66257b2.js similarity index 99% rename from assets/en_US_guide_notifications.md.88d86f03.js rename to assets/en_US_guide_notifications.md.c66257b2.js index 1284d5f0..8bd34afe 100644 --- a/assets/en_US_guide_notifications.md.88d86f03.js +++ b/assets/en_US_guide_notifications.md.c66257b2.js @@ -1,4 +1,4 @@ -import{_ as o,o as s,c as e,R as n}from"./chunks/framework.44fd0451.js";const F=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md","filePath":"en_US/guide/notifications.md","lastUpdated":1698375851000}'),t={name:"en_US/guide/notifications.md"},a=n(`

Nezha Monitoring supports monitoring of server load, CPU, memory, hard disk, data transfer, monthly data transfer, number of processes, number of connections, and sends alarm notifications when one of these items reaches a user-set limit.


Flexible notification methods

In panel messages, the placeholder #DATETIME# represents the timestamp of when an event occurs. When the notification is triggered, the panel automatically replaces #DATETIME# with the actual time of the event.

#NEZHA# is the panel message placeholder, the panel will automatically replace the placeholder with the actual message when it triggers the notification

The content of Body is in JSON format:When the request type is FORM,the value is in the form of key:valuevalue can contain placeholders that will be automatically replaced when notified. When the request type is JSON It will only do string substitution and submit to the URL directly.

Placeholders can also be placed inside the URL, and it will perform a simple string substitution when requested.

Refer to the example below, it is very flexible.

- diff --git a/en_US/guide/loginq.html b/en_US/guide/loginq.html index 0424f674..aa5199f1 100644 --- a/en_US/guide/loginq.html +++ b/en_US/guide/loginq.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Page refuses to connect or timeout after login callback

  1. Your server cannot connect to Github, consider trying several times or switching to Gitlab.
  2. You have configured the wrong callback URL, make sure your callback URL is correct and port and protocol are correct!
  3. An unknown error occurred in Dashboard, you can use the script to check the logs.

TIP

What is a protocol?
In the browser, your domain name ending with :// is the protocol, usually http and https. Since the Dashboard may be accessible by multiple protocols + domain + port combinations under normal deployment, please make sure to choose the most appropriate one as the callback.

How do I check if my callback URL is wrong?

Please make sure the protocol+domain+port displayed by your browser before login and the protocol+domain+port you jump to after login are the same.
Please make sure your path is /oauth2/callback, all lowercase.

Dashboard errors after login

  1. Clear your browser cookies and log in again, or change your browser.
  2. Check the callback address to ensure that your callback address is correct and that both the port and protocol are correct! The address from which the request is initiated needs to be in the same domain as the callback address, and the port, protocol, and domain name (or IP) all need to be consistent.

lookup xxx

DNS resolution failure, in most cases, is due to iptables-related configuration changes.
It is recommended to restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
If the lookup error still occurs, it is recommended to check whether there are other tools to control iptables, such as Aapanel Firewall.
This problem may also be related to the kernel, please try to change the official kernel.

The authorization method is invalid, or the login callback URL is invalid, expired, or has been revoked

Suggest changing the authentication method to Github/Gitlab.

oauth2: server response missing access_token

It may be caused by a number of factors, the most likely is a network problem, we suggest to check the network and retry.
If you can't solve it, we suggest changing the authentication method to Github/Gitlab.

This user is not the administrator or cannot login

You have logged into the wrong account or configured the wrong username, note that username is not email, you can use a script to modify it.

dial tcp xxx:443 i/o timeout

If the server has network problems, you can restart docker first, sudo systemctl restart docker, and then use the script to restart the Dashboard.
You can also change to another OAuth method if necessary.

net/http: TLS handshake timeout

Same as above.

- diff --git a/en_US/guide/notifications.html b/en_US/guide/notifications.html index cdb5ac7e..ebbf6618 100644 --- a/en_US/guide/notifications.html +++ b/en_US/guide/notifications.html @@ -10,7 +10,7 @@ - + @@ -54,8 +54,8 @@ "markdown": { "content": "# Nezha Notification\n\n\"#NEZHA#\"\n\n> ServerName: \"#SERVER.NAME#\"\n> IP: \"#SERVER.IP#\"\n> IPv4: \"#SERVER.IPV4#\"\n> IPv6: \"#SERVER.IPV6#\"\n> CPU: \"#SERVER.CPU#\"\n> Memory: \"#SERVER.MEM#\"\n> SWAP: \"#SERVER.SWAP#\"\n> Storage: \"#SERVER.DISK#\"\n> Real-time Upload: \"#SERVER.NETINSPEED#\"\n> Real-time Download: \"#SERVER.NETOUTSPEED#\"\n> Total Upload: \"#SERVER.TRANSFERIN#\"\n> Total Download: \"#SERVER.TRANSFEROUT#\"\n> 1m Load: \"#SERVER.LOAD1#\"\n> 5m Load: \"#SERVER.LOAD5#\"\n> 15m Load: \"#SERVER.LOAD15#\"\n> TCP Connections: \"#SERVER.TCPCONNCOUNT\"\n> UDP Connections: \"#SERVER.UDPCONNCOUNT\"\n\n" } -}

Delete relevant content information as needed

Notice Picture



Description of notification rules

Basic Rules

  • Type: one or more types can be selected, such as in a rule to select more than one type, you need to meet all the selected types at the same time to trigger the notification (see the example later)
    • cpumemoryswapdisk
    • net_in_speed Inbound speed, net_out_speed Outbound speed, net_all_speed Inbound + Outbound speed, transfer_in Inbound Transfer, transfer_out Outbound Transfer, transfer_all Total Transfer
    • offline Offline monitoring
    • load1load5load15 Load
    • process_count Number of processes Currently, counting the number of processes takes up too many resources and is not supported at the moment
    • tcp_conn_countudp_conn_count Number of connections
  • duration:Lasting for a few seconds, the notification will only be triggered when the sampling record reaches 30% or more within a few seconds
  • min/max
    • Transfer, network speed, and other values of the same type. Unit is byte (1KB=1024B,1MB = 1024*1024B)
    • Memory, hard disk, CPU. units are usage percentages
    • No setup required for offline monitoring
  • cover [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
    • 0 Cover all, use ignore to ignore specific servers
    • 1 Ignore all, use ignore to monitoring specific servers
      For example: [{"type":"offline","duration":10, "cover":0, "ignore":{"5": true}}]
  • ignore: Select to ignore specific servers, use with cover with server id and boolean, e.g.: {"1": true, "2":false}

Complete examples:

Add an offline notification

  • Name: Offline notification
  • Rules: [{"Type":"offline","Duration":10}]
  • Enable: √

Add an notification when the CPU exceeds 50% for 10s but the memory usage is below 20% for 20s

  • Name: CPU and RAM
  • Rules: [{"Type":"cpu","Min":0,"Max":50,"Duration":10},{"Type":"memory","Min":20,"Max":0,"Duration":20}]
  • Enable: √

Send specific server notifications to specific notification groups

Case:
You have four servers, 1, 2, 3, 4, and two different notification groups, A and B
1, 2 The two servers are down for 10 minutes and send a notification to Notification Group A
3, 4 These two servers are down for ten minutes and then send a notification to Notification Group B

First you need to set up two notification groups, A and B, and then add two alarm rules:

Rule I:

  • Name: 1, 2 Off-line, send notification to group A
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"1":true,"2":true}}]
  • Notification group: A
  • Enable: √

Rule II:

  • Name: 3, 4 Off-line, send notification to group B
  • Rules:[{"type":"offline","duration":600,"cover":1,"ignore":{"3":true,"4":true}}]
  • Notification group: B
  • Enable: √

Using these rules flexibly will help you to make full use of the notification function


Special: Any-cycle transfer notification

Can be used as monthly transfer notificatin

  • type

    • transfer_in_cycle Inbound transfer during the cycle
    • transfer_out_cycle Outbound transfer during the cycle
    • transfer_all_cycle The sum of inbound and outbound transfer during the cycle
  • cycle_start Start date of the statistical cycle (can be the start date of your server's billing cycle), the time format is RFC3339, for example, the format in Beijing time zone is 2022-01-11T08:00:00.00+08:00

  • cycle_interval Interval time cycle (For example, if the cycle is in days and the value is 7, it means that the statistics are counted every 7 days)

  • cycle_unit Statistics cycle unit, default hour, optional (hour, day, week, month, year)

  • min/max, cover, ignore Please refer to the basic rules to configure

Example:

The servers with ID 3 and 4 (defined in the ignore) are counted on the 1st of each month, and a notification is triggered when the monthly outbound transfer reaches 1TB during the cycle.

[{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

Description of mode of triggering notification

  • Always triggered: A notification is triggered each time the status reported by the Agent matches the rules of the notification
  • Triggered only once: only one notification is triggered when the state changes, such as changing from normal state to abnormal state or abnormal state back to normal state

Set the task to be executed when notification

If you need to perform a task while sending a notification message, you can set those items

  • Tasks to be triggered in case of failure The task to be executed when the notification status matches the change from "normal" to "failure", the task should be set in advance in the tasks page
  • Tasks to be triggered after fault recovery The task to be executed when the notification status matches the change from " failure " to " normal ", the task should be set in advance in the tasks page
- diff --git a/en_US/guide/q2.html b/en_US/guide/q2.html index 3633882f..eccbe518 100644 --- a/en_US/guide/q2.html +++ b/en_US/guide/q2.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Let the Agent start/on-line, and the self-test process of the problem

  1. Run //opt/nezha/agent/nezha-agent -s IP/Domin(Panel IP or Domain not connected to CDN):port(Panel RPC port) -p secret(Agent Secret) -d Check the logs to see if the timeout is due to a DNS problem or poor network
  2. nc -v domain/IP port(Panel RPC port) or telnet domain/IP port(Panel RPC port) to check if it' s a network problem, check the inbound and outbound firewall between the local machine and the panel server, if you can' t determine the problem you can check it with the port checking tool provided by https://port.ping.pe/
  3. If the above steps work and the Agent is online, please try to turn off SELinux on the panel server. How to close SELinux?
- diff --git a/en_US/guide/q3.html b/en_US/guide/q3.html index aeb78edc..70665740 100644 --- a/en_US/guide/q3.html +++ b/en_US/guide/q3.html @@ -10,7 +10,7 @@ - + @@ -51,8 +51,8 @@ versions h2c 2 } } -}

Dashboard Configuration

Agent Configuration

Enable Cloudflare CDN (optional)

According to Cloudflare gRPC requirements: gRPC services must listen on port 443 and must support TLS and HTTP/2. So if you need to enable CDN, you must use port 443 when configuring Nginx or Caddy reverse proxy gRPC and configure the certificate (Caddy will automatically apply and configure the certificate).

- diff --git a/en_US/guide/q4.html b/en_US/guide/q4.html index 5a7f0172..480e7a68 100644 --- a/en_US/guide/q4.html +++ b/en_US/guide/q4.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Real-time channel disconnection/online terminal connection failure

  • If you are using a CDN, please make sure that the CDN provider provides WebSocket service and that WebSocket is enabled
  • Confirm that you are using a reverse proxy requires special configuration of the WebSocket for the /ws and /terminal paths, you can click here to see the reverse proxy configuration
- diff --git a/en_US/guide/q5.html b/en_US/guide/q5.html index f1523c69..da9ec68d 100644 --- a/en_US/guide/q5.html +++ b/en_US/guide/q5.html @@ -10,13 +10,13 @@ - + -
- diff --git a/en_US/guide/q6.html b/en_US/guide/q6.html index fdc2f7b6..aee01f75 100644 --- a/en_US/guide/q6.html +++ b/en_US/guide/q6.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

How to set up a monthly reset of transfer statistics?

In the home page, the traffic statistics will be reset when the server is restarted.
If you want to set the traffic statistics to be reset once a month, you can do it like this:

  1. Go to the Notification page of the admin panel
  2. Refer to this document to create a monthly transfer statistics notification
  3. Return to the home page and you can see the monthly transfer statistics in the Service page, where the statistics will not be reset when the server is restarted

TIP

This method can be set to any period, including and not limited to hourly/daily/weekly/monthly/yearly reset transfer statistics, very flexible!

- diff --git a/en_US/guide/q7.html b/en_US/guide/q7.html index ede5bd15..f272e9e4 100644 --- a/en_US/guide/q7.html +++ b/en_US/guide/q7.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Customize Agent

Customize the NIC and hard drive partitions to be monitored

  • Run /opt/nezha/agent/nezha-agent --edit-agent-config to select a custom NIC and partition, and then restart Agent

Other Flags

Run ./nezha-agent --help to view supported flags,if you are already using the one-click script, you can edit /etc/systemd/system/nezha-agent.service,at the end of this line ExecStart= add:

  • --report-delay System information reporting interval, default is 1 second, can be set to 3 to reduce the system resource usage on the agent side (configuration range 1-4)
  • --skip-conn Not monitoring the number of connections, if it is a server with a large number of connections, the CPU usage will be high. It is recommended to set this to reduce CPU usage
  • --skip-procs Disable monitoring the number of processes can also reduce CPU and memory usage
  • --disable-auto-update Disable Automatic Update Agent (security feature)
  • --disable-force-update Disable Forced Update Agent (security feature)
  • --disable-command-execute Disable execution of scheduled tasks, disallow WebShell (security feature)
  • --tls Enable SSL/TLS encryption (If you are using nginx to reverse proxy Agent´s grpc connections, and if nginx has SSL/TLS enabled, you need to enable this configuration)
- diff --git a/en_US/guide/servers.html b/en_US/guide/servers.html index e905b03e..a8b942f7 100644 --- a/en_US/guide/servers.html +++ b/en_US/guide/servers.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Servers

Introduction

The Servers area is responsible for managing the Agent, the most basic area in Nezha Monitoring, and the basis for other functions.

Add a server

The first step is to add a servers, which can be customized with names, groups, display index and notes.
Servers in the same group will be displayed in groups in supported themes, and notes will only be displayed in the admin panel, no need to worry about leaking information.

Install Agent

Please refer to the previous article: Install Agent
We recommend using one-click installation, that is, after configuring the communication domain name, click the button on the column one-click installation and copy it to the monitored servers for installation.

Forced Updates

The flags related to the update of the Agent are: --disable-auto-update and --disable-force-update. Please refer to Customize Agent
By default, the Agent is updated automatically, but when the user turns off automatic updates, the specified servers can also be selected for forced updates.
This feature does not take effect when -disable-force-update is turned on.

Data List

  • Version number: Record the current version of Agent
  • Secret: Used when configuring the Agent
  • One-Click Installation: A more convenient way to install Agent
  • Manage: WebShell on the left, Edit in the middle, Delete on the right

Webshell

This feature does not take effect when disable-command-execute is turned on.
Both Linux and Windows are available and can be pasted using Ctrl+Shift+V.
For connection failure, please refer to Real-time channel disconnection/online terminal connection failure.
Note that in theWebShell function, the Agent also connects to the Domain names for public access via WebSocket, not via grpc.

- diff --git a/en_US/guide/services.html b/en_US/guide/services.html index 47b0b8db..320dea36 100644 --- a/en_US/guide/services.html +++ b/en_US/guide/services.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Service area is a function setting area for setting up Agents to monitor external websites or servers
The monitoring results can be viewed on the "Services" page in the home page

How to use

To add a new monitor, you can go to the "Services" page in the administration panel and click "Add Service Monitor".

To add a service monitor, you need to complete the following settings:

  • Name - Customize a name

  • Type - Select a monitoring type. Nezha currently supports three monitoring types: "HTTP-GET", "ICMP-Ping" and "TCP-Ping".

  • Target - Depending on the type you choose, the target is set in different ways

  • HTTP-GET: Selecting this type, you should enter a URL as the target, the URL should be added with http:// or https:// If your target URL is https://, it will also monitor the SSL certificate of that URL and trigger a notification when the SSL certificate expires or changes.
    For example: https://example.com
  • ICMP-Ping: When selecting this type, you should enter a domain name or IP without a port number
    For example: 1.1.1.1 or example.com
  • TCP-Ping: When selecting this type, you should enter a domain name or IP and include the port number
    For example: 1.1.1.1:80 or example.com:22
  • Interval: Sets the time interval in seconds between each time Agent sends requests to the target

  • Coverage: Select a rule to determine which Agents to use to send requests to the target

  • Specific Servers: Use with coverage to select the Agent to be excluded from the rule

  • Notification Group: Select the notification method you have set up on the "Notification" page. Click here for more information

  • Enable Failure Notification: Select whether to receive target failure notifications as needed, default is inactive

After setting, click "Add" and you are done.
Wait for a moment to go to the "Services" page on the home page to view the monitoring results

Notification of delay changes

Nezha Monitoring monitors and statistics the delay between the Agent and the target server, and sends notifications in case of significant changes
Use this feature to help you monitor your server's routes for changes

  • Enable delay notifications:When enabled, notifications will be sent when the Agent to target server delay is higher than the Max delay or lower than the Min delay

Management Monitor

To manage existing service monitoring, you can go to the "Services" page in the administration panel
Select a monitoring configuration and click the icon on the right to edit or delete it

- diff --git a/en_US/guide/settings.html b/en_US/guide/settings.html index 29ff004b..bd617fe1 100644 --- a/en_US/guide/settings.html +++ b/en_US/guide/settings.html @@ -10,7 +10,7 @@ - + @@ -58,8 +58,8 @@ .hotaru-cover { background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center; } -</style>

Access Password

If you don't want to show your homepage directly, you can set a access password here
After setting the password, you need to enter the password to access the homepage

CDN Bypassed Domain/IP

This setting is a prerequisite for using the one-click script to install the Agent, see here for details

IP Change Alert

If you want to be notified when a server's ip changes, you can set it up here

Coverage

Select a rule here to determine which servers need to be monitored, and you can choose according to your needs

Specific Servers

In conjunction with the coverage settings, set the exclusions for the selected rule here

Send Notification To Specific Notification Group

Select the notification method, please set the notification method in the "Notifications" page

WARNING

When the settings are completed, the notification takes effect when enabled is activated


WARNING

IP Change Alert does not show ip by default, if you don't want to hide it, you can activate "Do NOT desensitize Server IP In Notification Messages"

- diff --git a/en_US/guide/tasks.html b/en_US/guide/tasks.html index a9300db3..4417a344 100644 --- a/en_US/guide/tasks.html +++ b/en_US/guide/tasks.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

In the task area, you can set up scheduled tasks, Trigger tasks, and multi-server batch execution tasks

Nezha monitoring supports pushing commands to the Agent for execution, so this feature is very flexible and can be used to periodically back up the server in conjunction with restic, rclone. Periodically restart a service to reset the network connection. It can also be used with notifications to perform a task when a notification is triggered, such as running a script when the CPU is at high occupancy for a long period of time.

How to use

Go to the "Tasks" page of the admin panel and click "Add Scheduled Task"
To add a scheduled task you need to make the following settings:

  • Name - Customize a task name

  • Task Type - select the type of task
    Scheduled Tasks - Tasks are executed periodically at the scheduled time set below
    Trigger Tasks - Tasks that are triggered only by API or notification rules and are executed once per trigger

  • Cron Expression - (Not valid when using the trigger task type) Set schedule time, the Cron Expression is like:: * * * * * * sec min hour day month week, see details in CRON Expression Format
    For example: 0 0 3 * * * is Every day at 3 o'clock

  • Command - Just like writing shell/bat scripts, but line wrap is not recommended, Multiple Commands should be connected with &&/&
    For example, to execute a periodic reboot command, you can type reboot here

  • Coverage and Specific Servers - Similar to the settings on the Services page, select rules to determine which Agents need to execute scheduled tasks
    When using the trigger task type, you can select Only servers that are included in the notification rule

  • Notification Group - Select the notification method you have set up on the "Notification" page. Click here for more information

  • Send Success Notification - When this item is activated, a message notification will be triggered when the task is successfully executed

Manage tasks

To manage existing scheduled tasks, you can go to the "Tasks" page in the administration panel
Select a task configuration and the three icons on the right, which are:

  • Execute Now - When clicked, the scheduled time will be ignored and the task will be executed immediately
  • Edit - Click to modify the task configuration
  • Delete - Delete this scheduled task

FAQ

  1. Command not found
    Command not found may cause by missing PATH environment variable, for Linux Server, you may try adding source ~/.bashrc at beginning of your command or execute by absolute path.
- diff --git a/en_US/index.html b/en_US/index.html index fd8c7ace..012ee1ab 100644 --- a/en_US/index.html +++ b/en_US/index.html @@ -10,13 +10,13 @@ - +
Skip to content

Nezha Monitoring

A open source, lightweight server and website monitoring and O&M tool

One-Click Installation

Support one-click script installation Dashboard and Agent services for easy use; mainstream systems such as Linux, Windows, MacOS, OpenWRT, etc. are all supported.

Real-time monitoring

Supports monitoring the system status of multiple servers simultaneously, including monitoring the status of web pages, ports, and SSL certificates. It also supports sending notifications when there are failures or when data reaches the limit. Multiple notification methods are supported, such as Telegram, email, and WeChat.

Easy O&M

Support WebSSH, support data monitoring, support setting scheduled tasks, and support batch execution of tasks on servers.

- diff --git a/guide/agent.html b/guide/agent.html index 650f22fd..4f1dfafb 100644 --- a/guide/agent.html +++ b/guide/agent.html @@ -10,7 +10,7 @@ - + @@ -152,8 +152,8 @@ stop sleep 2 start -}

FAQ

Agent 有 Docker 镜像吗?

Agent 目前没有推出 Docker 镜像。
Agent 的设计思路和 Dashboard 相反,Dashboard 要尽可能不影响宿主机工作,但 Agent 则需要在宿主机中执行监控服务和运行命令。
将 Agent 放入容器中确实可以继续执行监控任务,但 WebShell 等功能无法正常运行,因此不提供 Docker 镜像。

- diff --git a/guide/agentq.html b/guide/agentq.html index ba1bdc40..da4303c8 100644 --- a/guide/agentq.html +++ b/guide/agentq.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

后台显示的 IP 和 Agent 实际 IP 不一致?

请查看 Dashboard 相关-为什么管理面板中显示的 IP 和 Agent 实际 IP 不一致?
在此不再赘述。

一键脚本安装时出错

curl: Failed to connect to raw.githubusercontent.com......

多出现在国内主机中,目前一键脚本只从 Github 直接获取安装脚本,您可以多尝试几次,或者手动安装 Agent,别忘了使用镜像。

sudo: command not found

请先手动安装 sudo。

- diff --git a/guide/api.html b/guide/api.html index 33c66ffc..3e0ebcbd 100644 --- a/guide/api.html +++ b/guide/api.html @@ -10,7 +10,7 @@ - + @@ -124,8 +124,8 @@ } } ] -} - diff --git a/guide/dashboard.html b/guide/dashboard.html index 4ff84049..8097b668 100644 --- a/guide/dashboard.html +++ b/guide/dashboard.html @@ -10,7 +10,7 @@ - + @@ -35,8 +35,8 @@ proxy /terminal/* http://ip:8008 { websocket header_upstream -Origin -}

在宝塔面板中配置 SSL

首先,先暂时关闭反向代理
正如在其他网站中配置 SSL 证书一样,进入站点设置中的 “SSL”,你可以选择自动申请 Let´s Encrypt 证书或手动配置已有的证书
完成 SSL 的设置后,你需要回到 https://github.com/settings/developers ,编辑之前创建的验证应用程序,将之前我们填入的 "Homepage URL" 和 "Authorization callback URL" 中的域名全部从http改为https,如:"https://cdn.example.com" 和 "https://cdn.example.com/oauth2/callback" ,不更改此项可能会导致你无法登录面板后台

FAQ

启用HTTPS后/terminal或/ws不能正常连接怎么办?

常常是由于证书不完整造成的,请在agent运行参数中添加-d,若log中有x509:certificate signed by unknown authority,更换完整证书则可100%解决该问题。

我对面板提供的数据修改/增加功能不满意,我想要自己修改/增加数据怎么办?

常见于批量插入 Agent 等需求中,可以直接修改数据库。
请注意,数据库中并非什么都可以修改,错误的修改会导致数据混乱无法启动 Dashboard,请勿随意修改数据库!

DANGER

再重复一遍,请勿随意修改数据库!

如需要在数据库中修改数据,请先停止面板容器再修改。
数据库类型是 sqlite3,位于 /opt/nezha/dashboard/data/sqlite.db,修改前请备份

数据库中各表/列是什么意思?

文档不提供数据库解释,有能力修改数据库的稍加分析应该就足以看懂。

Dashboard 会自动更新吗?

Agent通常情况下会自动更新,但Dashboard并不会,需要手动更新。

如何更新 Dashboard?

运行脚本 ./nezha.sh ,选择重启面板并更新

- diff --git a/guide/dashboardq.html b/guide/dashboardq.html index 4289be13..5be5a3ee 100644 --- a/guide/dashboardq.html +++ b/guide/dashboardq.html @@ -10,7 +10,7 @@ - + @@ -24,8 +24,8 @@ expires 12h; error_log /dev/null; access_log /dev/null; - }
  1. 保存配置,并清空浏览器、NginX、CDN 中的缓存,此时刷新页面应恢复正常
- diff --git a/guide/loginq.html b/guide/loginq.html index 911b6111..1ab2c5e8 100644 --- a/guide/loginq.html +++ b/guide/loginq.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

登录回调后页面卡住\拒绝连接\响应时间过长

还有其他一些表现形式,总之登录后浏览器无法正常显示。

  1. 您的服务器无法连接到 Github/Gitee,最常见于国内服务器配置 Github 情况下,可以考虑多尝试几次或者切换到 Jihulab/Gitee。
  2. 您配置错了回调地址,确保您的回调地址正确且端口与协议均正确!
  3. Dashboard 发生未知错误,您可以使用脚本查看日志,但此项可能性较低。

TIP

什么是协议?
在浏览器中,您的域名以://结尾的字符串即为协议,通常为 httphttps 两种。由于正常部署情况下面板可能有多种协议+域名+端口组合均可访问,请务必选一个最合适的作为回调。

如何检查我的回调地址是否错误?

请确保登录前浏览器显示的协议+域名+端口和登录后跳转到的协议+域名+端口一致。
请确保您的路径为/oauth2/callback全部小写

登录后面板报错

  1. 清理cookies后重新登录,或换个浏览器
  2. 检查回调地址,确保您的回调地址正确且端口与协议均正确!发起请求的地址需要和回调地址处于同域,端口、协议和域名(或IP)都需要一致。

lookup xxx

容器DNS解析失败,多数情况下为修改了iptables相关配置。
建议先重启docker,sudo systemctl restart docker,再使用脚本重启面板。
仍然出现lookup错误建议查看是否有其他控制iptables的工具,如宝塔防火墙等。
这个问题也可能与内核有关系,请尝试更换官方内核。

授权方式无效,或者登录回调地址无效、过期或已被撤销

只出现在 Gitee 登录方式中,原因不明,建议更换到 Jihulab。

oauth2: server response missing access_token

可能由多种因素引起,最大可能性是网络问题,建议检查网络后重试。
无法解决的话建议更换 Github/Jihulab 等。

该用户不是本站点管理员,无法登录

您登陆错了账号或者配置错了用户名,注意用户名不是邮箱,可使用脚本修改。

dial tcp xxx:443 i/o timeout

网络问题,可先重启 Docker,sudo systemctl restart docker,再使用脚本重启面板。
如为国内服务器配置 Github 登陆方式,则建议切换到Jihulab以避免网络干扰。

net/http: TLS handshake timeout

同上。

- diff --git a/guide/notifications.html b/guide/notifications.html index 43ca8a7e..6786b56a 100644 --- a/guide/notifications.html +++ b/guide/notifications.html @@ -10,7 +10,7 @@ - + @@ -45,8 +45,8 @@ "markdown": { "content": "# 哪吒通知消息\n\n\"#NEZHA#\"\n\n> 名称: \"#SERVER.NAME#\"\n> IP: \"#SERVER.IP#\"\n> IPv4: \"#SERVER.IPV4#\"\n> IPv6: \"#SERVER.IPV6#\"\n> CPU: \"#SERVER.CPU#\"\n> 内存: \"#SERVER.MEM#\"\n> 交换分区: \"#SERVER.SWAP#\"\n> 存储: \"#SERVER.DISK#\"\n> 实时上传速度: \"#SERVER.NETINSPEED#\"\n> 实时下载速度: \"#SERVER.NETOUTSPEED#\"\n> 总上传: \"#SERVER.TRANSFERIN#\"\n> 总下载: \"#SERVER.TRANSFEROUT#\"\n> 1分钟内负载: \"#SERVER.LOAD1#\"\n> 5分钟内负载: \"#SERVER.LOAD5#\"\n> 15分钟内负载: \"#SERVER.LOAD15#\"\n> TCP连接数: \"#SERVER.TCPCONNCOUNT\"\n> UDP连接数: \"#SERVER.UDPCONNCOUNT\"\n\n" } -}

根据需求删减相关内容信息即可

通知效果



报警规则说明

基本规则

完整示例:

添加一个离线报警

添加一个监控 CPU 持续 10s 超过 50% 内存持续 20s 占用低于 20% 的报警

将特定的服务器通知发送到特定的通知分组

示例场景:
你有 1、2、3、4 四台服务器和 A、B 两个不同的通知组
1、2 这两台服务器掉线十分钟后给通知组 A 发送通知
3、4 这两台服务器掉线十分钟后给通知组 B 发送通知

首先你需要先设置好 A、B 两个通知组,然后添加两条报警规则:

规则一:

规则二:

灵活使用参数可以让你的通知功能被充分使用


特殊:任意周期流量报警

可以用作月流量报警

示例:

ID 为 3 和 4 的服务器(ignore 里面定义),以每月 1 号为统计周期,周期内统计的出站月流量达到 1TB 时报警

[{"type":"transfer_out_cycle","max":1099511627776,"cycle_start":"2022-01-01T00:00:00+08:00","cycle_interval":1,"cycle_unit":"month","cover":1,"ignore":{"3":true,"4":true}}]

通知触发模式说明

设置报警时执行任务

如果你需要在发出报警消息的同时执行某项任务,可以设置此项目

- diff --git a/guide/q1.html b/guide/q1.html index 799332b9..dbb80c33 100644 --- a/guide/q1.html +++ b/guide/q1.html @@ -10,7 +10,7 @@ - + @@ -59,8 +59,8 @@ ufw allow proto tcp from serverIp to any port 443 #centos iptables -I INPUT -p tcp --dport 443 -j DROP -iptables -I INPUT -s serverIp -p tcp --dport 443 -j ACCEPT - diff --git a/guide/q2.html b/guide/q2.html index 0a7c90bd..e80d8202 100644 --- a/guide/q2.html +++ b/guide/q2.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

Agent 启动/上线 问题自检流程

  1. 直接执行 /opt/nezha/agent/nezha-agent -s 面板IP或非CDN域名:面板RPC端口 -p Agent密钥 -d 查看日志是否是因为 DNS、网络不佳导致超时(timeout)
  2. nc -v 域名/IP 面板RPC端口 或者 telnet 域名/IP 面板RPC端口 来检验是否是网络问题,检查本机与面板服务器的出入站防火墙,如果无法判断问题可借助 https://port.ping.pe/ 提供的端口检查工具进行检测。
  3. 如果上面步骤检测正常,Agent 正常上线,尝试关闭 SELinux,如何关闭 SELinux?
- diff --git a/guide/q3.html b/guide/q3.html index 0becdefc..7a669323 100644 --- a/guide/q3.html +++ b/guide/q3.html @@ -10,7 +10,7 @@ - + @@ -51,8 +51,8 @@ versions h2c 2 } } -}

Dashboard 面板端配置

Agent 端配置

开启 Cloudflare CDN(可选)

根据 Cloudflare gRPC 的要求:gRPC 服务必须侦听 443 端口 且必须支持 TLS 和 HTTP/2。 所以如果需要开启 CDN,必须在配置 Nginx 或者 Caddy 反向代理 gRPC 时使用 443 端口,并配置证书(Caddy 会自动申请并配置证书)。

- diff --git a/guide/q4.html b/guide/q4.html index 9be0d12b..876bd4dc 100644 --- a/guide/q4.html +++ b/guide/q4.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

实时通道断开/在线终端连接失败

  • 如果你使用了 CDN,请确认 CDN 服务商提供 WebSocket 服务,并且已开启 WebSocket
  • 确认你的反代规则中针对 /ws,/terminal 路径的 WebSocket 进行了特别配置,你可以 点击这里 查看反向代理配置
- diff --git a/guide/q5.html b/guide/q5.html index 36776481..44e54372 100644 --- a/guide/q5.html +++ b/guide/q5.html @@ -10,13 +10,13 @@ - + -
- diff --git a/guide/q6.html b/guide/q6.html index 76700e50..90851bbf 100644 --- a/guide/q6.html +++ b/guide/q6.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

如何每月重置流量统计?

主页中的流量统计每次服务器重启时都会重置,如果要实现每月重置一次流量计数,可以这样实现:

  1. 进入管理面板的 报警通知
  2. 参考这篇文档,创建一个月流量报警
  3. 返回主页,在 服务 页中就可以看到月流量统计了,这里的统计数据不会因为服务器重启而重置

TIP

此方式可以设置任何周期,包括且不限于每小时/每天/每周/每月/每年重置流量统计,非常灵活!

- diff --git a/guide/q7.html b/guide/q7.html index bd3dede8..4d778341 100644 --- a/guide/q7.html +++ b/guide/q7.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

自定义 Agent 监控项目

自定义监控的网卡和硬盘分区

  • 执行 /opt/nezha/agent/nezha-agent --edit-agent-config 来选择自定义的网卡和分区,然后重启 Agent 即可生效

其他运行参数

通过执行 ./nezha-agent --help 查看支持的参数,如果你使用了一键脚本安装Agent,可以编辑 /etc/systemd/system/nezha-agent.service,在 ExecStart= 这一行的末尾加上以下参数

  • --report-delay 控制系统信息上报的间隔,默认为 1 秒,可以设置为 3 来进一步降低 agent 端系统资源占用(配置区间 1-4)
  • --skip-conn 不监控连接数,推荐 机场/连接密集型 服务器或CPU占用较高的服务器设置
  • --skip-procs 不监控进程数,也可以降低 Agent 占用
  • --disable-auto-update 禁止 自动更新 Agent(安全特性)
  • --disable-force-update 禁止 强制更新 Agent(安全特性)
  • --disable-command-execute 禁止在 Agent 上执行定时任务、打开在线终端(安全特性)
  • --tls 启用 SSL/TLS 加密(使用 nginx 反向代理 Agent 的 grpc 连接,并且 nginx 开启 SSL/TLS 时,需要启用该项配置)
- diff --git a/guide/servers.html b/guide/servers.html index e67c9539..e8865307 100644 --- a/guide/servers.html +++ b/guide/servers.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

主机

介绍

主机区域负责管理Agent,是哪吒探针中最基础的区域,也是其他功能的基础。

添加服务器

第一步是添加主机,可以自定义名称、分组、排序和备注。
拥有相同分组的主机会在受支持的主题中划分到一起进行显示,备注仅会在后台显示,无需担心泄露信息。

安装Agent

请参考前文安装Agent
推荐使用一键安装,即配置好参数后,点击主机一键安装列上的按钮,复制到相应主机进行安装。

强制更新

Agent更新相关的参数是 自定义agent监控项目 中的 --disable-auto-update--disable-force-update
默认情况下,Agent会自动更新,无需干预。但当用户关闭自动更新后,也可以选中指定主机进行强制更新。
disable-force-update开启时此功能不生效。

数据列

  • 版本号: 记录Agent当前版本
  • 密钥: 即secret\key,配置Agent时会用到
  • 一键安装: 较为便捷的Agent安装方式
  • 管理: 左为WebShell,中为编辑,右为删除

在线终端

即WebShell,disable-command-execute 开启时此功能不生效。
Linux和Windows均可用,可使用Ctrl+Shift+V粘贴。
连接失败请参考实时通道断开/在线终端连接失败
注意在线终端功能中,Agent也是通过WebSocket连接到公开访问域名,而非通过grpc交互。

- diff --git a/guide/services.html b/guide/services.html index 64a32008..b0281de0 100644 --- a/guide/services.html +++ b/guide/services.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

服务区域是设置 Agent 监控外部网站或服务器的功能设置区
设置好的服务监控可以在主页中的 “服务” 页查看监控结果

使用方法

如需新增一个监控,可以进入管理面板中的 “服务” 页,点击“添加监控”

新增一个服务监控,你需要设置以下参数:

  • 名称 - 自定义一个名称

  • 类型 - 选择一个监控类型,目前哪吒监控支持三种监控类型,分别是 “HTTP-GET”、“ICMP-Ping” 和 “TCP-Ping”

  • 目标 - 根据你选择的类型不同,目标的设置方法也不同

  • HTTP-GET: 选择此类型,你应该输入一个URL作为目标,URL需添加 http://https:// 如果你的目标URL是 https:// ,将会同时监控该URL的SSL证书,当SSL证书到期或发生变更,会触发提醒
    例如: https://example.com
  • ICMP-Ping: 选择此类型时,你应该输入一个域名或IP,不含端口号
    例如:1.1.1.1 或 example.com
  • TCP-Ping: 选择此类型时,你应该输入一个域名或IP并包含端口号
    例如:1.1.1.1:80 或 example.com:22
  • 请求间隔: 设定 Agent 每次请求目标的时间间隔,以秒为单位

  • 覆盖范围: 选择一条规则来确定要使用哪些 Agent 来请求目标

  • 特定服务器: 配合覆盖范围使用,选择规则内需要排除的 Agent

  • 通知方式组: 选择你已经在 “报警” 页设置好的通知方式,点击这里了解详情

  • 启用故障通知: 根据需要选择是否接收目标故障通知,默认为不勾选

设置完成后,点击 “添加” 即可
稍等片刻前往主页的 “服务” 页,查看监控结果

延迟变化报警

哪吒监控可以监测并统计 Agent 到目标服务器之间的延迟,在发生较大变化的情况下发送通知
利用此功能可以帮助你监控服务器的线路是否发生了变化

  • 启用延迟通知: 开启时,当 Agent 至目标服务器的延迟大于最高延迟或小于最低延迟时,将会发送报警通知

管理监控

如需对已有的服务监控进行管理,可以前往管理面板中的 “服务” 页
选择一条监控配置,点击右侧的图标进行编辑或删除

- diff --git a/guide/settings.html b/guide/settings.html index 582f4da9..fad37724 100644 --- a/guide/settings.html +++ b/guide/settings.html @@ -10,7 +10,7 @@ - + @@ -58,8 +58,8 @@ .hotaru-cover { background: url(https://s3.ax1x.com/2020/12/08/DzHv6A.jpg) center; } -</style>

前台查看密码

如果你不想直接展示你的主页,你可以在这里设置一个查看密码
设置密码后,需要输入密码才可以访问主页

未接入 CDN 的面板服务器域名/IP

此项设置是使用一键脚本安装 Agent 的前提,详情请查看这里

IP 变更提醒

如果你希望当某个服务器的ip发生变更时收到通知,可以在这里进行设置

覆盖范围

在这里选择一条规则,来确定需要监控哪些服务器,可以根据自己的需求进行选择

特定服务器

配合覆盖范围的设置,在这里设置选定规则的排除项

提醒发送至指定的通知分组

选择通知方式,通知方式请提前在 “报警” 页内设置

WARNING

设置完成后,勾选启用时,通知生效


WARNING

IP变更通知默认打码,如果你不希望打码,可以勾选 “通知信息IP不打码”

- diff --git a/guide/tasks.html b/guide/tasks.html index 0b1a528b..80f3cdd6 100644 --- a/guide/tasks.html +++ b/guide/tasks.html @@ -10,13 +10,13 @@ - + -
Skip to content
On this page

在任务区域中,可以设置计划任务,触发任务,多服务器批量执行任务

哪吒监控支持推送命令到 Agent 执行,因此此功能非常灵活,使用此功能可以定期结合 restic、rclone 给服务器备份,定期重启某项服务来重置网络连接。也可以配合报警通知,在触发报警时执行某项任务,如 CPU 在长时期处于高占用的情况下运行某个脚本。

使用方法

进入管理面板的 “任务” 页,点击 “添加计划任务”
添加计划任务你需要填入以下参数:

  • 名称 - 自定义一个任务名称

  • 任务类型 - 选择任务的类型
    计划任务 - 按下方设置的计划时间,周期性执行任务
    触发任务 - 仅被 API 或报警规则触发的任务,每次触发执行一次

  • 计划 - (使用触发任务类型时不生效)设置计划时间,时间的格式为: * * * * * * 分别对应 秒 分 时 天 月 星期,详情见计划表达式格式
    如:0 0 3 * * * 对应为 每天3点

  • 命令 - 你可以在这里设置需要执行的命令,就像写 Shell/Bat 脚本一样,但是不推荐换行,多个命令使用 &&/& 连接
    例如执行定期重启命令,可以在这里输入 reboot

  • 覆盖范围特定服务器 - 跟“服务”页中的设置类似,选择规则来确定哪些 Agent 执行计划任务
    使用触发任务类型时,可选择由触发的服务器执行

  • 通知方式组 - 选择你已经在 “报警” 页设置好的通知方式,点击这里了解详情

  • 推送成功的消息 - 勾选此项,任务执行成功后会触发消息通知

管理任务

如需对已有的计划任务进行管理,可以前往管理面板中的 “任务” 页
选择一条任务配置,右侧的三个图标,分别是:

  • 立即执行 - 点击后将忽略计划时间,立刻执行任务
  • 编辑 - 点击可以修改任务配置
  • 删除 - 删除这条计划任务

常见问题

  1. xxx 命令找不到
    如果运行失败,提示 xxx 命令找不到,可能是 PATH 环境变量的问题,Linux 服务器在命令开头加入 source ~/.bashrc 或者使用绝对路径执行
- diff --git a/hashmap.json b/hashmap.json index 0fd47fb4..35a4d2e5 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"developer_theme.md":"5883687e","en_us_case_case1.md":"9a8ad188","en_us_case_case2.md":"77f26080","en_us_case_case3.md":"c8bf14c8","en_us_case_case4.md":"87565e31","en_us_case_case5.md":"635f3c8f","en_us_developer_index.md":"494894a7","en_us_developer_l10n.md":"f30e1696","en_us_case_index.md":"51e3fcf1","case_case2.md":"98fa8429","en_us_developer_theme.md":"fec1d800","case_case3.md":"8673f8b5","case_case4.md":"69b133d8","case_case5.md":"93900c94","case_index.md":"0419435e","developer_index.md":"fb38673e","developer_l10n.md":"e16b7f23","case_case1.md":"10924026","en_us_guide_dashboard.md":"d3da906a","en_us_guide_dashboardq.md":"60106923","en_us_guide_loginq.md":"6e1954e3","en_us_guide_api.md":"5bfd89f2","guide_q7.md":"6e5b4509","guide_servers.md":"bf593d54","guide_services.md":"bc514a7e","guide_settings.md":"47429b8c","guide_tasks.md":"00d2bf18","index.md":"3437873f","en_us_guide_agent.md":"27bff8f7","en_us_guide_agentq.md":"eb2f5013","guide_agent.md":"1cf2f21a","en_us_guide_notifications.md":"88d86f03","en_us_guide_q2.md":"d795499d","en_us_guide_q3.md":"0d779386","en_us_guide_q4.md":"847c7d75","en_us_guide_q5.md":"7df8c8cd","en_us_guide_q6.md":"fe3100ad","en_us_guide_q7.md":"5d20e21a","en_us_guide_servers.md":"a92b7c67","en_us_guide_services.md":"c882e01a","en_us_guide_settings.md":"7d38802c","en_us_guide_tasks.md":"e1820240","en_us_index.md":"56b31086","guide_q1.md":"ba9dbf6b","guide_api.md":"b4d4c043","guide_agentq.md":"4b93c69b","guide_dashboard.md":"b839f029","guide_dashboardq.md":"5a078e44","guide_loginq.md":"c4973bfb","guide_notifications.md":"e73d0084","guide_q2.md":"abd5be0b","guide_q3.md":"ab30d47b","guide_q5.md":"94b09336","guide_q4.md":"74ddc32e","guide_q6.md":"242c74d0"} +{"case_case1.md":"6f827984","case_case4.md":"3d19dff7","case_case2.md":"0f994f85","guide_agentq.md":"e4748933","developer_theme.md":"8c7acb53","guide_q4.md":"1e055927","guide_servers.md":"5c3323d1","guide_api.md":"10955d00","en_us_case_case4.md":"b3a4b972","en_us_case_case3.md":"a5875c00","en_us_case_index.md":"464e1cf1","en_us_developer_l10n.md":"88ba36b5","en_us_case_case5.md":"3404425e","en_us_developer_index.md":"5e431eca","en_us_guide_q5.md":"ab9624d6","en_us_guide_api.md":"7c016679","en_us_guide_q2.md":"ef5213fa","en_us_guide_servers.md":"19b9de10","en_us_guide_services.md":"88b6205c","en_us_guide_q4.md":"39c1f69c","en_us_index.md":"99e7e7d6","en_us_guide_notifications.md":"c66257b2","en_us_guide_tasks.md":"dfe9cb41","en_us_guide_q3.md":"9878dfb9","guide_q1.md":"97e2cb27","guide_agent.md":"85008d4e","case_index.md":"e7243c50","index.md":"7decbfa6","developer_index.md":"0a6fbe67","en_us_case_case2.md":"c9576b87","developer_l10n.md":"06ab96bd","en_us_case_case1.md":"628438cc","en_us_guide_agentq.md":"f3d60b04","en_us_guide_q6.md":"d8f23d35","en_us_guide_dashboardq.md":"ac655fb7","en_us_developer_theme.md":"ab8eaaf4","en_us_guide_agent.md":"6683a40f","guide_loginq.md":"dd090780","en_us_guide_loginq.md":"2cd38989","en_us_guide_q7.md":"1a0316cc","en_us_guide_dashboard.md":"7413067e","guide_q3.md":"ac1531fd","guide_q5.md":"1499e8bb","guide_q6.md":"5919ae50","en_us_guide_settings.md":"1abc055b","case_case3.md":"2815791d","guide_services.md":"e571bf06","guide_q7.md":"110e0752","case_case5.md":"895ea2d3","guide_settings.md":"eddaca0c","guide_q2.md":"27a2f8de","guide_tasks.md":"aae399a8","guide_dashboard.md":"cf138dd1","guide_dashboardq.md":"9e79f90f","guide_notifications.md":"f36c695a"} diff --git a/index.html b/index.html index 6a887b6b..72363ce0 100644 --- a/index.html +++ b/index.html @@ -10,13 +10,13 @@ - +
Skip to content

哪吒监控

开源、轻量、易用的服务器监控、运维工具

一键安装

支持一键脚本安装面板和监控服务,轻松使用;Linux、Windows、MacOS、OpenWRT等主流系统均受支持

实时监控

支持同时监控多个服务器的系统状态,支持监控网页、端口、SSL证书状态;支持故障、流量等状态报警,支持多种通知方式(Telegram、邮件、微信等)

轻松运维

支持WebSSH,支持流量循环监控,支持设置定时任务、服务器批量执行任务

-