Skip to content

Commit 792fd41

Browse files
committed
Rework SSH docs
Signed-off-by: Volker Theile <[email protected]>
1 parent bc41551 commit 792fd41

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

administration/services/ssh.rst

+23-17
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,45 @@ SSH
44
Overview
55
--------
66

7-
Secure shell comes disabled by default in |omv|, when installing |omv| on top a
8-
Debian installation, the systemd unit will be disabled after the server
9-
packages are installed. Just login into |webui| to re-enable the ssh service.
7+
Secure shell comes enabled by default in |omv|.
108

11-
The configuration options are minimal, But is possible to:
9+
.. note::
10+
|omv| will enable SSH access for the user ``root`` by default to be
11+
able to access a headless system in case of a broken installation or
12+
other maintenance situations. You should disable this behaviour in the
13+
``Services | SSH`` page for security reasons after installation.
14+
15+
To still get ``root`` access you need to create a non-privileged user
16+
and add them to the ``_ssh`` and ``sudo`` groups. After that you can
17+
SSH into the system with this non-privileged user and run ``sudo su``.
18+
19+
The configuration options via |webui| are minimal:
1220

1321
- Disable the root login
1422
- Disable password authentication
1523
- Enable public key authentication (PKA)
1624
- Enable compression
1725
- Enable tunneling (for SOCKS and port forward)
1826

19-
An extra text field is provided to enter more options. Examine first the
27+
An extra options field is provided to enter more options. Examine first the
2028
file :file:`/etc/ssh/sshd_config` before adding extra options otherwise the
21-
option will not be applied. In that case is necessary change the environmental variable.
29+
option will not be applied. You may also check the SSH related :doc:`environmental variables </various/advset>`
30+
that can be used to customize several options.
31+
32+
Normal users created in the |webui| can access the remote shell by
33+
adding them to the ``_ssh`` group. Using PKA for users requires keys to be added
34+
to their profile. This is described in the :doc:`Users </administration/users>` section. The public key has to be
35+
added in `OpenSSH` or `RFC 4716 <https://tools.ietf.org/html/rfc4716>`_ format.
2236

2337
.. _ssh_convert_rfc4716:
2438

25-
Normal |omv| users created in the |webui| can access the remote shell by
26-
adding them to the ssh group. Using PKA for users requires keys to be added
27-
to their profile, this is done in the Users section. The key has to be
28-
added in `RFC 4716 <https://tools.ietf.org/html/rfc4716>`_ format. To do
29-
that run::
39+
To convert a public key run::
3040

3141
$ ssh-keygen -e -f nameofthekey.pub
3242

3343
Paste the output in the users profile at ``Users | Users | <USERNAME> | Edit | Public Keys``.
3444

35-
The number of keys per user is unlimited. A public key in RFC 4716 looks like this::
45+
A public key in RFC 4716 looks like this::
3646

3747
---- BEGIN SSH2 PUBLIC KEY ----
3848
Comment: "iPhone user1"
@@ -54,13 +64,9 @@ If root login has been disabled and need to perform administrative tasks in the
5464

5565
$ su
5666

57-
To use sudo for root operations add the user to the sudo group.
58-
59-
The SFTP server comes enabled by default for root and ssh group. So POSIX folder permissions apply to non-root users accessing via SFTP.
60-
6167
.. note::
6268
**Remote WAN access**
63-
- Forward in router/firewall a port different than 22. This will minimize bots fingering the ssh server.
69+
- Forward in router/firewall a port different than 22. This will minimize bots fingering the SSH server.
6470
- Always use PKA.
6571
- Disable password login.
6672
- Disable root login.

0 commit comments

Comments
 (0)