Skip to content

Commit

Permalink
Merge pull request #171 from smk762/master
Browse files Browse the repository at this point in the history
add missing env vars & fix yaml structure in README
  • Loading branch information
n8maninger authored Aug 31, 2024
2 parents 90d18cf + 8edf2c3 commit 82ffb64
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ The priority of configuration settings is as follows:
+ `9981` Sia consensus

### Environment Variables
+ `WALLETD_API_PASSWORD` - The password required to access the API
+ `WALLETD_API_PASSWORD` - The password required to access the API.
+ `WALLETD_CONFIG_FILE` - The path to the YAML configuration file. Defaults to `walletd.yml` in the working directory.
+ `WALLETD_LOG_FILE` - The path to the log file.

### Command Line Flags
```
Expand Down Expand Up @@ -99,7 +101,7 @@ Flags:

### YAML
All configuration settings can be set in a YAML file. The file should be named
`walletd.yaml` in the working directory. All fields are optional.
`walletd.yml` in the working directory. All fields are optional.
```yaml
directory: /etc/walletd
autoOpenWebUI: true
Expand All @@ -109,9 +111,11 @@ http:
publicEndpoints: false # when true, auth will be disabled on endpoints that should be publicly accessible when running walletd as a service
consensus:
network: mainnet
gatewayAddress: :9981
syncer:
bootstrap: false
enableUPnP: false
peers: []
address: :9981
index:
mode: personal # personal, full, none ("full" will index the entire blockchain, "personal" will only index addresses that are registered in the wallet, "none" will treat the database as read-only and not index any new data)
batchSize: 64 # max number of blocks to index at a time (increasing this will increase scan speed, but also increase memory and cpu usage)
Expand Down

0 comments on commit 82ffb64

Please sign in to comment.