Skip to content

Commit 1200543

Browse files
committed
chore: update README
1 parent ae4ecc5 commit 1200543

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,41 @@
22

33
This Deployer automatically deploys an RSS3 DSL Node based on a `config.yaml` file.
44

5+
For more information, please refer to the [RSS3 Node Deployment Guide](https://docs.rss3.io/docs/node).
56

6-
## Usage
7+
## Automated Deployment
8+
9+
```bash
10+
curl -s https://raw.githubusercontent.com/RSS3-Network/Node-Automated-Deployer/main/node-automated-deployer/automated_deploy.sh | bash
11+
```
12+
13+
```bash
14+
chmod -x automated_deploy.sh
15+
```
16+
17+
And you are done!
18+
19+
## Manual Deployment
720

821
### Download
922

10-
download the latest release from [release page](https://github.com/RSS3-Network/Node-Automated-Deployer/releases)
23+
Download the latest release from [release page](https://github.com/RSS3-Network/Node-Automated-Deployer/releases)
1124

1225
```bash
13-
tar -zxvf node-automated-deployer-v0.1.0-linux-amd64.tar.gz
26+
tar -zxvf downloaded_file.tar.gz
1427
```
1528

1629
### Configuration
1730

18-
create a `config.yaml` file in the subdirectory `config` of the executable file.
31+
Your `config.yaml` must be placed in the `config` subdirectory, at the same level as the `node-automated-deployer` script.
1932

20-
### Generate
33+
### Deploy
2134

2235
```bash
2336
./node-automated-deployer > docker-compose.yaml
2437
```
2538

39+
```bash
40+
docker-compose up -d
41+
```
42+

0 commit comments

Comments
 (0)