diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SUMMARY.md | 6 | ||||
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 10 | ||||
| -rw-r--r-- | docs/development/cas.md (renamed from docs/dev/cas.md) | 0 | ||||
| -rw-r--r-- | docs/development/git.md (renamed from docs/dev/git.md) | 6 | ||||
| -rw-r--r-- | docs/development/img/git/branches.jpg (renamed from docs/dev/git/branches.jpg) | bin | 72228 -> 72228 bytes | |||
| -rw-r--r-- | docs/development/img/git/clean.png (renamed from docs/dev/git/clean.png) | bin | 110840 -> 110840 bytes | |||
| -rw-r--r-- | docs/development/img/git/squash.png (renamed from docs/dev/git/squash.png) | bin | 29667 -> 29667 bytes | |||
| -rw-r--r-- | docs/development/saml.md (renamed from docs/dev/saml.md) | 0 | ||||
| -rw-r--r-- | docs/openid.md | 2 | ||||
| -rw-r--r-- | docs/sample_log_config.yaml | 5 |
10 files changed, 18 insertions, 11 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index db4ef1a44e..f1bde91420 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -67,7 +67,7 @@ # Development - [Contributing Guide](development/contributing_guide.md) - [Code Style](code_style.md) - - [Git Usage](dev/git.md) + - [Git Usage](development/git.md) - [Testing]() - [OpenTracing](opentracing.md) - [Database Schemas](development/database_schema.md) @@ -77,8 +77,8 @@ - [TCP Replication](tcp_replication.md) - [Internal Documentation](development/internal_documentation/README.md) - [Single Sign-On]() - - [SAML](dev/saml.md) - - [CAS](dev/cas.md) + - [SAML](development/saml.md) + - [CAS](development/cas.md) - [State Resolution]() - [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md) - [Media Repository](media_repository.md) diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 4a65d0c3bc..160899754e 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -144,7 +144,8 @@ A response body like the following is returned: "deactivated": 0, "shadow_banned": 0, "displayname": "<User One>", - "avatar_url": null + "avatar_url": null, + "creation_ts": 1560432668000 }, { "name": "<user_id2>", "is_guest": 0, @@ -153,7 +154,8 @@ A response body like the following is returned: "deactivated": 0, "shadow_banned": 0, "displayname": "<User Two>", - "avatar_url": "<avatar_url>" + "avatar_url": "<avatar_url>", + "creation_ts": 1561550621000 } ], "next_token": "100", @@ -197,11 +199,12 @@ The following parameters should be set in the URL: - `shadow_banned` - Users are ordered by `shadow_banned` status. - `displayname` - Users are ordered alphabetically by `displayname`. - `avatar_url` - Users are ordered alphabetically by avatar URL. + - `creation_ts` - Users are ordered by when the users was created in ms. - `dir` - Direction of media order. Either `f` for forwards or `b` for backwards. Setting this value to `b` will reverse the above sort order. Defaults to `f`. -Caution. The database only has indexes on the columns `name` and `created_ts`. +Caution. The database only has indexes on the columns `name` and `creation_ts`. This means that if a different sort order is used (`is_guest`, `admin`, `user_type`, `deactivated`, `shadow_banned`, `avatar_url` or `displayname`), this can cause a large load on the database, especially for large environments. @@ -222,6 +225,7 @@ The following fields are returned in the JSON response body: - `shadow_banned` - bool - Status if that user has been marked as shadow banned. - `displayname` - string - The user's display name if they have set one. - `avatar_url` - string - The user's avatar URL if they have set one. + - `creation_ts` - integer - The user's creation timestamp in ms. - `next_token`: string representing a positive integer - Indication for pagination. See above. - `total` - integer - Total number of media. diff --git a/docs/dev/cas.md b/docs/development/cas.md index 592b2d8d4f..592b2d8d4f 100644 --- a/docs/dev/cas.md +++ b/docs/development/cas.md diff --git a/docs/dev/git.md b/docs/development/git.md index 87950f07b2..9b1ed54b65 100644 --- a/docs/dev/git.md +++ b/docs/development/git.md @@ -9,7 +9,7 @@ commits each of which contains a single change building on what came before. Here, by way of an arbitrary example, is the top of `git log --graph b2dba0607`: -<img src="git/clean.png" alt="clean git graph" width="500px"> +<img src="img/git/clean.png" alt="clean git graph" width="500px"> Note how the commit comment explains clearly what is changing and why. Also note the *absence* of merge commits, as well as the absence of commits called @@ -61,7 +61,7 @@ Ok, so that's what we'd like to achieve. How do we achieve it? The TL;DR is: when you come to merge a pull request, you *probably* want to “squash and merge”: -. +. (This applies whether you are merging your own PR, or that of another contributor.) @@ -105,7 +105,7 @@ complicated. Here's how we do it. Let's start with a picture: - + It looks complicated, but it's really not. There's one basic rule: *anyone* is free to merge from *any* more-stable branch to *any* less-stable branch at diff --git a/docs/dev/git/branches.jpg b/docs/development/img/git/branches.jpg index 715ecc8cd0..715ecc8cd0 100644 --- a/docs/dev/git/branches.jpg +++ b/docs/development/img/git/branches.jpg Binary files differdiff --git a/docs/dev/git/clean.png b/docs/development/img/git/clean.png index 3accd7ccef..3accd7ccef 100644 --- a/docs/dev/git/clean.png +++ b/docs/development/img/git/clean.png Binary files differdiff --git a/docs/dev/git/squash.png b/docs/development/img/git/squash.png index 234caca3e4..234caca3e4 100644 --- a/docs/dev/git/squash.png +++ b/docs/development/img/git/squash.png Binary files differdiff --git a/docs/dev/saml.md b/docs/development/saml.md index a9bfd2dc05..a9bfd2dc05 100644 --- a/docs/dev/saml.md +++ b/docs/development/saml.md diff --git a/docs/openid.md b/docs/openid.md index cfaafc5015..f685fd551a 100644 --- a/docs/openid.md +++ b/docs/openid.md @@ -410,7 +410,7 @@ oidc_providers: display_name_template: "{{ user.name }}" ``` -## Apple +### Apple Configuring "Sign in with Apple" (SiWA) requires an Apple Developer account. diff --git a/docs/sample_log_config.yaml b/docs/sample_log_config.yaml index 669e600081..b088c83405 100644 --- a/docs/sample_log_config.yaml +++ b/docs/sample_log_config.yaml @@ -28,7 +28,7 @@ handlers: # will be a delay for INFO/DEBUG logs to get written, but WARNING/ERROR # logs will still be flushed immediately. buffer: - class: logging.handlers.MemoryHandler + class: synapse.logging.handlers.PeriodicallyFlushingMemoryHandler target: file # The capacity is the number of log lines that are buffered before # being written to disk. Increasing this will lead to better @@ -36,6 +36,9 @@ handlers: # be written to disk. capacity: 10 flushLevel: 30 # Flush for WARNING logs as well + # The period of time, in seconds, between forced flushes. + # Messages will not be delayed for longer than this time. + period: 5 # A handler that writes logs to stderr. Unused by default, but can be used # instead of "buffer" and "file" in the logger handlers. |
