[Stable20]

admin_manual/configuration_database/linux_database_configuration.rst

@@ -4,8 +4,8 @@ Database configuration
 
 Nextcloud requires a database in which administrative data is stored. The following databases are currently supported:
 
-* `MySQL <http://www.mysql.com/>`_ / `MariaDB <https://mariadb.org/>`_
-* `PostgreSQL <http://www.postgresql.org/>`_
+* `MySQL <https://www.mysql.com/>`_ / `MariaDB <https://mariadb.org/>`_
+* `PostgreSQL <https://www.postgresql.org/>`_
 * `Oracle <http://www.oracle.com/>`_
 
 The MySQL or MariaDB databases are the recommended database engines.
@@ -58,7 +58,7 @@ Your :file:`/etc/mysql/my.cnf` could look like this:
 ::
 
   [server]
-  skip-name-resolve
+  skip_name_resolve = 1
   innodb_buffer_pool_size = 128M
   innodb_buffer_pool_instances = 1
   innodb_flush_log_at_trx_commit = 2
@@ -70,8 +70,8 @@ Your :file:`/etc/mysql/my.cnf` could look like this:
   query_cache_size = 64M
   tmp_table_size= 64M
   max_heap_table_size= 64M
-  slow-query-log = 1
-  slow-query-log-file = /var/log/mysql/slow.log
+  slow_query_log = 1
+  slow_query_log_file = /var/log/mysql/slow.log
   long_query_time = 1
 
   [client-server]
@@ -82,8 +82,8 @@ Your :file:`/etc/mysql/my.cnf` could look like this:
   default-character-set = utf8mb4
 
   [mysqld]
-  character-set-server = utf8mb4
-  collation-server = utf8mb4_general_ci
+  character_set_server = utf8mb4
+  collation_server = utf8mb4_general_ci
   transaction_isolation = READ-COMMITTED
   binlog_format = ROW
   innodb_large_prefix=on
@@ -140,7 +140,7 @@ You can quit the prompt by entering::
 
   quit;
 
-An Nextcloud instance configured with MySQL would contain the hostname on which
+A Nextcloud instance configured with MySQL would contain the hostname on which
 the database is running, a valid username and password to access it, and the
 name of the database. The :file:`config/config.php` as created by the
 :doc:`../installation/installation_wizard` would therefore contain entries like
@@ -161,6 +161,23 @@ In case of UTF8MB4 you will also find::
 
     "mysql.utf8mb4" => true,
 
+SSL for MySQL Database
+^^^^^^^^^^^^^^^^^^^^^^
+
+Enabling SSL is only necessary if your database does not reside on the same server as your Nextcloud instance.
+If you do not connect over localhost and need to allow remote connections then you should enable SSL.
+This just covers the SSL database configuration on the Nextcloud server. First you need to configure your database server accordingly.
+
+::
+
+  'dbdriveroptions' => [
+    \PDO::MYSQL_ATTR_SSL_KEY => '/../ssl-key.pem',
+    \PDO::MYSQL_ATTR_SSL_CERT => '/../ssl-cert.pem',
+    \PDO::MYSQL_ATTR_SSL_CA => '/../ca-cert.pem',
+    \PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => true,
+  ],
+
+Adjust the paths to the pem files for your environment.
 
 PostgreSQL database
 ^^^^^^^^^^^^^^^^^^^

admin_manual/configuration_database/mysql_4byte_support.rst

@@ -9,7 +9,7 @@ Enabling MySQL 4-byte support
 In order to use Emojis (textbased smilies) on your Nextcloud server with a MySQL database, the
 installation needs to be tweaked a bit.
 
-1. Make sure your database is set to use the Barracuda InnoDB file format:
+1. Make sure your database is set to use the Barracuda InnoDB file format (this is only needed on MySQL 5.x and MariaDB < 10.3):
 
    Login to your mysql database and run::
 

admin_manual/configuration_files/big_file_upload_configuration.rst

@@ -14,7 +14,8 @@ hard limits that cannot be exceeded:
 filesystem.
 
 .. note:: The Nextcloud sync client is not affected by these upload limits
-   as it is uploading files in smaller chunks.
+   as it is uploading files in smaller chunks. See `Client documentation <https://docs.nextcloud.com/desktop/3.0/advancedusage.html>`_
+   for more information on configuration options.
 
 System configuration
 --------------------
