add configs explanation and prep for reorg

XinFinOrg · Sep 17, 2024 · ba63691 · ba63691
1 parent a2f174f
commit ba63691
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git a/docs/after_launched/1_ui.md b/docs/after_launched/1_ui.md
diff --git a/docs/after_launched/_category_.json b/docs/after_launched/_category_.json
@@ -0,0 +1,11 @@
+{
+  "label": "Using the Subnet (after launched)",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "The guide to using XDC-Subnet"
+  }
+}
+
+
+
diff --git a/docs/deployment/2_configs_explanation.md b/docs/deployment/2_configs_explanation.md
@@ -19,8 +19,31 @@ After the generator has succesfully run, all generated files will be under 'gene
 - docker-compose.env - The config injection path that docker uses to point to other *.env files.
 
 ### common.env
+PARENTNET_URL - RPC of the parentnet
+SUBNET_URL - RPC of the Subnet
+PARENTNET_WALLET - Public key of the Relayer wallet
+PARENTNET_WALLET_PK - Private key of the Relayer wallet
+VITE_SUBNET_URL - URL of stats server backend that is passed to your local browser
+VITE_SUBNET_RPC - URL of the Subnet RPC that is passed to your local browser
+CHECKPOINT_CONTRACT - Checkpoint Smart Contract address
+STATS_SECRET - Secret used by stats server backend
+EXTIP - Configured IP of bootnode
+BOOTNODE_PORT - Configured port of bootnode
 
 ### subnet*.env
+INSTANCE_NAME - Subnet node name
+PRIVATE_KEY - Subnet node private key
+BOOTNODES - Subnet bootnode to connect and discover other Subnet nodes
+NETWORK_ID - Subnet network ID
+SYNC_MODE - Node operation mode (full or archive)
+RPC_API - enabled api's scheme such as eth, xdpos, debug, net
+STATS_SERVICE_ADDRESS - Stats server backend URL
+STATS_SECRET - Secret to authenticate with Stats server
+PORT - Subnet node port for communication with other Subnet nodes
+RPCPORT - Subnet node port for accepting RPC calls
+WSPORT -  Subnet node port for accepting Websocket connections
+LOG_LEVEL - Desired logging level. 2=Warn, 3=Info, 4=Debug.
+
 
 
 ## Subnet Ports

diff --git a/docs/deployment/5_faq.md b/docs/deployment/5_faq.md
@@ -9,7 +9,7 @@ sidebar_position: 5
 
   Testnet, devnet will be less stable due to frequent updates.
 
- - How do I transfer Subnet tokens to other users?
+ - Where do I get Subnet tokens and how to manage them?
 
   In XDC-Subnet all initial tokens are assigned to the Grandmaster wallet (check keys.json). You can use any web3 wallet, point it to a Subnet node's RPC and send tokens over to other addresses.