Add documentation for the default_property_scope config.php key

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel
2022-05-17 14:53:54 +02:00
parent 939b1118ed
commit 0918817a04

View File

@@ -34,3 +34,58 @@ To disable profile globally add the following line to your ``config.php``
Please refer to :doc:`../configuration_server/config_sample_php_parameters` for
all available ``config.php`` options.
Property scopes
---------------
User properties (Full name, Address, Website, Role, …) have specific visibility scopes (Private, Local, Federated, Published).
The visibility scopes are explained below:
:Private:
Contact details visible locally only
:Local:
Contact details visible locally and through public link access on local instance
:Federated:
Contact details visible locally, through public link access and on trusted federated servers.
:Published:
Contact details visible locally, through public link access, on trusted federated servers and published to the public lookup server.
The default values for each property for each new user is listed below, but you should consult the declaration of the ``DEFAULT_SCOPES`` constant in the ``OC\Accounts\AccountManager`` class (`see the code <https://github.com/nextcloud/server/blob/master/lib/private/Accounts/AccountManager.php>`_) to make sure these are up-to-date.
+--------------+--------------------------+
| Property | Default visibility scope |
+==============+==========================+
| Full name | Federated |
+--------------+--------------------------+
| Address | Local |
+--------------+--------------------------+
| Website | Local |
+--------------+--------------------------+
| Email | Federated |
+--------------+--------------------------+
| Avatar | Federated |
+--------------+--------------------------+
| Phone | Local |
+--------------+--------------------------+
| Twitter | Local |
+--------------+--------------------------+
| Organisation | Local |
+--------------+--------------------------+
| Role | Local |
+--------------+--------------------------+
| Headline | Local |
+--------------+--------------------------+
| Biography | Local |
+--------------+--------------------------+
If you'd like to override the value for one or several default visibility scopes, use the ``account_manager.default_property_scope`` ``config.php`` configuration key, which defaults to an empty array:
.. code-block:: php
'account_manager.default_property_scope' => [
\OCP\Accounts\IAccountManager::PROPERTY_PHONE => \OCP\Accounts\IAccountManager::SCOPE_PRIVATE
\OCP\Accounts\IAccountManager::PROPERTY_ROLE => \OCP\Accounts\IAccountManager::SCOPE_FEDERATED
]
In the above example, the phone and role properties are respectively overritten to the private and federated scopes. Note that these changes will only apply to *new* users, not existing ones.