Skip to content

Commit

Permalink
Fix code block formatting (#2065)
Browse files Browse the repository at this point in the history
Fix docs refs to older name certtool for easycert
  • Loading branch information
kcreyts committed Feb 1, 2021
1 parent fe740fd commit 8a5f8d2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/synapse/devguides/devops_general.rst
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

0 comments on commit 8a5f8d2

Please sign in to comment.