@@ -75,9 +76,9 @@ Apache with mod_fcgid
 
 nginx
 ^^^^^
-* `client_max_body_size <http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_
-* `fastcgi_read_timeout <http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_read_timeout>`_
-* `client_body_temp_path <http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_temp_path>`_
+* `client_max_body_size <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size>`_
+* `fastcgi_read_timeout <https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_read_timeout>`_
+* `client_body_temp_path <https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_temp_path>`_
 
 Since nginx 1.7.11 a new config option `fastcgi_request_buffering
 <https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html#fastcgi_request_buffering>`_
@@ -95,8 +96,8 @@ If your site is behind a nginx frontend (for example a loadbalancer):
 
 By default, downloads will be limited to 1GB due to ``proxy_buffering`` and ``proxy_max_temp_file_size`` on the frontend.
 
-* If you can access the frontend's configuration, disable `proxy_buffering <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ or increase `proxy_max_temp_file_size <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size>`_ from the default 1GB.
-* If you do not have access to the frontend, set the `X-Accel-Buffering <http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ header to ``add_header X-Accel-Buffering no;`` on your backend server.
+* If you can access the frontend's configuration, disable `proxy_buffering <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ or increase `proxy_max_temp_file_size <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size>`_ from the default 1GB.
+* If you do not have access to the frontend, set the `X-Accel-Buffering <https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering>`_ header to ``add_header X-Accel-Buffering no;`` on your backend server.
 
 Configuring PHP
 ---------------
@@ -138,3 +139,13 @@ the longest upload will take. If unsure remove this completely from your
 configuration to reset it to the default shown in the ``config.sample.php``.
 
 
+Adjust chunk size on Nextcloud side
+-----------------------------------
+
+For upload performance improvements in environments with high upload bandwidth, the server's upload chunk size may be adjusted::
+
+ sudo -u www-data php occ config:app:set files max_chunk_size
+
+Put in a value in bytes or set ``--value 0`` for no chunking at all.
+
+Default is 10485760 (10 MB).

admin_manual/configuration_files/encryption_configuration.rst

@@ -70,8 +70,7 @@ storage.
    termination and the Nextcloud code that encrypts and decrypts files. This is 
    also potentially exploitable by anyone with administrator access to your 
    server. Read `How Nextcloud uses encryption to protect your data 
-   <https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your- 
-   data/>`_ for more information.
+   <https://nextcloud.com/blog/encryption-in-nextcloud/>`_ for more information.
 
 Before enabling encryption
 --------------------------

admin_manual/configuration_files/external_storage/auth_mechanisms.rst

@@ -38,15 +38,18 @@ credentials and therefore cannot perform any background tasks on the storage:
 
 * Sharing is disabled
 * Background file scanning does not work
+* Background versions expiration does not work
 * Desktop and mobile clients that use tokens to authenticate can not access those shares
 * Other services that might request the file through a different request like Collabora Online or OnlyOffice will not be able to open files from that storage
-* The method cannot be used with SAML authentication, because Nextcloud does not get a hold of any credentials whatsoever
+* The method cannot be used with SAML/SSO authentication, because Nextcloud does not get a hold of any credentials whatsoever
 
 The **Log-in credentials, save in database** mechanism uses the Nextcloud login
 credentials of the user to connect to the storage. These are stored in the
 database encrypted with the shared secret. This allows to share files from
 within this mount point.
 
+* The method cannot be used with SAML/SSO authentication, because Nextcloud does not get a hold of any credentials whatsoever
+
 The **User entered, store in database** mechanism work in the same way as the
 "Username and password" mechanism but the credentials need to be specified by
 each user individually. Before the first access to that mount point the user

admin_manual/configuration_files/external_storage/smb.rst

@@ -83,7 +83,7 @@ Decrease sync delay
 ^^^^^^^^^^^^^^^^^^^
 
 Any updates detected by the notify command will only be synced to the client after the Nextcloud cron job has been executed
-(usually every 15 minutes). If this interval is to high for your use case, you can decrease it by running ``occ files:scan --unscanned --all``
+(usually every 15 minutes). If this interval is too high for your use case, you can decrease it by running ``occ files:scan --unscanned --all``
 at the desired interval. Note that this might increase the server load and you'll need to ensure that there is no overlap between runs.
 
 Hidden files upload failure or not shown

