Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Neilj/improve federation docs #5419

Merged
merged 10 commits into from Jun 11, 2019

Conversation

2 participants
@neilisfragile
Copy link
Contributor

commented Jun 10, 2019

No description provided.

neilisfragile added some commits Jun 10, 2019

Merge branch 'neilj/improve-federation-docs' of github.com:matrix-org…
…/synapse into neilj/improve-federation-docs

@neilisfragile neilisfragile marked this pull request as ready for review Jun 10, 2019

@neilisfragile neilisfragile requested a review from matrix-org/synapse-core Jun 10, 2019

@neilisfragile neilisfragile added this to In progress in Homeserver Task Board via automation Jun 10, 2019

@babolivier
Copy link
Member

left a comment

Otherwise, some inconsistencies between using `'s and nothing for ".well-known".

I'm also concerned about the fact that we're now lacking a doc that says "if you do delegation using X and your server name is Y then you need a cert for Z" since we're obsoleting the MSC1711 FAQ, which could be confusing for new admins.

Show resolved Hide resolved docs/federate.md Outdated
Show resolved Hide resolved docs/federate.md Outdated
For instance, if you registered `example.com` and pointed its DNS A record at a
fresh Upcloud VPS or similar, you could install Synapse on that host,
giving it a server_name of `example.com`, and it would automatically generate a

This comment has been minimized.

Copy link
@babolivier

babolivier Jun 11, 2019

Member

it would automatically generate

IIRC you need to explicitly enable the ACME support and I read that as implying it was enabled by default.

Practically speaking, this is no longer necessary.
If you are using a reverse proxy for all of your TLS traffic, then you can set
`no_tls: True`. In that case, the only reason Synapse needs the certificate is

This comment has been minimized.

Copy link
@babolivier

babolivier Jun 11, 2019

Member

Maybe explicitly mention that no_tls happens in Synapse's config?

Show resolved Hide resolved docs/federate.md Outdated
Update docs/federate.md
Co-Authored-By: Brendan Abolivier <github@brendanabolivier.com>
@codecov

This comment has been minimized.

Copy link

commented Jun 11, 2019

Codecov Report

Merging #5419 into release-v1.0.0 will decrease coverage by 0.03%.
The diff coverage is n/a.

@@                Coverage Diff                 @@
##           release-v1.0.0    #5419      +/-   ##
==================================================
- Coverage           62.56%   62.53%   -0.04%     
==================================================
  Files                 326      326              
  Lines               35655    35649       -6     
  Branches             5850     5848       -2     
==================================================
- Hits                22308    22293      -15     
- Misses              11794    11804      +10     
+ Partials             1553     1552       -1
Update docs/federate.md
Co-Authored-By: Brendan Abolivier <github@brendanabolivier.com>
@codecov

This comment has been minimized.

Copy link

commented Jun 11, 2019

Codecov Report

Merging #5419 into release-v1.0.0 will decrease coverage by <.01%.
The diff coverage is n/a.

@@                Coverage Diff                 @@
##           release-v1.0.0    #5419      +/-   ##
==================================================
- Coverage           62.56%   62.56%   -0.01%     
==================================================
  Files                 326      326              
  Lines               35655    35649       -6     
  Branches             5850     5848       -2     
==================================================
- Hits                22308    22304       -4     
+ Misses              11794    11793       -1     
+ Partials             1553     1552       -1

neilisfragile and others added some commits Jun 11, 2019

Update docs/federate.md
Co-Authored-By: Brendan Abolivier <github@brendanabolivier.com>

@neilisfragile neilisfragile requested a review from babolivier Jun 11, 2019

@babolivier

This comment has been minimized.

Copy link
Member

commented Jun 11, 2019

I'm also concerned about the fact that we're now lacking a doc that says "if you do delegation using X and your server name is Y then you need a cert for Z" since we're obsoleting the MSC1711 FAQ, which could be confusing for new admins.

ftr this was already in the doc, and I've missed it by looking only at the diff. mb, forget that part.

@babolivier
Copy link
Member

left a comment

lgtm otherwise

Yes, you are welcome to manage your certificates yourself. Synapse will only
attempt to obtain certificates from Let's Encrypt if you configure it to do
so.The only requirement is that there is a valid TLS cert present for

This comment has been minimized.

Copy link
@babolivier

babolivier Jun 11, 2019

Member
Suggested change
so.The only requirement is that there is a valid TLS cert present for
so. The only requirement is that there is a valid TLS certificate present for

@neilisfragile neilisfragile merged commit 4262183 into release-v1.0.0 Jun 11, 2019

24 checks passed

buildkite/synapse Build #2050 passed (21 minutes, 34 seconds)
Details
buildkite/synapse/check-sample-config Passed (1 minute, 42 seconds)
Details
buildkite/synapse/isort Passed (24 seconds)
Details
buildkite/synapse/newspaper-newsfile Passed (25 seconds)
Details
buildkite/synapse/packaging Passed (25 seconds)
Details
buildkite/synapse/pep-8 Passed (54 seconds)
Details
buildkite/synapse/pipeline Passed (8 seconds)
Details
buildkite/synapse/python-2-dot-7-slash-postgres-9-dot-4 Passed (15 minutes, 48 seconds)
Details
buildkite/synapse/python-2-dot-7-slash-postgres-9-dot-5 Passed (15 minutes, 50 seconds)
Details
buildkite/synapse/python-2-dot-7-slash-sqlite Passed (5 minutes, 3 seconds)
Details
buildkite/synapse/python-2-dot-7-slash-sqlite-slash-old-deps Passed (6 minutes, 3 seconds)
Details
buildkite/synapse/python-3-dot-5-slash-postgres-9-dot-4 Passed (18 minutes, 31 seconds)
Details
buildkite/synapse/python-3-dot-5-slash-postgres-9-dot-5 Passed (16 minutes, 26 seconds)
Details
buildkite/synapse/python-3-dot-5-slash-sqlite Passed (5 minutes, 41 seconds)
Details
buildkite/synapse/python-3-dot-6-slash-sqlite Passed (5 minutes, 26 seconds)
Details
buildkite/synapse/python-3-dot-7-slash-postgres-11 Passed (16 minutes, 22 seconds)
Details
buildkite/synapse/python-3-dot-7-slash-postgres-9-dot-5 Passed (16 minutes, 20 seconds)
Details
buildkite/synapse/python-3-dot-7-slash-sqlite Passed (5 minutes, 29 seconds)
Details
ci/circleci: sytestpy2merged Your tests passed on CircleCI!
Details
ci/circleci: sytestpy2postgresmerged Your tests passed on CircleCI!
Details
ci/circleci: sytestpy3merged Your tests passed on CircleCI!
Details
ci/circleci: sytestpy3postgresmerged Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing 8da0d83...29f0af9
Details
codecov/project 62.56% (target 0%)
Details

Homeserver Task Board automation moved this from In progress to Done Jun 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.