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

Switch UNIX socket paths to /run, and add a UNIX socket example for HAProxy #16700

Merged
merged 5 commits into from Dec 4, 2023

Conversation

villepeh
Copy link
Contributor

@villepeh villepeh commented Nov 28, 2023

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

PR

Resolves #16698

Added a HAProxy UNIX socket example as well. It was one of the reasons I wanted to check if we should swap /var/run to /run, first. I've been using Synapse's UNIX sockets with HAProxy for a while now with no issues.

For consistency, I also reversed the order of the example worker configuration replication and client/federation fields as every other example configuration lists replication stuff first, and a public listener second.

Signed-off-by: Ville Petteri Huh villep8@gmail.com

@villepeh villepeh requested a review from a team as a code owner November 28, 2023 18:00
@villepeh
Copy link
Contributor Author

One more thing to note that I didn't feel like including into this PR as this one is mostly about the docs: If you add RuntimeDirectory=synapse to your matrix.service, systemd will automatically create /run/synapse for the Synapse user which can be used for storing the .sock files.

Copy link
Contributor

@DMRobertson DMRobertson left a comment

Choose a reason for hiding this comment

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

Thank you!

@DMRobertson DMRobertson merged commit 0aa4d3b into matrix-org:develop Dec 4, 2023
32 checks passed
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.

Suggest /run for storing UNIX sockets
2 participants