admin_manual/configuration_files/external_storage_configuration_gui.rst

@@ -48,6 +48,23 @@ re-check your configuration and network availability.
 If there is an error on the storage, it will be marked as unavailable for ten 
 minutes. To re-check it, click the colored icon or reload your Admin page.
 
+Usage of variables for mount paths
+----------------------------------
+
+The external storage mounting mechanism accepts variables in the mount path.
+
+Use ``$user`` for automatic substitution with the logged in user's username.
+
+Use ``$home`` for automatic substitution with a configurable home directory variable
+(requires LDAP, see :ref:`LDAP_Special_Attributes` in the LDAP configuration documentation for details)
+
+In the following example, the mount point for a logged in user "alice" would substitute 
+to ``/opt/userDirectories/alice/myPictures``.
+
+.. figure:: external_storage/images/externalStorages_variables.png
+   :alt: External storage user variable substitution
+
+
 User and group permissions
 --------------------------
 
@@ -91,7 +108,7 @@ Using self-signed certificates
 When using self-signed certificates for external storage mounts the certificate
 must be imported into the personal settings of the user. Please refer to 
 `Nextcloud HTTPS External Mount 
-<http://ownclouden.blogspot.de/2014/11/owncloud-https-external-mount.html>`_
+<https://ownclouden.blogspot.de/2014/11/owncloud-https-external-mount.html>`_
 for more information.
 
 Available storage backends

admin_manual/configuration_files/file_sharing_configuration.rst

@@ -15,7 +15,16 @@ Configure your sharing policy on your Admin page in the Sharing section.
 * Check ``Set default expiration date for shares`` to set a default expiration date
   on local user and group shares.
 * Check ``Enforce expiration date`` to always enforce the configured expiration date
-  on local user and group shares. Users will not be able to adjust or remove the expiration date.
+  on local user and group shares.
+
+    .. note:: Users will not be able to set the expiration date further
+        in the future than the enforced expiration date, although they 
+        will be able to set a more recent date.
+        Also note that users will be able to update the expiration date again at
+        a later point. The expiration date is based on the current date and not on the share
+        creation date. The user will be able to extend the expiration date again whenever a
+        previous expiration date is close to be reached.
+
 * Check ``Allow users to share via link`` to enable creating public shares for  
   people who are not Nextcloud users via hyperlink.
 * Check ``Allow public uploads`` to allow anyone to upload files to public shares.
@@ -26,7 +35,16 @@ Configure your sharing policy on your Admin page in the Sharing section.
 * Check ``Set default expiration date for link shares`` to set a default expiration date on 
   public shares.
 * Check ``Enforce expiration date`` to always enforce the configured expiration date
-  on public shares. Users will not be able to adjust or remove the expiration date.
+  on public shares. 
+
+    .. note:: Users will not be able to set the expiration date further
+        in the future than the enforced expiration date, although they 
+        will be able to set a more recent date.
+        Also note that users will be able to update the expiration date again at
+        a later point. The expiration date is based on the current date and not on the share
+        creation date. The user will be able to extend the expiration date again whenever a
+        previous expiration date is close to be reached.
+
 * Check ``Allow resharing`` to enable users to re-share files shared with them.
 * Check ``Allow sharing with groups`` to enable users to share with groups.
 * Check ``Restrict users to only share with users in their groups`` to confine 

admin_manual/configuration_files/primary_storage.rst

@@ -154,7 +154,31 @@ The class to be used is :code:`\\OC\\Files\\ObjectStore\\S3`
 Multibucket Object Store
 ------------------------
 
-It's possible to configure Nextcloud to distribute its data over multiple buckets
-for scalability purpose. You can find out more information about upscaling with
-object storage and Nextcloud in the
+It's possible to configure Nextcloud to distribute the data over multiple buckets
+for scalability purposes.
+
+To setup multiple buckets, use :code:`'objectstore_multibucket'` storage backend
+in :code:`config.php`:
+
+::
+
+	'objectstore_multibucket' => [
+		'class' => 'Object\\Storage\\Backend\\Class',
+		'arguments' => [
+			// optional, defaults to 64
+			'num_buckets' => 64,
+			// will be postfixed by an integer in the range from 0 to (num_nuckets-1)
+			'bucket' => 'nextcloud_',
+			...
+		],
+	],
+
+Multibucket object store backend maps every user to a range of buckets and saves
+all files for that user in their corresponding bucket.
+
+.. note:: While it is possible to change the number of buckets used by an existing Nextcloud
+          instance, the user-to-buckets mapping is only created once, so only newly created
+          users will be mapped to the updated range of buckets.
+
+You can find out more information about upscaling with object storage and Nextcloud in the
 `Nextcloud customer portal <https://portal.nextcloud.com/article/object-store-as-primary-storage-16.html>`_.

