Run the official installer as root
Use the published install script from the NyxGate GitHub repository. The installer validates the environment, installs Docker if required, prepares storage, and launches the NyxGate services.
Deployment
Install NyxGate from the official project workflow.
The install page follows the official NyxGate repository workflow: deploy the Docker-based controller, preserve data under /opt/nyxgate/data, open the panel on port 8443, and continue onboarding hosts from the platform itself.
Setup Flow
Deploy NyxGate using the same workflow published in the official repository.
NyxGate is delivered as a Docker-based deployment with persistent data under /opt/nyxgate/data. The commands below follow the official GitHub workflow so teams can install, access, and upgrade the platform consistently.
Access the controller on port 8443
After deployment, open the NyxGate panel at https://<server-ip>:8443 and complete the secure first-run setup from the product itself.
Preserve persistent platform data
NyxGate stores users, recovery data, rules, audit history, patch state, and related platform data under /opt/nyxgate/data so upgrades and rebuilds preserve the platform state.
Upgrade with the published upgrade script
Use the published upgrade command to check Docker Hub for a newer NyxGate release, fetch the matching official release bundle, and upgrade while keeping the persistent data path in place.
Official Commands
Use the official commands from the NyxGate repository.
These are the public install and upgrade commands published for NyxGate. They provide the right starting point for a clean deployment and maintenance workflow.
Install NyxGate
curl -sSL https://raw.githubusercontent.com/NyxCloudRO/NyxGate/main/install/install.sh | bash
Run as root on a supported Linux host. The script installs Docker when needed, prepares /opt/nyxgate/data, and starts the published NyxGate deployment flow.
Upgrade NyxGate
curl -sSL https://raw.githubusercontent.com/NyxCloudRO/NyxGate/main/install/upgrade.sh | bash
Run as root to check for a newer published release automatically and apply it only when one is available, while preserving the persistent data directory.
Requirements & Validation
The key platform expectations before you roll it out.
The install workflow is straightforward, but the page should still explain what NyxGate expects from the host and what happens after the panel comes online.
R
Supported deployment baseline
The published install flow is designed around Linux systems with Docker available or installable by the script.
- Ubuntu and Debian install support
- Docker-based runtime model
- HTTPS service exposed on port 8443
M
Minimum practical requirements
The official repository guidance keeps the baseline requirements straightforward for an initial deployment.
- 2 CPU minimum
- 4 GB RAM recommended
- Persistent data stored under /opt/nyxgate/data
N
What happens after the controller is live
Once the panel is available, teams move into secure setup, enrollment generation, and day-to-day platform operations from the web console.
- Complete first-run bootstrap
- Generate enrollment and install commands
- Begin fleet visibility and response workflows
Next Step
After installation, move directly into documentation, architecture, and FAQ.
Use documentation for first-day operator guidance, architecture for deployment awareness, and FAQ for common deployment and product-fit questions.