Documentation Overview
This is the practical index for the current repository. All pages map to real files and features available in `panel/` and `connector-go/`.
Current implemented stack
- Node.js panel (`panel/`) with EJS pages and websocket runtime.
- Go connector (`connector-go/`) for Docker, files, SFTP, console stream and schedule actions.
- Pterodactyl migration flow in admin: `/admin/migrations/pterodactyl`.
- Client API key routes under `/api/client/servers/:containerId/*`.
- Dedicated removal guide with cleanup steps and data-safety warnings.
Supported setup platforms
- Debian 12 and Debian 13 (Trixie)
- Ubuntu 18+ and latest Ubuntu release
- Fedora current stable
- Windows 10/11 via WSL2 (Ubuntu)
- Arch Linux (hardcoder path)
Recommended order
- Install by distro docs (Ubuntu/Debian/Fedora) or follow WSL Config for Windows.
- Setup Docker runtime (or Docker Desktop + WSL integration on Windows).
- Build and run Panel + Connector-Go.
- Configure PM2 for persistent services.
- Add Cloudflare Tunnel only if you need public access without direct port exposure.
- Use Nginx/Apache2 only for advanced deployments.
- Run migration and API integration after base services are stable.
Rule of thumb: start local, validate start/console/files, then move to proxy and production hardening.