admin_manual/configuration_server/antivirus_configuration.rst

@@ -5,7 +5,7 @@ Antivirus scanner
 You can configure your Nextcloud server to automatically run a virus scan on
 newly-uploaded files with the Antivirus app for Files. The Antivirus app for
 Files integrates the open source anti-virus engine `ClamAV
-<http://www.clamav.net/index.html>`_  with Nextcloud. ClamAV detects all forms
+<https://www.clamav.net/index.html>`_  with Nextcloud. ClamAV detects all forms
 of malware including Trojan horses, viruses, and worms, and it operates on all
 major file types including Windows, Linux, and Mac files, compressed files,
 executables, image files, Flash, PDF, and many others. ClamAV's Freshclam

admin_manual/configuration_server/background_jobs_configuration.rst

@@ -57,6 +57,8 @@ access your server using the Internet. For example::
 
   URL to call: http[s]://<domain-of-your-server>/nextcloud/cron.php
 
+.. _system-cron-configuration-label:
+
 Cron
 ^^^^
 
@@ -103,25 +105,28 @@ This approach requires two files: **nextcloudcron.service** and **nextcloudcron.
 
   [Unit]
   Description=Nextcloud cron.php job
-  
+
   [Service]
   User=www-data
-  ExecStart=/usr/bin/php -f /var/www/nextcloud/cron.php            
+  ExecStart=/usr/bin/php -f /var/www/nextcloud/cron.php
+  KillMode=process
 
 Replace the user ``www-data`` with the user of your http server and ``/var/www/nextcloud/cron.php`` with the location of **cron.php** in your nextcloud directory.
 
+The ``KillMode=process`` setting is necessary for external programs that are started by the cron job to keep running after the cron job has finished. 
+
 Note that the **.service** unit file does not need an ``[Install]`` section. Please check your setup because we recommended it in earlier versions of this admin manual.
 
 **nextcloudcron.timer** should look like this::
 
   [Unit]
   Description=Run Nextcloud cron.php every 5 minutes
-  
+
   [Timer]
   OnBootSec=5min
   OnUnitActiveSec=5min
   Unit=nextcloudcron.service
-  
+
   [Install]
   WantedBy=timers.target
 

admin_manual/configuration_server/caching_configuration.rst

@@ -27,7 +27,7 @@ of memcache that best fits your needs. The supported caching backends are:
    A local cache for systems.
 * `Redis <http://redis.io/>`_, PHP module 2.2.6 and up required.
    For local and distributed caching as well as transactional file locking.
-* `Memcached <http://www.memcached.org/>`_
+* `Memcached <https://www.memcached.org/>`_
    For distributed caching.
 
 Memcaches must be explicitly configured in Nextcloud by installing
@@ -131,6 +131,23 @@ You might need to restart apache for the changes to take effect::
 Redis is very configurable; consult `the Redis documentation 
 <http://redis.io/documentation>`_ to learn more.
 
+**Using the Redis session handler:** If you are using Redis for locking and/or caching,
+you may also wish to use Redis for session management. Redis can be used for centralized
+session management across multiple Nextcloud application servers, unlike the standard
+`files` handler. If you use the Redis handler, though, you *MUST* ensure that session
+locking is enabled. As of this writing, the Redis session handler does *NOT* enable
+session locking by default, which can lead to session corruption in some Nextcloud apps
+that make heavy use of session writes such as Talk. In addition, even when session locking
+is enabled, if the application fails to acquire a lock, the Redis session handler does not
+currently return an error. Adding the following settings in your `php.ini` file will
+prevent session corruption when using Redis as your session handler: ::
+
+  redis.session.locking_enabled=1
+  redis.session.lock_retries=-1
+  redis.session.lock_wait_time=10000
+
+More information on configuration of phpredis session handler can be found on the
+`PhpRedis GitHub page <https://github.com/phpredis/phpredis>`_
 
 Memcached
 ---------