Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
Signed-off-by: Lorenz Herzberger <[email protected]>
  • Loading branch information
LaurentMontBlanc committed Apr 3, 2024
1 parent 47356b1 commit fd4448a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# rddl-prometheus-exporter
This service is responsible for providing vital network metrics for prometheus.

## Execution
The service can be executed via the following go command without having it previously built:
```
go run cmd/rddl-prometheus-exporter/main.go
```

## Configuration
The service needs to be configured via the ```./app.toml``` file or environment variables. The defaults are:
```
rpc-host = 'localhost:18884' // elementsd rpc host
rpc-pass = 'password' // elementsd rpc password
rpc-user = 'user' // elementsd rpc user
service-bind = 'localhost'
service-port = 8080
wallets = 'wallet1,wallet2' // liquid wallets
```

0 comments on commit fd4448a

Please sign in to comment.