Skip to content

Commit

Permalink
README.md: update
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisSchinnerl committed Aug 12, 2024
1 parent 6847e21 commit 2f54bc4
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ overview of all settings configurable through the CLI.
| `Directory` | Directory for storing node state | `.` | `--dir` | - | `directory` |
| `Seed` | Seed for the node | - | - | `RENTERD_SEED` | `seed` |
| `AutoOpenWebUI` | Automatically open the web UI on startup | `true` | `--openui` | - | `autoOpenWebUI` |
| `Network` | Network to run on (mainnet/zen/anagami) | `mainnet` | `--network` | `RENTERD_NETWORK` | `network` |
| `ShutdownTimeout` | Timeout for node shutdown | `5m` | `--node.shutdownTimeout` | - | `shutdownTimeout` |
| `Log.Level` | Global logger level (debug\|info\|warn\|error). Defaults to 'info' | `info` | `--log.level` | `RENTERD_LOG_LEVEL` | `log.level` |
| `Log.File.Enabled` | Enables logging to disk. Defaults to 'true' | `true` | `--log.file.enabled` | `RENTERD_LOG_FILE_ENABLED` | `log.file.enabled` |
Expand Down Expand Up @@ -408,14 +409,14 @@ ghcr.io/siafoundation/renterd.
version: "3.9"
services:
renterd:
image: ghcr.io/siafoundation/renterd:master-zen
image: ghcr.io/siafoundation/renterd:master
environment:
- RENTERD_SEED=put your seed here
- RENTERD_API_PASSWORD=test
ports:
- 9880:9880
- 9881:9881
- 7070:7070
- 9980:9980
- 9981:9981
- 8080:8080
volumes:
- ./data:/data
restart: unless-stopped
Expand All @@ -427,23 +428,16 @@ services:
From within the root of the repo run the following command to build an image of
`renterd` tagged `renterd`.

#### Mainnet

```sh
docker build -t renterd:master -f ./docker/Dockerfile .
```

#### Testnet

```sh
docker build --build-arg BUILD_TAGS='netgo testnet' -t renterd:master-zen -f ./docker/Dockerfile .
```

### Run Container

Run `renterd` in the background as a container named `renterd` that exposes its
API to the host system and the gateway to the world.


#### Mainnet

```bash
Expand All @@ -452,10 +446,16 @@ docker run -d --name renterd -e RENTERD_API_PASSWORD="<PASSWORD>" -e RENTERD_SEE

#### Testnet

To run `renterd` on testnet use the `RENTERD_NETWORK` environment variable.

```bash
docker run -d --name renterd-testnet -e RENTERD_API_PASSWORD="<PASSWORD>" -e RENTERD_SEED="<SEED>" -p 127.0.0.1:9880:9880/tcp -p :9881:9881/tcp ghcr.io/siafoundation/renterd:master-zen
docker run -d --name renterd -e RENTERD_API_PASSWORD="<PASSWORD>" -e RENTERD_NETWORK="<network>" -e RENTERD_SEED="<SEED>" -p 127.0.0.1:9980:9980/tcp -p :9981:9981/tcp ghcr.io/siafoundation/renterd:master
```

Currently available values for `<network>` are:
- `zen`
- `anagami`

## Architecture

`renterd` distinguishes itself from `siad` through a unique architecture
Expand Down

0 comments on commit 2f54bc4

Please sign in to comment.