Skip to content
This repository has been archived by the owner on Nov 25, 2024. It is now read-only.

docs: Add build page; correct proxy info; fix Caddy example #2579

Merged
merged 4 commits into from
Jul 21, 2022

Conversation

mholt
Copy link
Contributor

@mholt mholt commented Jul 19, 2022

This patch makes changes to the documentation.

  • I added a Build page because I found build.[sh|cmd] quite useful but it was not mentioned at all. And it turns out all build instructions were missing anyway; there was a gap between planning and installing and configuring, and that was getting the actual binaries and utilities needed to run Dendrite.

  • Corrected information about reverse proxies. This was my initial motivation to make a pull request, was to fix the language saying that NGINX and HAProxy manage TLS certificates for you automatically. Those proxies do not do that (separate tooling is required) but Caddy does automate HTTPS completely by default. (For disclosure, I'm the author of Caddy.) Since privacy and security are important with the Matrix community, I added more info about Caddy into the docs and updated/simplified the Caddyfile example. It's a Caddyfile that I'm successfully using to run Dendrite.

  • Reordered the Installation pages because talking about signing keys (which requires a binary that hasn't been explained how to be built yet) doesn't make sense before installing the server; same with setting up the database. This is just my opinion but I find this order more intuitive and helpful when I was setting up Dendrite.

  • Fixed a broken link (I think).

Thanks for the cool project, looking forward to seeing it become fully mature!

Pull Request Checklist

  • I have added added tests for PR or I have justified why this PR doesn't need tests.
  • Pull request includes a sign off

Signed-off-by: Matthew Holt <[email protected]>

@mholt mholt requested a review from a team as a code owner July 19, 2022 19:57
@bones-was-here
Copy link

"base_url" is only needed in .well-known/matrix/client, for example https://matrix.org/.well-known/matrix/server omits it.

IMO you should include reverse_proxy /_dendrite/* localhost:8008
Dendrite doesn't have many admin endpoints yet but they are useful and presumably more will be added.

@mholt
Copy link
Contributor Author

mholt commented Jul 19, 2022

"base_url" is only needed in .well-known/matrix/client, for example matrix.org/.well-known/matrix/server omits it.

Oops, you're right. Thanks for catching that.

IMO you should include reverse_proxy /_dendrite/* localhost:8008

Didn't know that, thanks! Added.

Copy link
Contributor

@S7evinK S7evinK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides the comments, looks good to me.

docs/installation/1_planning.md Outdated Show resolved Hide resolved
docs/installation/6_install_polylith.md Outdated Show resolved Hide resolved
docs/caddy/monolith/Caddyfile Outdated Show resolved Hide resolved
@mholt mholt requested a review from S7evinK July 20, 2022 17:34
@S7evinK
Copy link
Contributor

S7evinK commented Jul 21, 2022

Looks good, thanks for this!

@S7evinK S7evinK merged commit 35ce551 into matrix-org:main Jul 21, 2022
@genofire
Copy link
Contributor

thanks for fixing:
#2531 (comment)

also -> i has not find time to make it ;)

@genofire genofire mentioned this pull request Jul 21, 2022
2 tasks
PiotrKozimor added a commit to globekeeper/dendrite that referenced this pull request Aug 3, 2022
* Correctly redact events over federation (matrix-org#2526)

* Ensure we check powerlevel/origin before redacting an event

* Add passing test

* Use pl.UserLevel

* Make check more readable, also check for the sender

* Add new next steps page to the documentation

* Highlighting in docs

* Rename the page to "Optimise your installation"

* Attempt to raise the file descriptor limit at startup (matrix-org#2527)

* Add `--difference` to `resolve-state` tool

* Make the linter happy again

* generic CaddyFile in front of Dendrite (monolith) (matrix-org#2531)

for Caddy 2.5.x

Co-authored-by: emanuele.aliberti <[email protected]>

* Handle state before, send history visibility in output (matrix-org#2532)

* Check state before event

* Tweaks

* Refactor a bit, include in output events

* Don't waste time if soft failed either

* Tweak control flow, comments, use GMSL history visibility type

* Fix rare panic when returning user devices over federation (matrix-org#2534)

* Add `InputDeviceListUpdate` to the keyserver, remove old input API (matrix-org#2536)

* Add `InputDeviceListUpdate` to the keyserver, remove old input API

* Fix copyright

* Log more information when a device list update fails

* Fix nats.go commit (matrix-org#2540)

Signed-off-by: Jean Lucas <[email protected]>

* Don't return `end` if there are not more messages (matrix-org#2542)

* Be more spec compliant

* Move lazyLoadMembers to own method

* Return an error if trying to invite a malformed user ID (matrix-org#2543)

* Add `evacuateUser` endpoint, use it when deactivating accounts (matrix-org#2545)

* Add `evacuateUser` endpoint, use it when deactivating accounts

* Populate the API

* Clean up user devices when deactivating

* Include invites, delete pushers

* Silence presence logs (matrix-org#2547)

* Blacklist `Guest users can join guest_access rooms` test until it can be investigated

* Disable WebAssembly builds for now

* Try to fix backfilling (matrix-org#2548)

* Try to fix backfilling

* Return start/end to not confuse clients

* Update GMSL

* Update GMSL

* Roomserver producers package (matrix-org#2546)

* Give the roomserver a producers package

* Change init point

* Populate ACLs API

* Fix build issues

* `RoomEventProducer` naming

* Version 0.8.9 (matrix-org#2549)

* Version 0.8.9

* Update changelog

* feat+fix: Ignore unknown keys and verify required fields are present in appservice registration files (matrix-org#2550)

* fix: ignore unknown keys in appservice configs

fixes matrix-org#1567

* feat: verify required fields in appservice configs

* Use new testrig for key changes tests (matrix-org#2552)

* Use new testrig for tests

* Log the error message

* Fix QuerySharedUsers for the SyncAPI keychange consumer (matrix-org#2554)

* Make more use of base.BaseDendrite

* Fix QuerySharedUsers if no UserIDs are supplied

* Return clearer error when no state NID exists for an event (matrix-org#2555)

* Wrap error from `SnapshotNIDFromEventID`

* Hopefully fix read receipts timestamps (matrix-org#2557)

This should avoid coercions between signed and unsigned ints which might fix problems like `sql: converting argument $5 type: uint64 values with high bit set are not supported`.

* Fix nil pointer access when redacting events (matrix-org#2560)

* Fix issue `uint64 values with high bit are not supported` in presence (matrix-org#2562)

* Fix issue matrix-org#2528

* Use gomatrixserverlib.Timestamp

* Use ParseUint instead of ParseInt

* Update Pinecone to matrix-org/pinecone@1ce778f

* Ristretto cache (matrix-org#2563)

* Try Ristretto cache

* Tweak

* It's beautiful

* Update GMSL

* More strict keyable interface

* Fix that some more

* Make less panicky

* Don't enforce mutability checks for now

* Determine mutability using deep equality

* Tweaks

* Namespace keys

* Make federation caches mutable

* Update cost estimation, add metric

* Update GMSL

* Estimate cost for metrics better

* Reduce counters a bit

* Try caching events

* Some guards

* Try again

* Try this

* Use separate caches for hopefully better hash distribution

* Fix bug with admitting events into cache

* Try to fix bugs

* Check nil

* Try that again

* Preserve order jeezo this is messy

* thanks VS Code for doing exactly the wrong thing

* Try this again

* Be more specific

* aaaaargh

* One more time

* That might be better

* Stronger sorting

* Cache expiries, async publishing of EDUs

* Put it back

* Use a shared cache again

* Cost estimation fixes

* Update ristretto

* Reduce counters a bit

* Clean up a bit

* Update GMSL

* 1GB

* Configurable cache sizees

* Tweaks

* Add `config.DataUnit` for specifying friendly cache sizes

* Various tweaks

* Update GMSL

* Add back some lazy loading caching

* Include key in cost

* Include key in cost

* Tweak max age handling, config key name

* Only register prometheus metrics if requested

* Review comments @S7evinK

* Don't return errors when creating caches (it is better just to crash since otherwise we'll `nil`-pointer exception everywhere)

* Review comments

* Update sample configs

* Update GHA Workflow

* Update Complement images to Go 1.18

* Remove the cache test from the federation API as we no longer guarantee immediate cache admission

* Don't check the caches in the renewal test

* Possibly fix the upgrade tests

* Update to matrix-org/gomatrixserverlib#322

* Update documentation to refer to Go 1.18

* Minor SendToDevice fix (matrix-org#2565)

* Avoid unnecessary marshalling if sending to the local server

* Fix ordering of ToDevice messages

* Revive SendToDevice test

* Use `/v3` to request media from remote servers (update to matrix-org/gomatrixserverlib#324)

* Pointerise `types.RoomInfo` in the cache so we can update it in-place in the latest events updater

* Add a Troubleshooting page

* Update `sytest-whitelist`

* Use sync API database in `filterSharedUsers` (matrix-org#2572)

* Add function to the sync API storage package for filtering shared users

* Use the database instead of asking the RS API

* Fix unit tests

* Fix map handling in `filterSharedUsers`

* Update 1_createusers.md (matrix-org#2571)

* Update 1_createusers.md

Added description on how to create user accounts when running in docker.

* Update 1_createusers.md

Co-authored-by: Neil Alexander <[email protected]>

* Fix connection_string format in dendrite-sample.polylith.yaml (matrix-org#2574)

* History visibility database changes (matrix-org#2533)

* Add new history_visibility column

* Update SQL queries to include history_visibility

* Store the history visibilty calculated by the roomserver

* Update GMSL

* Update migrations

* Fix migration

* Update GMSL

* Fix `go.sum`

* Update GMSL to use sql.Scanner & sql.Valuer

* Re-order migration/table creation

* Update gomatrixserverlib

* Add history_visibility column to current_room_state

* Fix migrations

* Return error instead of Fatal log

Co-authored-by: Neil Alexander <[email protected]>

* Tweak cache counters (matrix-org#2575)

* Tweak cache counters

This makes the number of counters relative to the
maximum cache size. Since the counters
effectively manage the size of the bloom filter,
larger caches need more counters and smaller
caches need less.

10 counters per 1KB data means that the default
cache size of 1GB should result in a bloom filter
and TinyLRU admission set of about 16MB
estimated.

* Remove line left by accident

* Set historyVisibility in rowsToStreamEvents

* Update FAQ

* Add event state key cache (matrix-org#2576)

* Explain how SRV works in Matrix and discourage using it (matrix-org#2577)

* Explain how SRV works in Matrix and discourage using it

* Minor tweaks to formatting

Co-authored-by: Neil Alexander <[email protected]>

* Fix issue with membership event_nid being 0 (matrix-org#2580)

* docs: Add build page; correct proxy info; fix Caddy example (matrix-org#2579)

* Add build page; correct proxy info; fix Caddy example

* Improve Caddyfile example

* Apply review comments; add polylith Caddyfile

* Bump tzinfo from 1.2.9 to 1.2.10 in /docs (matrix-org#2584)

Bumps [tzinfo](https://github.com/tzinfo/tzinfo) from 1.2.9 to 1.2.10.
- [Release notes](https://github.com/tzinfo/tzinfo/releases)
- [Changelog](https://github.com/tzinfo/tzinfo/blob/master/CHANGES.md)
- [Commits](tzinfo/tzinfo@v1.2.9...v1.2.10)

---
updated-dependencies:
- dependency-name: tzinfo
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Membership updater refactoring (matrix-org#2541)

* Membership updater refactoring

* Pass in membership state

* Use membership check rather than referring to state directly

* Delete irrelevant membership states

* We don't need the leave event after all

* Tweaks

* Put a log entry in that I might stand a chance of finding

* Be less panicky

* Tweak invite handling

* Don't freak if we can't find the event NID

* Use event NID from `types.Event`

* Clean up

* Better invite handling

* Placate the almighty linter

* Blacklist a Sytest which is otherwise fine under Complement for reasons I don't understand

* Fix the sytest after all (thanks @S7evinK for the spot)

* Try to fix HTTP 500s on `/members` (matrix-org#2581)

* Update database migrations, remove goose (matrix-org#2264)

* Add new db migration

* Update migrations
Remove goose

* Add possibility to test direct upgrades

* Try to fix WASM test

* Add checks for specific migrations

* Remove AddMigration
Use WithTransaction
Add Dendrite version to table

* Fix linter issues

* Update tests

* Update comments, outdent if

* Namespace migrations

* Add direct upgrade tests, skipping over one version

* Split migrations

* Update go version in CI

* Fix copy&paste mistake

* Use contexts in migrations

Co-authored-by: kegsay <[email protected]>
Co-authored-by: Neil Alexander <[email protected]>

* Add .well-known/matrix/client to clientapi (matrix-org#2551)

Signed-off-by: Jonathan Bartlett <[email protected]>

Co-authored-by: Neil Alexander <[email protected]>

* Remove `room_id` field from MSC2946 stripped events (closes matrix-org#2588)

* Remove `goose` from Dockerfiles

* Make the User API responsible for sending account data output events (matrix-org#2592)

* Make the User API responsible for sending account data output events

* Clean up producer

* Review comments

* Update NATS Server and nats.go to use upstream

* Set CORS headers for HTTP 404 and 405 errors (matrix-org#2599)

* Set CORS headers for the 404s

* Use custom handlers, plus one for HTTP 405 too

* Tweak setup

* Add to muxes too

* Tidy up some more

* Use built-in HTTP 404 handler

* Don't bother setting it for federation-facing

* Optimise checking other servers allowed to see events (matrix-org#2596)

* Try optimising checking if server is allowed to see event

* Fix error

* Handle case where snapshot NID is 0

* Fix query

* Update SQL

* Clean up `CheckServerAllowedToSeeEvent`

* Not supported on SQLite

* Maybe placate the unit tests

* Review comments

* De-race `types.RoomInfo` (matrix-org#2600)

* De-race `CompleteSync` (matrix-org#2601)

The `err` was coming from outside of the goroutine and being written to by concurrent goroutines.

* Version 0.9.0 (matrix-org#2602)

Co-authored-by: Till <[email protected]>
Co-authored-by: Neil Alexander <[email protected]>
Co-authored-by: Till Faelligen <[email protected]>
Co-authored-by: Emanuele Aliberti <[email protected]>
Co-authored-by: emanuele.aliberti <[email protected]>
Co-authored-by: Jean Lucas <[email protected]>
Co-authored-by: Kabir Kwatra <[email protected]>
Co-authored-by: andreever <[email protected]>
Co-authored-by: Maximilian Gaedig <[email protected]>
Co-authored-by: Tulir Asokan <[email protected]>
Co-authored-by: Matt Holt <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: kegsay <[email protected]>
Co-authored-by: Jonathan Bartlett <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants