summaryrefslogtreecommitdiff
path: root/docs/services
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-15 18:53:07 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-15 18:53:07 +0100
commit675a38bdb5c70c7c3c258b75cb79f9dd3dd77a65 (patch)
tree3e7501226e5df782f777fb1f9ffb4ce4cc90ee27 /docs/services
parent5ee3ec89b16f26e99610de66d56feddc9f71f1c5 (diff)
downloadvyos-documentation-675a38bdb5c70c7c3c258b75cb79f9dd3dd77a65.tar.gz
vyos-documentation-675a38bdb5c70c7c3c258b75cb79f9dd3dd77a65.zip
ssh: fix section style guide
Diffstat (limited to 'docs/services')
-rw-r--r--docs/services/ssh.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/services/ssh.rst b/docs/services/ssh.rst
index 2dc0c813..0a364ea2 100644
--- a/docs/services/ssh.rst
+++ b/docs/services/ssh.rst
@@ -1,11 +1,12 @@
.. _ssh:
+###
SSH
----
+###
-Secure Shell (SSH_) is a cryptographic network protocol for operating network
-services securely over an unsecured network.[1] The standard TCP port for SSH
-is 22. The best known example application is for remote login to computer
+:abbr:`SSH (Secure Shell)` is a cryptographic network protocol for operating
+network services securely over an unsecured network. The standard TCP port for
+SSH is 22. The best known example application is for remote login to computer
systems by users.
SSH provides a secure channel over an unsecured network in a client-server
@@ -27,7 +28,7 @@ analysis. The encryption used by SSH is intended to provide confidentiality
and integrity of data over an unsecured network, such as the Internet.
Configuration
-^^^^^^^^^^^^^
+=============
Enabling SSH only requires you to add ``service ssh port NN``, where 'NN' is
the port you want SSH to listen on. By default, SSH runs on port 22.
@@ -37,7 +38,7 @@ the port you want SSH to listen on. By default, SSH runs on port 22.
set service ssh port 22
Options
-*******
+-------
* Listening address - Specify the IPv4/IPv6 listening address for connection
requests. Multiple ``listen-address`` nodes can be defined.