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

Document how to start Synapse with Poetry #14846

Closed
babolivier opened this issue Jan 15, 2023 · 2 comments · Fixed by #14892
Closed

Document how to start Synapse with Poetry #14846

babolivier opened this issue Jan 15, 2023 · 2 comments · Fixed by #14892
Labels
A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.

Comments

@babolivier
Copy link
Contributor

The correct invocation is poetry run synapse_homeserver -c [your homeserver.yaml] (or substitute synapse_homeserver with synapse_worker for workers), however this does not seem to be documented anywhere apart from the [tool.poetry.scripts] section of pyproject.toml. This makes it more difficult for newcomers to Synapse to figure out how to run it after setting it up, so I think those entrypoints should be mentioned somewhere in Synapse's documentation.
@DMRobertson DMRobertson added A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. labels Jan 16, 2023
@thezaidbintariq
Copy link
Contributor

#14892

@clokep clokep linked a pull request Jan 23, 2023 that will close this issue
Document how to start Synapse with Poetry #14892
Merged
4 tasks
@DMRobertson
Copy link
Contributor

#15022 also helped here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document how to start Synapse with Poetry thezaidbintariq/synapse
3 participants
@babolivier @DMRobertson @thezaidbintariq