diff --git a/admin_manual/configuration_files/collaborative_documents_configuration.rst b/admin_manual/configuration_files/collaborative_documents_configuration.rst deleted file mode 100644 index a1db237b8..000000000 --- a/admin_manual/configuration_files/collaborative_documents_configuration.rst +++ /dev/null @@ -1,51 +0,0 @@ -Configuring the Collaborative Documents App -=========================================== - -The Documents application supports editing documents within Nextcloud, without the -need to launch an external application. The Documents app supports these -features: - -* Cooperative edit, with multiple users editing files simultaneously. -* Document creation within Nextcloud. -* Document upload. -* Share and edit files in the browser, and then share them inside Nextcloud or - through a public link. - -Supported file formats are `.odt`, `.doc`, and `.docx`. `.odt` is supported -natively in Nextcloud, and you must have LibreOffice or OpenOffice installed on -the Nextcloud server to convert `.doc`, and `.docx` documents. - -Enabling the Documents App --------------------------- - -Go to your Apps page and click the ``Enable`` button. You also have the option -to grant access to the Documents apps to selected user groups. By default it is -available to all groups. - -.. image:: ../images/documents_app_enable.png - -See "Collaborative Document Editing" in the User manual to learn how to create -and share documents in the Documents application. - -Enabling and testing MS Word support ------------------------------------- - -Go to your admin settings menu. After choosing ``Local`` or ``External`` click -on the ``Apply and test`` button. If you have a working LibreOffice or OpenOffice -installation a green ``Saved`` icon should appear. - -.. image:: ../images/documents_apply_test.png - -Troubleshooting -~~~~~~~~~~~~~~~ - -If the mentioned test fails please make sure that: - -* the PHP functions ``escapeshellarg`` and ``shell_exec`` are not disabled in your - PHP configuration -* the libreoffice/openoffice binary is within your PATH and is executeable for the - HTTP user -* your SELinux configuration is not blocking the execution of the binary -* the PHP ``open_basedir`` is correctly configured to allow the access to the binary - -More hints why the test is failing can be found in your ``data/nextcloud.log``. diff --git a/admin_manual/configuration_files/files_locking_transactional.rst b/admin_manual/configuration_files/files_locking_transactional.rst index 515cbcdd4..ab5d00d44 100644 --- a/admin_manual/configuration_files/files_locking_transactional.rst +++ b/admin_manual/configuration_files/files_locking_transactional.rst @@ -2,36 +2,34 @@ Transactional File Locking ========================== -Nextcloud's Transactional File Locking mechanism locks files to avoid +Nextcloud's Transactional File Locking mechanism locks files to avoid file corruption during normal operation. It performs these functions: -* Operates at a higher level than the filesystem, so you don't need to use a +* Operates at a higher level than the filesystem, so you don't need to use a filesystem that supports locking -* Locks parent directories so they cannot be renamed during any activity on +* Locks parent directories so they cannot be renamed during any activity on files inside the directories -* Releases locks after file transactions are interrupted, for +* Releases locks after file transactions are interrupted, for example when a sync client loses the connection during an upload -* Manages locking and releasing locks correctly on shared files during changes +* Manages locking and releasing locks correctly on shared files during changes from multiple users * Manages locks correctly on external storage mounts * Manages encrypted files correctly -What Transactional File locking is not for: it is not for preventing collisions -in collaborative document editing (see -:doc:`collaborative_documents_configuration` to learn about collaboration with -the Documents app), nor will it prevent multiple users from editing the same -document, or give notice that other users are working on the same document. -Multiple users can open and edit a file at the same time and Transactional File -locking does not prevent this. Rather, it prevents simultaneous file saving. - -File locking is enabled by default, using the database locking backend. This -places a significant load on your database. Using ``memcache.locking`` relieves -the database load and improves performance. Admins of Nextcloud servers with -heavy workloads should install a memcache. (See -:doc:`../configuration_server/caching_configuration`.) +What Transactional File locking is not for: it will not prevent multiple users +from editing the same document, or give notice that other users are working on +the same document. Multiple users can open and edit a file at the same time and +Transactional File locking does not prevent this. Rather, it prevents +simultaneous file saving. -To use a memcache with Transactional File Locking, you must install the Redis -server and corresponding PHP module. After installing Redis you must enter a +File locking is enabled by default, using the database locking backend. This +places a significant load on your database. Using ``memcache.locking`` relieves +the database load and improves performance. Admins of Nextcloud servers with +heavy workloads should install a memcache. (See +:doc:`../configuration_server/caching_configuration`.) + +To use a memcache with Transactional File Locking, you must install the Redis +server and corresponding PHP module. After installing Redis you must enter a configuration in your ``config.php`` file like this example:: 'filelocking.enabled' => true, @@ -57,20 +55,20 @@ recommended if Redis is running on the same system as Nextcloud) use this exampl 'port' => 0, 'timeout' => 0.0, ), - -See ``config.sample.php`` to see configuration examples for Redis, and for all + +See ``config.sample.php`` to see configuration examples for Redis, and for all supported memcaches. -If you are on Ubuntu you can follow `this guide -`_ for a complete installation from scratch. +If you are on Ubuntu you can follow `this guide +`_ for a complete installation from scratch. -Learn more about Reds at `Redis `_. Memcached, the popular -distributed memory caching system, is not suitable for the new file locking -because it is not designed to store locks, and data can disappear from the cache -at any time. Redis is a key-value store, and it guarantees that cached objects +Learn more about Reds at `Redis `_. Memcached, the popular +distributed memory caching system, is not suitable for the new file locking +because it is not designed to store locks, and data can disappear from the cache +at any time. Redis is a key-value store, and it guarantees that cached objects are available for as long as they are needed. -Debian Jesse users, please see this `Github discussion -`_ if you have problems with +Debian Jesse users, please see this `Github discussion +`_ if you have problems with LDAP authentication. diff --git a/admin_manual/configuration_files/index.rst b/admin_manual/configuration_files/index.rst index 4070516e9..1e4612f09 100644 --- a/admin_manual/configuration_files/index.rst +++ b/admin_manual/configuration_files/index.rst @@ -9,7 +9,6 @@ File Sharing and Management file_sharing_configuration federated_cloud_sharing_configuration big_file_upload_configuration - collaborative_documents_configuration default_files_configuration external_storage_configuration_gui external_storage_configuration diff --git a/admin_manual/configuration_files/primary_storage.rst b/admin_manual/configuration_files/primary_storage.rst index 0fa2ca738..fd641ad65 100644 --- a/admin_manual/configuration_files/primary_storage.rst +++ b/admin_manual/configuration_files/primary_storage.rst @@ -43,9 +43,9 @@ The configuration has the following structure. ), ), -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~ Openstack Swift -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~ The Swift backend mounts a container on an OpenStack Object Storage server into the virtual filesystem. The class to be used is :code:`\\OC\\Files\\ObjectStore\\Swift` @@ -70,9 +70,9 @@ The Swift backend mounts a container on an OpenStack Object Storage server into ), ), --------- +--------- Amazon S3 --------- +--------- The S3 backend mounts a bucket on an Amazon S3 Storage or compatible server into the virtual filesystem. The class to be used is :code:`\\OC\\Files\\ObjectStore\\S3` diff --git a/admin_manual/configuration_server/config_sample_php_parameters.rst b/admin_manual/configuration_server/config_sample_php_parameters.rst index 98f4f40a0..add0c0392 100644 --- a/admin_manual/configuration_server/config_sample_php_parameters.rst +++ b/admin_manual/configuration_server/config_sample_php_parameters.rst @@ -17,11 +17,11 @@ Nextcloud supports loading configuration parameters from multiple files. You can add arbitrary files ending with :file:`.config.php` in the :file:`config/` directory, for example you could place your email server configuration in :file:`email.config.php`. This allows you to easily create and manage -custom configurations, or to divide a large complex configuration file -into a set of smaller files. These custom files are not overwritten by +custom configurations, or to divide a large complex configuration file +into a set of smaller files. These custom files are not overwritten by Nextcloud, and the values in these files take precedence over :file:`config.php`. -.. The following section is auto-generated from +.. The following section is auto-generated from .. https://github.com/nextcloud/server/blob/master/config/config.sample.php .. Do not edit this file; edit the source file in core .. DEFAULT_SECTION_START @@ -647,7 +647,7 @@ The channel that Nextcloud should use to look for updates Supported values: - ``daily`` - - ``beta` + - ``beta`` - ``stable`` - ``production`` @@ -965,10 +965,6 @@ concerns: - OC\\Preview\\TIFF - OC\\Preview\\Font -.. note:: Troubleshooting steps for the MS Word previews are available - at the :doc:`../configuration_files/collaborative_documents_configuration` - section of the Administrators Manual. - The following providers are not available in Microsoft Windows: - OC\\Preview\\Movie @@ -1133,16 +1129,16 @@ Server details for one or more memcached servers to use for memory caching. \Memcached::OPT_SEND_TIMEOUT => 50, \Memcached::OPT_RECV_TIMEOUT => 50, \Memcached::OPT_POLL_TIMEOUT => 50, - + // Enable compression \Memcached::OPT_COMPRESSION => true, - + // Turn on consistent hashing \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, - + // Enable Binary Protocol \Memcached::OPT_BINARY_PROTOCOL => true, - + // Binary serializer vill be enabled if the igbinary PECL module is available //\Memcached::OPT_SERIALIZER => \Memcached::SERIALIZER_IGBINARY, ), diff --git a/admin_manual/configuration_server/sso_configuration.rst b/admin_manual/configuration_server/sso_configuration.rst index 5d38e5bd4..1a31f2d2e 100644 --- a/admin_manual/configuration_server/sso_configuration.rst +++ b/admin_manual/configuration_server/sso_configuration.rst @@ -23,7 +23,8 @@ Enabling the SSO & SAML app --------------------------- .. warning:: Make sure to configure an administrative user that can access the instance via SSO. Logging-in with your -regular Nextcloud account won't be possible anymore. + regular Nextcloud account won't be possible anymore. + The "SSO & SAML" App is shipped and disabled by default. To enable the app enabled simply go to your Nextcloud Apps page to enable it. It can then be found in the "SSO & SAML authentication" section of your Nextcloud. @@ -48,7 +49,7 @@ variable. (e.g. `REMOTE_USER` for Kerberos) Once done you also need to protect the login route properly. On an Apache server with mod_auth_kerb the following configuration would protect the login route: -.. code-block:: httpd +.. code-block:: apache AuthType Kerberos @@ -65,4 +66,4 @@ would protect the login route: .. warning:: If this authentication approach is used clients do require an application specific password for authentication. -A better integration into our desktop and mobile clients is considered for the future though. \ No newline at end of file + A better integration into our desktop and mobile clients is considered for the future though. \ No newline at end of file diff --git a/admin_manual/configuration_user/user_auth_ldap.rst b/admin_manual/configuration_user/user_auth_ldap.rst index b30d53e07..89236604d 100644 --- a/admin_manual/configuration_user/user_auth_ldap.rst +++ b/admin_manual/configuration_user/user_auth_ldap.rst @@ -530,9 +530,6 @@ If you have trouble with certificate validation make sure that * You have the certificate of the server installed on the Nextcloud server * The certificate is announced in the system's LDAP configuration file (usually */etc/ldap/ldap.conf*) -.. commenting out windows section as windows server is not supported -.. *C:\\openldap\\sysconf\\ldap.conf* or -.. *C:\\ldap.conf* on Windows) using a **TLS_CACERT /path/to/cert** line. * Using LDAPS, also make sure that the port is correctly configured (by default 636) diff --git a/admin_manual/configuration_user/user_provisioning_api.rst b/admin_manual/configuration_user/user_provisioning_api.rst index c8b4bdac6..6048f613a 100644 --- a/admin_manual/configuration_user/user_provisioning_api.rst +++ b/admin_manual/configuration_user/user_provisioning_api.rst @@ -183,7 +183,7 @@ XML Output **users / disableuser** ----------------------- +----------------------- Disables a user on the Nextcloud server so that the user cannot login anymore. Authentication is done by sending a Basic HTTP Authorization header. diff --git a/admin_manual/images/documents_app_enable.png b/admin_manual/images/documents_app_enable.png deleted file mode 100644 index 96dabf1e3..000000000 Binary files a/admin_manual/images/documents_app_enable.png and /dev/null differ diff --git a/admin_manual/images/documents_apply_test.png b/admin_manual/images/documents_apply_test.png deleted file mode 100644 index 64d8a89aa..000000000 Binary files a/admin_manual/images/documents_apply_test.png and /dev/null differ diff --git a/admin_manual/installation/nginx_examples.rst b/admin_manual/installation/nginx_examples.rst index fc07e9ec5..2dfc9cbd9 100644 --- a/admin_manual/installation/nginx_examples.rst +++ b/admin_manual/installation/nginx_examples.rst @@ -43,7 +43,9 @@ Suppressing Log Messages If you're seeing meaningless messages in your logfile, for example `client denied by server configuration: /var/www/data/htaccesstest.txt `_, add this section to -your nginx configuration to suppress them:: +your nginx configuration to suppress them: + +.. code-block:: nginx location = /data/htaccesstest.txt { allow all; @@ -58,11 +60,15 @@ A common issue with custom nginx configs is that JavaScript (.js) or CSS (.css) files are not served properly leading to a 404 (File not found) error on those files and a broken webinterface. -This could be caused by the:: +This could be caused by the: + +.. code-block:: nginx location ~* \.(?:css|js)$ { -block shown above not located **below** the:: +block shown above not located **below** the: + +.. code-block:: nginx location ~ \.php(?:$|/) { @@ -72,23 +78,21 @@ or CSS (.css) files via gzip could also cause such issues. Performance Tuning ================== -`nginx (<1.9.5) `_ -`nginx (+1.9.5) `_ +* `nginx (<1.9.5) `_ +* `nginx (+1.9.5) `_ To use http_v2 for nginx you have to check two things: - 1.) be aware that this module is not built in by default due to a dependency - to the openssl version used on your system. It will be enabled with the - ``--with-http_v2_module`` configuration parameter during compilation. The - dependency should be checked automatically. You can check the presence of - http_v2 with ``nginx -V 2>&1 | grep http_v2 -o``. An example of how to - compile nginx can be found in section "Configure nginx with the - ``nginx-cache-purge`` module" below. +1.) be aware that this module is not built in by default due to a dependency +to the openssl version used on your system. It will be enabled with the +``--with-http_v2_module`` configuration parameter during compilation. The +dependency should be checked automatically. You can check the presence of +http_v2 with ``nginx -V 2>&1 | grep http_v2 -o``. An example of how to +compile nginx can be found in section "Configure nginx with the +``nginx-cache-purge`` module" below. - 2.) When you have used SPDY before, the nginx config has to be changed from - ``listen 443 ssl spdy;`` to ``listen 443 ssl http2;`` +2.) When you have used SPDY before, the nginx config has to be changed from +``listen 443 ssl spdy;`` to ``listen 443 ssl http2;`` nginx: caching Nextcloud gallery thumbnails =========================================== @@ -247,7 +251,9 @@ Configure nginx with the ``nginx-cache-purge`` module sudo vi /etc/nginx/sites-enabled/{your-nextcloud-nginx-config-file} -Add at the *beginning*, but *outside* the ``server{}`` block:: +Add at the *beginning*, but *outside* the ``server{}`` block: + +.. code-block:: nginx # cache_purge fastcgi_cache_path {path} levels=1:2 keys_zone=NEXTCLOUD:100m inactive=60m; @@ -261,15 +267,18 @@ Add at the *beginning*, but *outside* the ``server{}`` block:: .. note:: Please adopt or delete any regex line in the ``map`` block according your needs and the Nextcloud version used. As an alternative to mapping, you can use as many ``if`` statements in - your server block as necessary:: + your server block as necessary: + + .. code-block:: nginx set $skip_cache 1; if ($request_uri ~* "thumbnail.php") { set $skip_cache 0; } if ($request_uri ~* "/apps/galleryplus/") { set $skip_cache 0; } if ($request_uri ~* "/apps/gallery/") { set $skip_cache 0; } -Add *inside* the ``server{}`` block, as an example of a configuration:: - +Add *inside* the ``server{}`` block, as an example of a configuration: + +.. code-block:: nginx # cache_purge (with $http_cookies we have unique keys for the user) fastcgi_cache_key $http_cookie$request_method$host$request_uri; @@ -296,13 +305,15 @@ Add *inside* the ``server{}`` block, as an example of a configuration:: .. note:: Note regarding the ``fastcgi_pass`` parameter: Use whatever fits your configuration. In the example above, an ``upstream`` was defined in an nginx global configuration file. - This may look like:: + This may look like: + + .. code-block:: nginx - upstream php-handler { - server unix:/var/run/php5-fpm.sock; - # or - # server 127.0.0.1:9000; - } + upstream php-handler { + server unix:/var/run/php5-fpm.sock; + # or + # server 127.0.0.1:9000; + } 3. **Test the configuration** diff --git a/admin_manual/installation/nginx_nextcloud_9x.rst b/admin_manual/installation/nginx_nextcloud_9x.rst index 7f7b0fce3..6ef977403 100644 --- a/admin_manual/installation/nginx_nextcloud_9x.rst +++ b/admin_manual/installation/nginx_nextcloud_9x.rst @@ -1,6 +1,6 @@ -================================================== -Nginx Configuration for the Nextcloud 9.x Branches -================================================== +=================== +Nginx Configuration +=================== The following configuration should be used when Nextcloud is placed in the webroot of your Nginx installation. Be careful about line breaks if you copy @@ -18,7 +18,7 @@ Nextcloud in the webroot of nginx The following config should be used when Nextcloud is placed in the webroot of your nginx installation. -:: +.. code-block:: nginx upstream php-handler { server 127.0.0.1:9000; @@ -151,7 +151,7 @@ Nextcloud in a subdir of nginx The following config should be used when Nextcloud is placed within a subdir of your nginx installation. -:: +.. code-block:: nginx upstream php-handler { server 127.0.0.1:9000; diff --git a/user_manual/contents.rst b/user_manual/contents.rst index 86816961c..e8f2e2306 100644 --- a/user_manual/contents.rst +++ b/user_manual/contents.rst @@ -12,7 +12,6 @@ Table of Contents webinterface files/index pim/index - documents userpreferences user_2fa session_management diff --git a/user_manual/documents.rst b/user_manual/documents.rst deleted file mode 100644 index 96fbcc93a..000000000 --- a/user_manual/documents.rst +++ /dev/null @@ -1,75 +0,0 @@ -Collaborative Document Editing -============================== - -The Documents application supports editing documents within Nextcloud, without -the need to launch an external application. The Documents app supports these -features: - -* Cooperative edit, with multiple users editing files simultaneously. -* Document creation within Nextcloud. -* Document upload. -* Share and edit files in the browser, and then share them inside Nextcloud or - through a public link. - -Supported file formats are `.odt`, `.doc`, and `.docx`. - -The main interface ------------------- - -.. image:: images/oc_documents.png - -Create or Upload a Document -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In the Documents application, you can upload an existing document or create a -new one. The *New document* button creates a document named "New -document.odt". The extension ODT is an OpenDocument format, which is supported -by most word processors including Microsoft Word, LibreOffice Writer, and -OpenOffice Writer. - -Edit a Document -~~~~~~~~~~~~~~~ - -To edit a document, access the Documents app from your Apps menu at the top -left of your Nextcloud window. - -.. image:: images/oc_documents_edit.png - -#. Click on the file name to change it. -#. Share your document (See the :ref:`Share a document - ` section.) -#. Formatting toolbar. -#. Zoom in/out -#. Close and save. -#. Users currently editing this document. - -Collaboratively Editing a Document -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To edit a file collaboratively, it must be shared with everyone who needs -editing permissions. Multiple users can edit it at the same time, and changes -appear as they are made. The cursor of each user is the same color as the -border color of their user picture. - -If a user is not a local user (e.g accessing the file using public link), they -will be shown as guest in the user list, automatically named Guest 1, Guest 2, -and so on. Guests can change their nicknames at any time by clicking on their -names or thumbnails in the user list. - -Delete a Document -~~~~~~~~~~~~~~~~~ - -You can't delete a document from inside the Document app, but must go to your -Files page and delete it from there. You'll find it in your default documents -directory, which is configured on your Nextcloud Personal page (see -:doc:`userpreferences`.) - -.. _share-a-document: - -Share a Document -~~~~~~~~~~~~~~~~ - -Document sharing has the same options as when sharing other files. While editing -a document, you can use the *Share* button to enable other users to edit the -document. This button will display all available options to share. - diff --git a/user_manual/images/oc_documents.png b/user_manual/images/oc_documents.png deleted file mode 100644 index 90b7dfb83..000000000 Binary files a/user_manual/images/oc_documents.png and /dev/null differ diff --git a/user_manual/images/oc_documents_edit.odg b/user_manual/images/oc_documents_edit.odg deleted file mode 100644 index b684f5ea8..000000000 Binary files a/user_manual/images/oc_documents_edit.odg and /dev/null differ diff --git a/user_manual/images/oc_documents_edit.png b/user_manual/images/oc_documents_edit.png deleted file mode 100644 index 1d4755a2d..000000000 Binary files a/user_manual/images/oc_documents_edit.png and /dev/null differ