Skip to content

Setup & Activation ​

Hardware & OS Requirements ​

Depending on the volume of network assets and concurrent scanning tasks, we recommend the following sizing configurations:

RoleMinimum (Small Teams)Recommended (Production / 10k+ Assets)Large Clusters (Large Enterprise)
Server Master Node (server + web + db + redis)2 Core CPU / 4 GB RAM
50 GB SSD storage
4 Core CPU / 8 GB RAM
100 GB SSD storage
8 Core+ CPU / 16 GB+ RAM
500 GB+ NVMe SSD storage
Scanning Probe Node (client container / process)1 Core CPU / 2 GB RAM
20 GB free disk
2 Core CPU / 4 GB RAM
50 GB free disk
Horizontally scaled across multiple dedicated hosts

2. Software Dependencies ​

  • Operating System: Supported Linux distributions (Ubuntu 22.04 LTS, CentOS / Rocky Linux 8+, Debian 11+ recommended).
  • Docker Environment: Requires Docker 20.10+ and Docker Compose v2.0+.
  • Docker Image & Mirror Optimization:
    • Registry Mirrors: Security tools (e.g., Subfinder, Naabu, Nuclei) run as Docker containers. In restricted network environments, pull speed can be improved by configuring Docker Daemon registry mirrors in /etc/docker/daemon.json:
      json
      {
        "registry-mirrors": [
          "https://your-docker-mirror.example.com"
        ]
      }
      Apply with sudo systemctl daemon-reload && sudo systemctl restart docker.

Server One-Click Installation (Docker Compose) ​

Run the following command on your target server to automatically detect the fastest mirror source, download deployment scripts, and execute installation:

bash
curl -fsSL https://cnb.cool/testnet0/testnet-public/-/git/raw/main/install.sh | bash

The installation script automatically generates random passwords, creates self-signed certificates, pulls images, and starts services. When it finishes, the terminal prints the access URL (https://<server-ip>:3100) and the random initial admin password.

First Sign-in & Activation

  • First sign-in: log in with the credentials printed by the installer and change the password right away under "Profile Settings" — see Quick Start for the full walkthrough;
  • Activation: in production, upload the license file under "System Administration → License Management" to activate the system — see License Management.

Essential Server Operations

All commands below must be run from the testnet-deploy directory:

  • Start / Stop / Restart stack: ./testnet.sh start / ./testnet.sh stop / ./testnet.sh restart
  • View real-time logs: ./testnet.sh logs or docker compose logs -f testnet-server
  • Check service status: ./testnet.sh status
  • Reset admin password: ./testnet.sh reset-password (resets it to the default Admin@123456; change it in your profile right after signing in)
  • Upgrade to latest version: ./testnet.sh update

Distributed Node Deployment ​

A built-in client starts on the server host by default. To run scanning tasks across multiple servers, connect standalone client nodes to the main server. Both Docker and binary deployment methods are supported (each with systemd service registration, online verification, and upgrade guides).

TIP

See the dedicated guide Standalone Node Setup for full steps.


最近更新

Released under the MIT License