Skip to content

Commit

Permalink
Update docs for s2s options
Browse files Browse the repository at this point in the history
- All options are allowed per host type
- s2s section overrides the whole global section now
  • Loading branch information
chrzaszcz committed Feb 2, 2022
1 parent f146377 commit 77126ba
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
10 changes: 2 additions & 8 deletions doc/configuration/host_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,13 +193,7 @@ The `register` rule is defined only for `domain2.com`.

### `host_config.s2s`

The options defined here override the ones defined in the top-level [`s2s`](s2s.md) section.
The following options are allowed:

* [`default_policy`](s2s.md#s2sdefault_policy)
* [`host_policy`](s2s.md#s2shost_policy)
* [`shared`](s2s.md#s2sshared)
* [`max_retry_delay`](s2s.md#s2smax_retry_delay)
This section completely overrides the top-level [`s2s`](s2s.md) section, all options are allowed.

#### Example

Expand Down Expand Up @@ -227,4 +221,4 @@ The `host_policy` option is changed for `domain2.com`:
]
```

The `default_policy` is still `deny`.
Note that `default_policy` for `domain2.com` has the default value `allow`, because `host_config.s2s` completely overrides the top-level `s2s` section, and all options are reset to the respective default values, unless they are explicitly changed.
2 changes: 1 addition & 1 deletion doc/configuration/s2s.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Default policy for opening new S2S connections to/from remote servers.
* **Syntax:** array of TOML tables with the following mandatory content:
* `host` - string, host name
* `policy` - string, `"allow"` or `"deny"`
* **Default:** `"allow"`
* **Default:** not set, `default_policy` is used
* **Example:**

```toml
Expand Down
4 changes: 3 additions & 1 deletion doc/migrations/5.0.0_5.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ See the [auth configuration](../configuration/auth.md) for details.

### Section `s2s`

The `domain_certfile` option has been moved to the `general` section because it affects `c2s` connections as well.
* All options can be set globally or inside `host_config`.
* The `host_config.s2s` section overrides the whole global section now. Previously only the specified options were overridden.
* The `domain_certfile` option has been moved to the `general` section because it affects `c2s` connections as well.

### Section `host_config`

Expand Down

0 comments on commit 77126ba

Please sign in to comment.