Skip to content

Commit d14d770

Browse files
joshtrichardsbackportbot[bot]
authored andcommitted
refactor(admin): 2FA chapter clean-up
- Document the three bundled (shipped) 2FA providers. - Clarify what "providers" are and why they're important. - Re-order the sections. - Remove some outdated bits. - Eliminate some redundancies. - Misc tidying up. Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent edcffd4 commit d14d770

File tree

1 file changed

+28
-25
lines changed

1 file changed

+28
-25
lines changed

admin_manual/configuration_user/two_factor-auth.rst

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ Two-factor authentication
55
=========================
66

77
Two-factor authentication adds an additional layer of security to user accounts. In order to log
8-
in on an account with two-factor authentication (2FA) enabled, it is necessary to provide both the
9-
login password and another factor. 2FA in Nextcloud is pluggable, meaning that they are not part
10-
of the Nextcloud Server component but provided by featured and 3rd-party Nextcloud apps.
8+
in on an account when two-factor authentication (2FA) enabled, it is necessary to provide both the
9+
login password and another factor.
1110

11+
To use 2FA two things must happen:
1212

13-
Several 2FA apps are already available including
14-
`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm>`_,
15-
a Telegram/Signal/SMS gateway and `U2F <https://en.wikipedia.org/wiki/Universal_2nd_Factor>`_.
13+
- At least one 2FA provider must be enabled by the administrator.
14+
- A user must activate 2FA on their account (or) the administrator must enforce the use of 2FA.
1615

1716

1817
Developers can `build new two-factor provider apps <https://docs.nextcloud.com/server/31/developer_manual/digging_deeper/two-factor-provider.html>`_.
@@ -22,40 +21,33 @@ Developers can `build new two-factor provider apps <https://docs.nextcloud.com/s
2221
Enabling two-factor authentication
2322
----------------------------------
2423

25-
You can enable 2FA by installing and enabling a 2FA app like TOTP which works
26-
with Google Authenticator and compatible apps. The apps are available in the
27-
Nextcloud App store so by navigating there and clicking **enable** for the app
28-
you want, 2FA will be installed and enabled on your Nextcloud server.
24+
2FA in Nextcloud is pluggable, meaning that various 2FA providers can be used to support different
25+
types of factors. Three providers are automatically installed (but may need to be enabled):
2926

30-
.. figure:: ../images/2fa-app-install.png
27+
**Two-Factor TOTP Provider**
3128

3229
Once 2FA has been enabled, users have to `activate it in their personal settings. <https://docs.nextcloud.com/server/31/user_manual/en/user_2fa.html>`_
3330

3431
.. TODO ON RELEASE: Update version number above on release
3532
36-
Disabling two-factor authentication
37-
-----------------------------------
38-
39-
Two-factor providers can be disabled via :ref:`occ <occ>`::
40-
41-
sudo -u www-data php occ twofactorauth:disable <uid> <provider_id>
33+
.. figure:: ../images/2fa-app-install.png
4234

43-
User are free to enable this provider again via their personal settings.
35+
Developers can also `implement new two-factor provider
36+
apps <https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/two-factor-provider.html>`_.
4437

45-
.. note:: This operation has to be supported by the provider. If this support is missing, Nextcloud will abort and show an error.
38+
.. TODO ON RELEASE: Update version number above on release
4639
4740
Enforcing two-factor authentication
4841
-----------------------------------
4942

5043
By default 2FA is *optional*, hence users are given the choice whether to enable
51-
it for their account. Admins may enforce the use of 2FA.
52-
44+
it for their account `under their personal settings <https://docs.nextcloud.com/server/latest/user_manual/en/user_2fa.html>`_.
45+
Admins may, however, enforce the use of 2FA.
5346

54-
Enforcement is possible system-wide (all users), for selected groups only and can
55-
also be excluded for certain groups.
47+
Enforcement is possible system-wide (all users) or for selected groups only. Select groups
48+
can also be excluded from 2FA requirements.
5649

57-
58-
These settings can be found in the administrator's security settings.
50+
These settings can be found under *Administration Settings->Security*.
5951

6052
.. figure:: ../images/2fa-admin-settings.png
6153

@@ -76,3 +68,14 @@ The associations of removed providers can be cleaned up via :ref:`occ <occ>`::
7668
sudo -u www-data php occ twofactorauth:cleanup <provider_id>
7769

7870
.. warning:: This operation is irreversible. Only run it for providers you do not intend to enable again.
71+
72+
Disabling two-factor authentication
73+
-----------------------------------
74+
75+
Two-factor providers can be disabled via :ref:`occ <occ>`::
76+
77+
sudo -u www-data php occ twofactorauth:disable <uid> <provider_id>
78+
79+
User are free to enable this provider again via their personal settings.
80+
81+
.. note:: This operation has to be supported by the provider. If this support is missing, Nextcloud will abort and show an error.

0 commit comments

Comments
 (0)