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

Document using a certificate with a full chain #4849

Merged
merged 13 commits into from
Mar 13, 2019

Conversation

anoadragon453
Copy link
Member

Closes #4764

Tell people to use a full chain certificate instead of just the top-level one (which browsers will accept, but clients not packing their own certificates will not).

While we mentioned that we don't explicitly include instructions for certbot/Let's Encrypt, I believe as it's the dominant way people are getting their certificates, including a line to help those people is essential, and means less tech support to do down the line.

INSTALL.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Mar 12, 2019

Codecov Report

Merging #4849 into develop will decrease coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #4849      +/-   ##
===========================================
- Coverage    75.35%   75.34%   -0.01%     
===========================================
  Files          340      340              
  Lines        34939    34939              
  Branches      5722     5722              
===========================================
- Hits         26327    26324       -3     
- Misses        6998     7000       +2     
- Partials      1614     1615       +1

@codecov
Copy link

codecov bot commented Mar 12, 2019

Codecov Report

Merging #4849 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #4849   +/-   ##
========================================
  Coverage    75.34%   75.34%           
========================================
  Files          340      340           
  Lines        34939    34939           
  Branches      5722     5722           
========================================
  Hits         26324    26324           
  Misses        7002     7002           
  Partials      1613     1613
Impacted Files Coverage Δ
synapse/config/tls.py 63.73% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 332b60e...bac9d8e. Read the comment docs.

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.

sure. might also be worth updating the generated config so that it says "use the full chain" next to the relevant config setting.

@anoadragon453 anoadragon453 force-pushed the anoa/docs_use_fullchain branch from feb5e2d to 195776b Compare March 12, 2019 17:14
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.

I think you've messed up with the sample config somehow

INSTALL.md Outdated
for having Synapse automatically provision and renew federation
certificates through ACME can be found at [ACME.md](docs/ACME.md).
certificates through ACME can be found at [ACME.md](docs/ACME.md). If you
are using your own certificate and key, be sure to use a certificate that
Copy link
Member

Choose a reason for hiding this comment

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

wait, this is misworded. A certificate can't include a chain: you need the full chain of certificates.

"use a .pem file which includes the full certificate chain including any intermediate certificates".

Likewise for the config text,

richvdh and others added 6 commits March 13, 2019 10:30
Inserts a zero-width space in the `-->` which isn't supposed to close a
comment. This used to be here but it got lost in
d868262.
Improved federation configuration docs.  Specifically detailing  .well-known and SRV based delegation methods.

Inspiration Valentin Lab <[email protected]> for #4781
@anoadragon453 anoadragon453 force-pushed the anoa/docs_use_fullchain branch from 1ce17f1 to 3ffdd92 Compare March 13, 2019 10:40
…s_use_fullchain

* 'develop' of github.com:matrix-org/synapse:
  fix orphaned sentence
  Neilj/improved delegation doc 2 (#4832)
  Add zwsp in bug report template (#4811)
@anoadragon453
Copy link
Member Author

Apologies for the force-push, was clearing out some things. CI should hopefully be happy now.

@anoadragon453 anoadragon453 requested a review from richvdh March 13, 2019 11:10
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.

really lgtm this time

@anoadragon453 anoadragon453 merged commit 7998ca3 into develop Mar 13, 2019
@anoadragon453 anoadragon453 deleted the anoa/docs_use_fullchain branch March 13, 2019 15:26
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