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.

Sign up for GitHub

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

Jump to bottom

Fix docs for easycert to use the correct name #2065

Merged
merged 2 commits into from
Feb 1, 2021
Merged

Fix docs for easycert to use the correct name #2065

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee4fea7
correct typo in devops general docs
Jan 29, 2021
5562078
replace references to certtool with easycert
Jan 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/synapse/devguides/devops_general.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ Once the ``ssl`` protocol is specified, the ``hostname``, either from a query pa
network location, is used to lookup a matching ``crt`` and ``key`` file pair from your server certificate directory
located at ``~/.syn/certs/hosts``. See the following sections for how to setup server certificates.

Self-Signed Certificates using certtool
Self-Signed Certificates using easycert
***************************************

For self-signed certificates, we need to generate a CA certificate and key as well as a server certificate and key.

The synapse ``certtool`` can be used to easily generate a CA and server certificates. For example, if we wanted
The synapse ``easycert`` can be used to easily generate a CA and server certificates. For example, if we wanted
to generate a CA certificate for "vertex"::

python -m synapse.tools.easycert --ca vertex
Expand All @@ -97,11 +97,12 @@ to sign arbitrary certificates).
CA-Signed Certificates
**********************

Any external CA may be used to sign ``telepath`` server certificates. The ``certtool`` can be used to easily
Any external CA may be used to sign ``telepath`` server certificates. The ``easycert`` can be used to easily
generate a certificate signing request (CSR) to be signed by an external CA or you can simply copy or link
pre-existing PEM encoded certificate files to the expected filesystem locations.

To generate a CSR using ``certtool``::
To generate a CSR using ``easycert``::

python -m synapse.tools.easycert --csr --server cortex.vertex.link
key saved: /home/visi/.syn/certs/hosts/cortex.vertex.link.key
csr saved: /home/visi/.syn/certs/hosts/cortex.vertex.link.csr
Expand Down