Skip to content

Commit 800db59

Browse files
committed
docs: Add clone step to README
- Add clone repository as first step in setup process
1 parent 92b2090 commit 800db59

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ Before you begin, ensure you have the following:
1717

1818
## Setup Steps
1919

20-
### 1. Generate Initial Configuration
20+
### 1. Clone the Repository
21+
22+
First, clone the TRUF.NETWORK node operator repository:
23+
24+
```bash
25+
git clone https://github.com/trufnetwork/truf-node-operator.git
26+
cd truf-node-operator
27+
```
28+
29+
### 2. Generate Initial Configuration
2130

2231
Use `kwild` to create your initial configuration file:
2332

@@ -30,7 +39,7 @@ kwild setup init \
3039

3140
For detailed instructions on configuration options more relevant to a production setup, refer to our [Configuration Guide](docs/creating-config.md).
3241

33-
### 2. Enable State Sync
42+
### 3. Enable State Sync
3443

3544
Edit the `config.toml` file in your node configuration directory to enable state sync. The following example assumes you used `./my-node-config` as your root directory in the previous step. Adjust the path if you used a different directory:
3645

@@ -42,7 +51,7 @@ sed -i 's/trusted_providers = \[\]/trusted_providers = ["0c830b69790eaa093158264
4251

4352
This will configure your node to use state sync for faster synchronization with the network.
4453

45-
### 3. Set Up PostgreSQL
54+
### 4. Set Up PostgreSQL
4655

4756
For a quick setup, run Kwil's pre-configured PostgreSQL Docker image:
4857

@@ -89,7 +98,7 @@ If you prefer a custom PostgreSQL setup, ensure it meets the requirements specif
8998

9099
**Security Warning**: It is recommended to not expose port 5432 publicly in production environments.
91100

92-
### 4. Deploy TN Node
101+
### 5. Deploy TN Node
93102

94103
Run the kwild binary to deploy your node:
95104

@@ -111,7 +120,7 @@ Ensure your firewall allows incoming connections on:
111120

112121
The `--statesync.enable` and `--statesync.trusted_providers` flags are optional and will help your node sync faster with the network using snapshots provided by the RPC servers.
113122

114-
### 5. Verify Node Synchronization
123+
### 6. Verify Node Synchronization
115124

116125
Before proceeding to become a validator, ensure your node is fully synced with the network:
117126

@@ -121,7 +130,7 @@ kwild admin status
121130

122131
Look for the `syncing: false` in the output, and check that your `best_block_height` is close to the current network height.
123132

124-
### 6. Become a Validator (Optional)
133+
### 7. Become a Validator (Optional)
125134

126135
To upgrade your node to a validator:
127136

@@ -160,7 +169,7 @@ This will show your node's public key and key type, which you'll need for valida
160169

161170
You can always reach out to the community for help with the validator process.
162171

163-
### 7. Submit Your Node to Available Node List (Optional)
172+
### 8. Submit Your Node to Available Node List (Optional)
164173

165174
To help others discover your node:
166175

0 commit comments

Comments
 (0)