Lots of new awesome documentation
This commit is contained in:
7
docs/features/authentication.md
Normal file
7
docs/features/authentication.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Authentication
|
||||
Performed via [synapse with REST auth module](https://github.com/kamax-io/matrix-synapse-rest-auth/blob/master/README.md)
|
||||
|
||||
Point the `endpoint` to mxisd internal IP on port 8090
|
||||
|
||||
## Profile auto-fill
|
||||
To be documented
|
||||
1
docs/features/bridge-integration.md
Normal file
1
docs/features/bridge-integration.md
Normal file
@@ -0,0 +1 @@
|
||||
To be documented
|
||||
@@ -89,8 +89,7 @@ the `matrix.domain` configuration option and avoid duplicating it.
|
||||
|
||||
### Backends
|
||||
#### LDAP
|
||||
Configuration structure has been altered so queries are automatically built from a global or specific filter and a list
|
||||
of attributes. To ensure Directory feature works, here how the LDAP configuration should look like:
|
||||
To ensure Directory feature works, here's how the LDAP configuration should look like:
|
||||
```
|
||||
ldap:
|
||||
enabled: false
|
||||
@@ -123,12 +122,12 @@ ldap:
|
||||
- 'employeeNumber'
|
||||
- 'someOtherAttribute'
|
||||
```
|
||||
Previous configuration entries that contained queries with the `%3pid` placeholder should not be used anymore, unless
|
||||
specifically overwritten. Instead, add all attributes to the relevant sections.
|
||||
Only include the `attribute` sub-sections if you would like to set another value. Else, it is best not to include them
|
||||
to inherit the default values.
|
||||
|
||||
If you would like to include an attribute which is not a display name or a 3PID, you can use the
|
||||
`directory.attribute.other` to list any extra attributes you want included in searches.
|
||||
If you do not want to include any extra attribute, that configuration section can be skipped.
|
||||
`directory.attribute.other` to list any extra attributes you want included in searches. If you do not want to include
|
||||
any extra attribute, that configuration section can be skipped.
|
||||
|
||||
#### SQL
|
||||
If you plan to integrate directory search directly with synapse, use the `synapseSql` provider, based on the following
|
||||
@@ -137,9 +136,9 @@ config:
|
||||
synapseSql:
|
||||
enabled: true
|
||||
type: <database ID>
|
||||
connection: ``
|
||||
connection: '<connection info>'
|
||||
```
|
||||
`type` and `connection`, including any other configuration item, follow the same values as the regular `sql` backend.
|
||||
`type` and `connection`, including any other configuration item, follow the same values as the regular [SQL backend](../backends/sql.md).
|
||||
|
||||
---
|
||||
|
||||
|
||||
15
docs/features/federation.md
Normal file
15
docs/features/federation.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Identity service Federation
|
||||
To allow other federated Identity Server to reach yours, the same algorithm used for Homeservers takes place:
|
||||
1. Check for the appropriate DNS SRV record
|
||||
2. If not found, use the base domain
|
||||
|
||||
If your Identity Server public hostname does not match your Matrix domain, configure the following DNS SRV entry
|
||||
and replace `matrix.example.com` by your Identity server public hostname - **Make sure to end with a final dot!**
|
||||
```
|
||||
_matrix-identity._tcp.example.com. 3600 IN SRV 10 0 443 matrix.example.com.
|
||||
```
|
||||
This would only apply for 3PID that are DNS-based, like e-mails. For anything else, like phone numbers, no federation
|
||||
is currently possible.
|
||||
|
||||
The port must be HTTPS capable. Typically, TCP port `8090` of mxisd should be behind a reverse proxy which does HTTPS.
|
||||
See the [main README integration section](../README.md#integration) for more details.
|
||||
3
docs/features/identity.md
Normal file
3
docs/features/identity.md
Normal file
@@ -0,0 +1,3 @@
|
||||
To be documented.
|
||||
|
||||
Implementation of the [Matrix Identity service API](https://matrix.org/docs/spec/identity_service/unstable.html)
|
||||
Reference in New Issue
Block a user