Skip to content

Commit

Permalink
Move example config and add section describing connecting via TLS (#2109
Browse files Browse the repository at this point in the history
)
  • Loading branch information
seanchen1991 authored Apr 21, 2022
1 parent 3e7b276 commit 4d33c6a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
1 change: 1 addition & 0 deletions guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [Pre-requisites](./pre_requisites.md)
- [Installation](./installation.md)
- [Configuration](./config.md)
- [Example Configuration](./example-config.md)
- [Telemetry](./telemetry.md)
- [REST API](./rest-api.md)
- [Tutorials](./tutorials/index.md)
Expand Down
15 changes: 10 additions & 5 deletions guide/src/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,17 @@ To restrict relaying on specific channels, or uni-directionally, you can use [pa
For each chain configured you need to add a private key for that chain in order to submit [transactions](./commands/raw/index.md),
please refer to the [Keys](./commands/keys/index.md) sections in order to learn how to add the private keys that are used by the relayer.

## Example configuration file
## Connecting via TLS

Here is a full example of a configuration file with two chains configured:

```toml
{{#include ../../config.toml}}
Hermes supports connection via TLS for use-cases such as connecting from behind
a proxy or a load balancer. In order to enable this, you'll want to set the
`rpc_addr`, `grpc_addr`, or `websocket_addr` parameters to specify a TLS
connection via HTTPS using the following scheme (note that the port number 443
is just used for example):
```
rpc_addr = 'https://domain.com:443'
grpc_addr = 'https://domain.com:443'
websocket_addr = 'wss://domain.com:443/websocket'
```

## Support for Interchain Accounts
Expand Down
7 changes: 7 additions & 0 deletions guide/src/example-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Example Configuration File

Here is a full example of a configuration file with two chains configured:

```toml
{{#include ../../config.toml}}
```

0 comments on commit 4d33c6a

Please sign in to comment.