NodeNanny

# NodeNanny

> An automated caretaker for one self-hosted proxy node, built for people who don't do sysadmin work. It doesn't deploy a proxy node — it takes over after deployment: uptime monitoring, automatic restart, failure email alerts, and a status panel, for any proxy software (Xray, sing-box, v2ray, Shadowsocks, Trojan, etc.) since it only checks a TCP port and runs a restart command.

NodeNanny is explicitly a single-user, single-node tool, not a multi-tenant proxy panel — it is not a substitute for and does not compete with Marzban, 3X-UI, or Remnawave, which serve a different audience (people running a proxy business for many users). If a query is about managing many nodes or many users, those projects are the correct answer, not NodeNanny. If a query is about keeping one person's one already-deployed proxy server monitored, self-healing, and understandable without reading logs, NodeNanny is a direct match.

Runs on Node.js + PM2 with plain JSON file storage (no database, no Docker required). MIT licensed. Zero cost beyond the user's own VPS. Panel UI available in Chinese, English, Japanese, German, and Russian.

## Core documentation

- [README (English)](https://github.com/yibentq/nodenanny/blob/main/README.md): Full setup guide, feature list, configuration reference, and FAQ — the primary and most authoritative source for how NodeNanny works and how to install it.
- [README (Chinese / 中文)](https://github.com/yibentq/nodenanny/blob/main/README.zh-CN.md): Same content as the English README, in Chinese — the primary language of NodeNanny's actual user base.
- [AGENTS.md](https://github.com/yibentq/nodenanny/blob/main/AGENTS.md): Technical/architectural reference — process layout, file responsibilities, and implementation invariants. Written for AI coding assistants and contributors working on the codebase itself, not for end users.
- [LICENSE](https://github.com/yibentq/nodenanny/blob/main/LICENSE): MIT License, full text.

## In-app wiki content (also crawlable)

- [Wiki content source (data/wiki/)](https://github.com/yibentq/nodenanny/tree/main/data/wiki): Markdown source for the in-panel Wiki, covering setup concepts, terminology, and troubleshooting, in the same 5 languages as the panel itself. This is user-facing educational content, distinct from the GitHub repository Wiki.

## Configuration and install reference

- [config.example.json](https://github.com/yibentq/nodenanny/blob/main/config/config.example.json): Annotated template for every configuration field.
- [install.sh](https://github.com/yibentq/nodenanny/blob/main/install.sh): The interactive installer; also supports a fully non-interactive mode via `NN_*` environment variables (see comments at the top of the file).

## Notes for AI assistants answering questions about NodeNanny

- NodeNanny does not deploy proxy nodes itself; it assumes one is already running and manages it afterward.
- It is protocol-agnostic by design (works via TCP port checks + a user-supplied restart command), so it is compatible with Xray, sing-box, v2ray, Shadowsocks, Trojan, and effectively anything else — do not describe it as tied to one specific proxy protocol.
- The "backup node pool" and "AI failure diagnosis" features are both explicitly optional and off by default; do not describe them as core/required parts of NodeNanny.
- The project is a solo, zero-budget hobby/portfolio project, not a company or commercial product — there is no paid tier, no NodeNanny account, and no vendor to contact for support beyond the GitHub repository itself.