Skip to content

Launch a Subnet

Requirements

Video Walkthrough

Generate Subnet Configs With UI

  1. Pull generator.sh script from the generator Github repo

    curl -O https://raw.githubusercontent.com/XinFinOrg/XinFin-Node/master/subnet/deployment-generator/scripts/generate.sh
    
  2. Run the configuration generator, this will start a local webserver

    chmod +x generate.sh
    ./generate.sh
    cd generated
    
  3. Go to http://localhost:5210/ in your browser.

    If you are running this on a remote server.

    first use ssh tunnel: ssh -N -L localhost:5210:localhost:5210 USERNAME@IP_ADDRESS -i SERVER_KEY_FILE **if you're using VSCode to SSH, the port might be forwarded to your machine automatically (no need for above step)

  4. Config the Subnet options per your requirement. UI

  5. follow the generated instructions in commands.txt. In general, the steps are:

    • start Subnet Nodes
    • deploy CSC
    • deploy XDC-Zero (optional)
    • start Subnet Services (relayer, stats-server, frontend)
  6. Once successfully deployed, you can check out UI usage guide

Removing Subnet

Shutdown Subnet

Under generated directory

docker compose --env-file docker-compose.env --profile services down 
docker compose --env-file docker-compose.env --profile machine1 down

Deleting Subnet

Remove xdcchain*, bootnodes, and stats-service directories Warning: this cannot be undone

rm -rf xdcchain* bootnodes stats-service