Continue structural port from Spring Boot to Undertow
- Configuration options - Configuration documentation
This commit is contained in:
@@ -151,9 +151,12 @@ the internal IP of the Homeserver so it can talk to it directly to integrate its
|
||||
|
||||
To do so, put the following configuration in your mxisd configuration:
|
||||
```yaml
|
||||
dns.overwrite.homeserver.client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
dns:
|
||||
overwrite:
|
||||
homeserver:
|
||||
client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
```
|
||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
You can use `${server.name}` to auto-populate the `value` using the `server.name` configuration option and avoid duplicating it.
|
||||
|
||||
@@ -5,16 +5,19 @@ to 3PID queries if no mapping was found, allowing seamless bridging to a network
|
||||
This is performed by implementing a specific endpoint on the bridge to map a 3PID lookup to a virtual user.
|
||||
|
||||
**NOTE**: This document is incomplete and might be misleading. In doubt, come in our Matrix room.
|
||||
You can also look at our [Email Bridge README](https://github.com/kamax-io/matrix-appservice-email#mxisd) for an example
|
||||
You can also look at our [Email Bridge README](https://github.com/kamax-matrix/matrix-appservice-email#mxisd) for an example
|
||||
of working configuration.
|
||||
|
||||
## Configuration
|
||||
```yaml
|
||||
lookup.recursive.bridge.enabled: <boolean>
|
||||
lookup.recursive.bridge.recursiveOnly: <boolean>
|
||||
lookup.recursive.bridge.server: <URL to the bridge endpoint for all 3PID medium>
|
||||
lookup.recursive.bridge.mappings:
|
||||
<3PID MEDIUM HERE>: <URL to dedicated bridge for that medium>
|
||||
lookup:
|
||||
recursive:
|
||||
bridge:
|
||||
enabled: <boolean>
|
||||
recursiveOnly: <boolean>
|
||||
server: <URL to the bridge endpoint for all 3PID medium>
|
||||
mappings:
|
||||
<3PID MEDIUM HERE>: <URL to dedicated bridge for that medium>
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -123,27 +123,31 @@ the internal IP of the Homeserver so it can talk to it directly to integrate its
|
||||
|
||||
To do so, use the following configuration:
|
||||
```yaml
|
||||
dns.overwrite.homeserver.client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
dns:
|
||||
overwrite:
|
||||
homeserver:
|
||||
client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
```
|
||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
In case the hostname is the same as your Matrix domain, you can use `${matrix.domain}` to auto-populate the value using
|
||||
the `matrix.domain` configuration option and avoid duplicating it.
|
||||
|
||||
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||
- `name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
- `value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||
|
||||
## Next steps
|
||||
### Homeserver results
|
||||
You can configure if the Homeserver should be queried at all when doing a directory search.
|
||||
To disable Homeserver results, set the following in mxisd configuration file:
|
||||
```yaml
|
||||
directory.exclude.homeserver: true
|
||||
directory:
|
||||
exclude:
|
||||
homeserver: true
|
||||
```
|
||||
|
||||
### 3PID exclusion in search
|
||||
You can configure if the 3PID should also be included when doing a directory search.
|
||||
By default, a search is performed on the 3PIDs. If you would like to not include them:
|
||||
```yaml
|
||||
directory.exclude.threepid: true
|
||||
directory:
|
||||
exclude:
|
||||
threepid: true
|
||||
```
|
||||
|
||||
@@ -40,10 +40,21 @@ The port must be HTTPS capable which is what you get in a regular setup with a r
|
||||
If you would like to disable outbound federation and isolate your identity server from the rest of the Matrix network,
|
||||
use the following mxisd configuration options:
|
||||
```yaml
|
||||
lookup.recursive.enabled: false
|
||||
invite.resolution.recursive: false
|
||||
session.policy.validation.forLocal.toRemote.enabled: false
|
||||
session.policy.validation.forRemote.toRemote.enabled: false
|
||||
lookup:
|
||||
recursive:
|
||||
enabled: false
|
||||
invite:
|
||||
resolution:
|
||||
recursive: false
|
||||
session:
|
||||
policy:
|
||||
validation:
|
||||
forLocal:
|
||||
toRemote:
|
||||
enabled: false
|
||||
forRemote:
|
||||
toRemote:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
There is currently no way to selectively disable federation towards specific servers, but this feature is planned.
|
||||
|
||||
@@ -7,8 +7,9 @@ Implementation of the [Unofficial Matrix Identity Service API](https://kamax.io/
|
||||
If you would like to use the central matrix.org Identity server to ensure maximum discovery at the cost of potentially
|
||||
leaking all your contacts information, add the following to your configuration:
|
||||
```yaml
|
||||
forward.servers:
|
||||
- 'matrix-org'
|
||||
forward:
|
||||
servers:
|
||||
- 'matrix-org'
|
||||
```
|
||||
**NOTE:** You should carefully consider enabling this option, which is discouraged.
|
||||
For more info, see the [relevant issue](https://github.com/kamax-matrix/mxisd/issues/76).
|
||||
|
||||
@@ -7,4 +7,4 @@ Currently supported:
|
||||
- 3PIDs
|
||||
- Roles/Groups
|
||||
|
||||
Experimental sub-features are also available. See [the dedicated document](experimental/profile.md).
|
||||
Experimental sub-features are also available. See [the dedicated document](experimental/profile.md).
|
||||
|
||||
Reference in New Issue
Block a user