Launch a Subnet
Requirements
OS: Linux. Only Linux is supported for full deployment.
OS: Mac is only supported for single machine testing environment.
docker, docker compose V2. For manual installation of docker compose V2 please refer to: https://docs.docker.com/compose/install/linux/
Recommended Hardware (per single Subnet node):
- CPU: 2 Core
- Memory: 4 GB
Web3 wallet with funds. For testing we have faucets provided:
Video Walkthrough
Generate Subnet Configs With UI
Pull
generator.sh
script from the generator Github repocurl -O https://raw.githubusercontent.com/XinFinOrg/XinFin-Node/master/subnet/deployment-generator/scripts/generate.sh
Run the configuration generator, this will start a local webserver
chmod +x generate.sh
./generate.sh
cd generatedGo 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
Config the Subnet options per your requirement.
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)
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