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

Add a blurb explaining the main synapse worker #2886

Merged
merged 4 commits into from
Apr 5, 2018

Conversation

turt2live
Copy link
Member

While setting this up I ran into a couple issues that should hopefully be resolved by the documentation in this PR:

  • Almost forgetting that the main synapse process is now a worker
  • Getting errors for having worker_* config options (because copy/paste is a thing)

@matrixbot
Copy link
Member

Can one of the admins verify this patch?

1 similar comment
@matrixbot
Copy link
Member

Can one of the admins verify this patch?

Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

thanks very much for this, travis. sorry that the docs were lagging here.

It feels a bit odd to put this doc at the end of the configuration section though - surely it's needed as a prerequisite for setting up any workers at all?

docs/workers.rst Outdated

Be sure to keep this particular configuration limited as synapse may refuse to
start if the regular ``worker_*`` options are given. The ``homeserver.yaml``
configuration will be used to set up the main synapse process.
Copy link
Member

Choose a reason for hiding this comment

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

isn't homeserver.yaml used for all of the processes?

Copy link
Member Author

Choose a reason for hiding this comment

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

It is, however the main worker is different in that it refuses to work with the standard worker_* options. I wanted to add a reminder that the homeserver.yaml is used instead.

Copy link
Member

Choose a reason for hiding this comment

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

I think your phrasing is a bit misleading then.

@turt2live
Copy link
Member Author

The only reason it's at the end of the section is because everything before it talks about how workers are supposed to work. I'll update this to work it in more prominently though

@turt2live
Copy link
Member Author

@richvdh I've updated this. I threw in the documentation for #3018 because it's such a small change. I can make it its own PR if wanted though.

@richvdh
Copy link
Member

richvdh commented Apr 5, 2018

\o/

@richvdh richvdh merged commit 5514220 into matrix-org:develop Apr 5, 2018
@turt2live turt2live deleted the travis/new-worker-docs branch April 5, 2018 16:34
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.

3 participants