Skip to content

Commit d16e420

Browse files
authored
fix(doc): add trond docker test guidance (#42)
1 parent d7c7f87 commit d16e420

File tree

6 files changed

+16
-12
lines changed

6 files changed

+16
-12
lines changed

tools/trond/cmd/docker/test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ var testCmd = &cobra.Command{
2020
2121
1. Perform port checks
2222
2. Verify whether block synchronization is functioning normally
23+
24+
It is used to test TRON Mainnet block synchronization within the docker container. It has a timeout limit of 1000 seconds and may encounter the error “ERROR: goss_wait.yaml never passed” due to network issues or timeouts. If this happens, please check your network status and try again.
2325
`),
2426
Example: heredoc.Doc(`
2527
# Build java-tron docker image, defualt: tronprotocol/java-tron:latest

tools/trond/cmd/node/runSingle.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ var runSingleStopCmd = &cobra.Command{
109109
nile network: ./single_node/docker-compose.fullnode.nile.yml
110110
private network: ./single_node/docker-compose.witness.private.yml
111111
- Configuration file(by default, these exist in the current repository directory)
112-
main network: ./conf/main_net_config.conf, used by main network
113-
nile network: ./conf/nile_net_config.conf, used by nile network
114-
private network: ./conf/private_net_config_*.conf, used by private network
112+
main network: ./conf/main_net_config.conf
113+
nile network: ./conf/nile_net_config.conf
114+
private network: ./conf/private_net_config_*.conf
115115
`),
116116
Example: heredoc.Doc(`
117117
# Stop single java-tron fullnode for main network

tools/trond/docs/trond_docker_test.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The test includes the following tasks:
1111
1. Perform port checks
1212
2. Verify whether block synchronization is functioning normally
1313

14+
It is used to test TRON Mainnet block synchronization within the docker container. It has a timeout limit of 1000 seconds and may encounter the error “ERROR: goss_wait.yaml never passed” due to network issues or timeouts. If this happens, please check your network status and try again.
15+
1416

1517
```
1618
trond docker test [flags]

tools/trond/docs/trond_node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Please refer to the available commands below.
2525
# Help information for node command
2626
$ ./trond node
2727
28-
# Check and configure node local environment
28+
# Check and configure node local environment. Make sure run this first before starting the node.
2929
$ ./trond node env
3030
3131
# Run single java-tron fullnode for main network

tools/trond/docs/trond_node_run-single.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ You need to make sure the local environment is ready before running the node. Ru
88

99
The following files are required:
1010

11+
- Configuration file(by default, these exist in the current repository directory)
12+
main network: ./conf/main_net_config.conf
13+
nile network: ./conf/nile_net_config.conf
14+
private network: ./conf/private_net_config_*.conf
1115
- Docker compose file(by default, these exist in the current repository directory)
1216
main network: ./single_node/docker-compose.fullnode.main.yml
1317
nile network: ./single_node/docker-compose.fullnode.nile.yml
1418
private network: ./single_node/docker-compose.witness.private.yml
15-
- Configuration file(by default, these exist in the current repository directory)
16-
main network: ./conf/main_net_config.conf, used by main network
17-
nile network: ./conf/nile_net_config.conf, used by nile network
18-
private network: ./conf/private_net_config_*.conf, used by private network
1919

2020

2121
The following directory will be created after you start any type of java-tron fullnode:

tools/trond/docs/trond_node_run-single_stop.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Stop single java-tron node for different networks.
66

77
The following configuration files are required:
88

9-
- Configuration file(by default, these exist in the current repository directory)
10-
main network: ./conf/main_net_config.conf
11-
nile network: ./conf/nile_net_config.conf
12-
private network: ./conf/private_net_config_*.conf
139
- Docker compose file(by default, these exist in the current repository directory)
1410
main network: ./single_node/docker-compose.fullnode.main.yml
1511
nile network: ./single_node/docker-compose.fullnode.nile.yml
1612
private network: ./single_node/docker-compose.witness.private.yml
13+
- Configuration file(by default, these exist in the current repository directory)
14+
main network: ./conf/main_net_config.conf
15+
nile network: ./conf/nile_net_config.conf
16+
private network: ./conf/private_net_config_*.conf
1717

1818

1919
```

0 commit comments

Comments
 (0)