diff --git a/admin_manual/configuration_files/previews_configuration.rst b/admin_manual/configuration_files/previews_configuration.rst index 0cb74a579..3722828bf 100644 --- a/admin_manual/configuration_files/previews_configuration.rst +++ b/admin_manual/configuration_files/previews_configuration.rst @@ -16,7 +16,7 @@ By default, Nextcloud can generate previews for the following filetypes: * Cover of MP3 files * Text documents -.. note:: Older versions of Nextcloud also supported the preview generation +.. note:: Technically Nextcloud can also generate the previews of other file types such as PDF, SVG or various office documents. Due to security concerns those providers have been disabled by default and are considered unsupported. diff --git a/admin_manual/configuration_server/caching_configuration.rst b/admin_manual/configuration_server/caching_configuration.rst index c613bbc89..9d674c990 100644 --- a/admin_manual/configuration_server/caching_configuration.rst +++ b/admin_manual/configuration_server/caching_configuration.rst @@ -39,7 +39,7 @@ of memcache that best fits your needs. The supported caching backends are: * `Redis `_, PHP module 2.2.5 and up required. For distributed caching. -Memcaches must be explicitly configured in Nextcloud 8.1 and up by installing +Memcaches must be explicitly configured in Nextcloud by installing and enabling your desired cache, and then adding the appropriate entry to ``config.php`` (See :doc:`config_sample_php_parameters` for an overview of all possible config parameters). diff --git a/admin_manual/configuration_server/email_configuration.rst b/admin_manual/configuration_server/email_configuration.rst index a7908e475..05b2daa5b 100644 --- a/admin_manual/configuration_server/email_configuration.rst +++ b/admin_manual/configuration_server/email_configuration.rst @@ -54,7 +54,7 @@ configured on your Personal page. The test message says:: -- Nextcloud - web services under your control + a safe home for all your data Configuring PHP and Sendmail ---------------------------- diff --git a/admin_manual/configuration_server/harden_server.rst b/admin_manual/configuration_server/harden_server.rst index 624f2abe3..f03015dcf 100644 --- a/admin_manual/configuration_server/harden_server.rst +++ b/admin_manual/configuration_server/harden_server.rst @@ -27,7 +27,7 @@ Operating system .. _dev-urandom-label: Give PHP read access to ``/dev/urandom`` -***************************************** +**************************************** Nextcloud uses a `RFC 4086 ("Randomness Requirements for Security")`_ compliant mixer to generate cryptographically secure pseudo-random numbers. This means @@ -137,9 +137,8 @@ available SSL ciphers and options depend completely on your environment and thus giving a generic recommendation is not really possible. We recommend using the `Mozilla SSL Configuration Generator`_ to generate a -suitable configuration suited for your environment, and the free `Qualys -SSL Labs Tests`_ gives good guidance on whether your SSL server is correctly -configured. +suitable configuration suited for your environment, and the free `Qualys SSL Labs Tests`_ +gives good guidance on whether your SSL server is correctly configured. Also ensure that HTTP compression is disabled to mitigate the BREACH attack. diff --git a/admin_manual/configuration_server/occ_command.rst b/admin_manual/configuration_server/occ_command.rst index 403d97e17..521f3b52a 100644 --- a/admin_manual/configuration_server/occ_command.rst +++ b/admin_manual/configuration_server/occ_command.rst @@ -2,7 +2,8 @@ Using the occ Command ===================== -Nextcloud's ``occ`` command (Nextcloud console) is Nextcloud's command-line + +Nextcloud's ``occ`` command (origins from "ownCloud Console") is Nextcloud's command-line interface. You can perform many common server operations with ``occ``, such as installing and upgrading Nextcloud, manage users, encryption, passwords, LDAP setting, and more. @@ -10,9 +11,7 @@ setting, and more. ``occ`` is in the :file:`nextcloud/` directory; for example :file:`/var/www/nextcloud` on Ubuntu Linux. ``occ`` is a PHP script. **You must run it as your HTTP user** to ensure that the correct permissions are maintained -on your Nextcloud files and directories. In Nextcloud 8.2+ you may run it from -any directory (specifying the filepath); in previous releases it had to be -run from the :file:`nextcloud/` directory. +on your Nextcloud files and directories. occ Command Directory --------------------- @@ -165,7 +164,6 @@ The ``app`` commands list, enable, and disable apps:: app:disable disable an app app:enable enable an app app:getpath Get an absolute path to the app directory - (added in 9.0) app:list List all available apps List all of your installed apps, and show whether they are @@ -417,7 +415,7 @@ Run this command to migrate calendars:: sudo -u www-data php occ dav:migrate-calendars [user] -See `Nextcloud 9.0 - calendar migration analysis +See `ownCloud 9.0 - calendar migration analysis `_ for help with troubleshooting and reporting problems. @@ -559,14 +557,13 @@ Synchronize the addressbooks of all federated Nextcloud servers:: federation:sync-addressbooks Synchronizes addressbooks of all federated clouds -In Nextcloud 9.+, servers connected with federation shares can share user + +In Nextcloud, servers connected with federation shares can share user address books, and auto-complete usernames in share dialogs. Use this command to synchronize federated servers:: sudo -u www-data php occ federation:sync-addressbooks -Added in 9.0. - .. _file_operations_label: File Operations @@ -578,7 +575,7 @@ File Operations files:cleanup cleanup filecache files:scan rescan filesystem files:transfer-ownership All files and folders are moved to another - user - shares are moved as well. (Added in 9.0) + user - shares are moved as well. The ``files:scan`` command scans for new files and updates the file cache. You may rescan all files, per-user, a space-delimited list of users, and limit the @@ -637,9 +634,6 @@ before removing a user:: Files External -------------- -These commands replace the ``data/mount.json`` configuration file used in -Nextcloud releases before 9.0. - .. note:: These commands are only available when the "External storage support" app (``files_external``) is enabled. @@ -668,14 +662,12 @@ Nextcloud user. Use ``files_external:import [filename]`` to import legacy JSON configurations, and to copy external mount configurations to another Nextcloud server. -Added in 9.0. - .. _integrity_check_label: Integrity Check --------------- -Apps which have an official tag MUST be code signed starting with Nextcloud 9.0. Unsigned official apps won't be installable anymore. Code signing is optional for all third-party applications:: +Apps which have an official tag MUST be code signed with Nextcloud. Unsigned official apps won't be installable anymore. Code signing is optional for all third-party applications:: integrity integrity:check-app Check app integrity using a signature. @@ -698,15 +690,13 @@ When it returns nothing, your app is signed correctly. When it returns a message See :doc:`../issues/code_signing` to learn more. -Added in 9.0. - .. _create_javascript_translation_files_label: l10n, Create Javascript Translation Files for Apps -------------------------------------------------- This command is for app developers to update their translation mechanism from -Nextcloud 7 to Nextcloud 8 and later. +ownCloud 7 to Nextcloud. .. _ldap_commands_label: diff --git a/admin_manual/configuration_server/security_setup_warnings.rst b/admin_manual/configuration_server/security_setup_warnings.rst index da8a3b33d..ea77100d1 100644 --- a/admin_manual/configuration_server/security_setup_warnings.rst +++ b/admin_manual/configuration_server/security_setup_warnings.rst @@ -116,3 +116,11 @@ Some files have not passed the integrity check ---------------------------------------------- Please refer to the :ref:`code_signing_fix_warning_label` documentation how to debug this issue. + +Your database does not run with "READ COMMITED" transaction isolation level +--------------------------------------------------------------------------- + +"Your database does not run with "READ COMMITED" transaction isolation level. +This can cause problems when multiple actions are executed in parallel." + +Please refer to :ref:`db-transaction-label` how to configure your database for this requirement. diff --git a/admin_manual/configuration_user/user_auth_ldap.rst b/admin_manual/configuration_user/user_auth_ldap.rst index ab172de13..6d33a497f 100644 --- a/admin_manual/configuration_user/user_auth_ldap.rst +++ b/admin_manual/configuration_user/user_auth_ldap.rst @@ -11,7 +11,7 @@ user. .. note:: The PHP LDAP module is required; this is supplied by ``php5-ldap`` on Debian/Ubuntu, and ``php-ldap`` on CentOS/Red Hat/Fedora. PHP 5.4+ is - required in Nextcloud 8.1. + required in Nextcloud. The LDAP application supports: @@ -411,9 +411,9 @@ User Home Folder Naming Rule: * Example: *cn* -In new Nextcloud installations (8.0.10, 8.1.5, 8.2.0 and up) the home folder rule is enforced. This means that once you set a home folder naming rule (get a home folder from an LDAP attribute), it must be available for all users. If it isn't available for a user, then that user will not be able to login. Also, the filesystem will not be set up for that user, so their file shares will not be available to other users. +In new Nextcloud installations the home folder rule is enforced. This means that once you set a home folder naming rule (get a home folder from an LDAP attribute), it must be available for all users. If it isn't available for a user, then that user will not be able to login. Also, the filesystem will not be set up for that user, so their file shares will not be available to other users. -In existing Nextcloud installations the old behavior still applies, which is using the Nextcloud username as the home folder when an LDAP attribute is not set. You may change this to enforcing the home folder rule with the ``occ`` command in Nextcloud 8.2, like this example on Ubuntu:: +In migrated Nextcloud installations the old behavior still applies, which is using the Nextcloud username as the home folder when an LDAP attribute is not set. You may change this to enforcing the home folder rule with the ``occ`` command in Nextcloud, like this example on Ubuntu:: sudo -u www-data php occ config:app:set user_ldap enforce_home_folder_naming_rule --value=1 @@ -598,8 +598,8 @@ testing, you can empty the tables any time. Do not do this in production. Caching ^^^^^^^ -The LDAP cache has changed in Nextcloud 8.1. There is no more file cache, but -only a memory cache, and you must install and configure the memory cache (see +The LDAP information is cached in Nextcloud memory cache, and you must install +and configure the memory cache (see :doc:`../configuration_server/caching_configuration`). The Nextcloud **Cache** helps to speed up user interactions and sharing. It is populated on demand, and remains populated until the **Cache Time-To-Live** for each unique request diff --git a/admin_manual/configuration_user/user_auth_ldap_cleanup.rst b/admin_manual/configuration_user/user_auth_ldap_cleanup.rst index 6aa259622..856ec11c6 100644 --- a/admin_manual/configuration_user/user_auth_ldap_cleanup.rst +++ b/admin_manual/configuration_user/user_auth_ldap_cleanup.rst @@ -51,7 +51,7 @@ This example shows what the table of users marked as ``deleted`` looks like:: $ sudo -u www-data php occ ldap:show-remnants +-----------------+-----------------+------------------+--------------------------------------+ - | Nextcloud name | Display Name | LDAP UID | LDAP DN | + | Nextcloud name | Display Name | LDAP UID | LDAP DN | +-----------------+-----------------+------------------+--------------------------------------+ | aaliyah_brown | aaliyah brown | aaliyah_brown | uid=aaliyah_brown,ou=people,dc=com | | aaliyah_hammes | aaliyah hammes | aaliyah_hammes | uid=aaliyah_hammes,ou=people,dc=com | diff --git a/admin_manual/index.rst b/admin_manual/index.rst index 7ce94e856..491c68b8f 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -24,7 +24,7 @@ See :doc:`../whats_new_admin` for more information on the different Nextcloud editions. Nextcloud Videos and Blogs -------------------------- +-------------------------- See the `official Nextcloud channel `_ diff --git a/admin_manual/installation/apps_management_installation.rst b/admin_manual/installation/apps_management_installation.rst index 79a5839cc..efe0de33c 100644 --- a/admin_manual/installation/apps_management_installation.rst +++ b/admin_manual/installation/apps_management_installation.rst @@ -42,7 +42,7 @@ page by default. Click the app name to view a description of the app and any of the app settings in the Application View field. Clicking the **Enable** button will enable the app. If the app is not part of the Nextcloud installation, it will be downloaded from the app store, installed and enabled. -Click the gear icon on the lower left to browse experimental apps in the `Nextcloud Apps +Click the gear icon on the lower left to browse experimental apps in the `ownCloud Apps Store `_. Install experimental apps at your own risk. Sometimes the installation of a third-party app fails silently, possibly because diff --git a/admin_manual/installation/apps_supported.rst b/admin_manual/installation/apps_supported.rst index c4196cfec..ec3f4b35f 100644 --- a/admin_manual/installation/apps_supported.rst +++ b/admin_manual/installation/apps_supported.rst @@ -31,17 +31,3 @@ AGPL Apps * Update Notifications * User External * User LDAP - -Enterprise-Only Apps --------------------- - -* Enterprise License Key -* Files Drop -* File Firewall -* LDAP Home Connector -* Log user and Sharing actions (1 new app, replacing the 2 former logging apps) -* Object Storage (S3) -* SharePoint -* Shibboleth (SAML) -* Windows Network Drives (requires External Storage) -* Workflow diff --git a/admin_manual/installation/command_line_installation.rst b/admin_manual/installation/command_line_installation.rst index 296b35680..922c2f7bc 100644 --- a/admin_manual/installation/command_line_installation.rst +++ b/admin_manual/installation/command_line_installation.rst @@ -7,7 +7,7 @@ convenient for scripted operations, headless servers, and sysadmins who prefer the command line. There are three stages to installing Nextcloud via the command line: -1. Download and install the Nextcloud code and unpack the tarball in the appropriate directories. (See :doc:`source_installation`.) +1. Download the Nextcloud code and unpack the tarball in the appropriate directories. (See :doc:`source_installation`.) 2. Change the ownership of your ``nextcloud`` directory to your HTTP user, like this example for Debian/Ubuntu. You must run ``occ`` as your HTTP user; see diff --git a/admin_manual/issues/code_signing.rst b/admin_manual/issues/code_signing.rst index 0be608179..0feb1e564 100644 --- a/admin_manual/issues/code_signing.rst +++ b/admin_manual/issues/code_signing.rst @@ -181,7 +181,7 @@ https://nextcloud.com/support/. After fixing these problems verify by clicking Rescans ------- -Rescans are triggered at installation, and by updates. You may run scans manually with the ``occ`` command. The first command scans the Nextcloud core files, and the second command scans the named app. There is not yet a command to manually scan all apps:: +Rescans are triggered at installation, and by updates. You may run scans manually with the ``occ`` command. The first command scans the Nextcloud server files, and the second command scans the named app. There is not yet a command to manually scan all apps:: occ integrity:check-core occ integrity:check-app $appid diff --git a/admin_manual/issues/general_troubleshooting.rst b/admin_manual/issues/general_troubleshooting.rst index 579f07633..6696e0e9f 100644 --- a/admin_manual/issues/general_troubleshooting.rst +++ b/admin_manual/issues/general_troubleshooting.rst @@ -20,8 +20,7 @@ back for the help you get. This is the only way to keep a community like Nextcloud healthy and sustainable! If you are using Nextcloud in a business or otherwise large scale deployment, -note that Nextcloud GmbH. offers the `Enterprise Edition`_ with commercial -support options. +note that Nextcloud GmbH offers commercial support options. Bugs ---- diff --git a/admin_manual/maintenance/package_upgrade.rst b/admin_manual/maintenance/package_upgrade.rst index e308331ac..fb78b9284 100644 --- a/admin_manual/maintenance/package_upgrade.rst +++ b/admin_manual/maintenance/package_upgrade.rst @@ -100,8 +100,14 @@ Upgrading Across Skipped Releases --------------------------------- It is best to update your Nextcloud installation with every new point release, -and to never skip any major releases. If you have skipped any major releases you -can bring your Nextcloud current with these steps: +and to never skip any major releases. While this requirement is being worked on, +for the moment If you have skipped any major releases you can bring your +Nextcloud current with these steps: + +If you are using a Snap package: +sudo snap refresh nextcloud + +If you did **not** install via a Snap package: #. Add the repository of your current version #. Upgrade your current version to the latest point release diff --git a/admin_manual/maintenance/upgrade.rst b/admin_manual/maintenance/upgrade.rst index aa03d6615..d3bae85b3 100644 --- a/admin_manual/maintenance/upgrade.rst +++ b/admin_manual/maintenance/upgrade.rst @@ -24,9 +24,9 @@ notification it brings you here, to this page. **It is best to keep your Nextcloud server upgraded regularly**, and to install all point releases and major releases without skipping any of them, as skipping -releases increases the risk of errors. Major releases are 8.0, 8.1, 8.2, and -9.0. Point releases are intermediate releases for each major release. For -example, 8.0.9 and 8.1.3 are point releases. **Skipping major releases is not +releases increases the risk of errors. Major releases are 9, 10, and +11. Point releases are intermediate releases for each major release. For +example, 9.0.52 and 10.0.2 are point releases. **Skipping major releases is not supported.** **Upgrading is disruptive**. Your Nextcloud server will be put into maintenance @@ -72,6 +72,9 @@ Nextcloud release. Any apps that are not developed by Nextcloud show a 3rd party designation. **Install unsupported apps at your own risk**. Then, before the upgrade, all 3rd party apps must be disabled. After the upgrade is complete you may re-enable them. +<<<<<<< HEAD .. nextcloud.com/install/: https://nextcloud.com/install/ +======= +>>>>>>> d3d6ea5... Some more cleanup diff --git a/admin_manual/operations/considerations_on_monitoring.rst b/admin_manual/operations/considerations_on_monitoring.rst index 2310aa44b..b8c482e20 100644 --- a/admin_manual/operations/considerations_on_monitoring.rst +++ b/admin_manual/operations/considerations_on_monitoring.rst @@ -57,8 +57,8 @@ server is operating properly. Nextcloud.log ------------- -Nextcloud also provides a built in logging function. If the Nextcloud Enterprise Edition logging applications -are enabled, this file will track user logins and shared file activity. If these logging applications are +Nextcloud also provides a built in logging function. If the Nextcloud logging application +is enabled, this file will track user logins and shared file activity. If these logging applications are not enabled, this log file still tracks basic Nextcloud health. Given the potential for this file to get quite large, the log file should be rotated on a daily basis, and given the importance of the error information in the log file, this should be integrated with an enterprise log manager. diff --git a/admin_manual/release_notes.rst b/admin_manual/release_notes.rst index 8415e059e..ed23f272d 100644 --- a/admin_manual/release_notes.rst +++ b/admin_manual/release_notes.rst @@ -1,6 +1,6 @@ -================================ +================================= Nextcloud |version| Release Notes -================================ +================================= Changes in 9.0 diff --git a/admin_manual/whats_new_admin.rst b/admin_manual/whats_new_admin.rst index 912d7f956..5e13b77f4 100644 --- a/admin_manual/whats_new_admin.rst +++ b/admin_manual/whats_new_admin.rst @@ -1,6 +1,6 @@ -=========================================== +============================================ What's New for Admins in Nextcloud |version| -=========================================== +============================================ See the `Nextcloud 10 Features page `_ on Github for a diff --git a/developer_manual/android_library/index.rst b/developer_manual/android_library/index.rst index 1d0b55461..939f6786c 100644 --- a/developer_manual/android_library/index.rst +++ b/developer_manual/android_library/index.rst @@ -11,7 +11,7 @@ For third party application developers, Nextcloud offers the Nextcloud Android library under the MIT license. Android Nextcloud Client development ------------------------------------ +------------------------------------ If you are interested in working on the Nextcloud android client, you can find the source code `in github `_. The diff --git a/developer_manual/app/changelog.rst b/developer_manual/app/changelog.rst index 428a1e83d..539f1e2ad 100644 --- a/developer_manual/app/changelog.rst +++ b/developer_manual/app/changelog.rst @@ -4,35 +4,6 @@ Changelog .. sectionauthor:: Bernhard Posselt -The following changes went into Nextcloud 8.1: - - -Breaking changes -================ -The following breaking changes usually do only affect applications which misuse existing API or do not follow best practises. - -* The default Content-Security-Policy of AppFramework apps is now stricter but can be adjusted by developers. See https://github.com/owncloud/core/pull/13989 -* Parameters passed to OC.generateUrl are now automatically encoded, this behaviour can be adjusted by developers. See https://github.com/owncloud/core/pull/14266 -* Views constructed by OC\Files\View do not allow directory traversals anymore in the constructor. See https://github.com/owncloud/core/pull/14342 -* The CSRF token may now contain not URL compatible characters (for example the plus sign: +), developers have to ensure that the CSRF token is encoded properly before using it in URIs. -* The default RNG now returns all valid base64 characters -* OC.msg escapes the message now by default (see https://github.com/owncloud/core/pull/14208) - - -Features -======== -* There is a new :doc:`OCSResponse and OCSController ` which allows you to easily migrate OCS code to the App Framework. This was added purely for compatibility reasons and the preferred way of doing APIs is using a :doc:`api` -* You can now stream files in PHP by using the built in :doc:`StreamResponse `. -* For more advanced usecases you can now implement the :doc:`CallbackResponse ` interface which allows your response to do its own response rendering -* Custom preview providers can now be implemented using **OCP\IPreview::registerProvider** -* There is a mightier class for remote web service requests at **OCP\Http\Client** -* **OCP\\IImage** allows now basic image manipulations such as resizing or rotating -* **OCP\\Mail** allows sending mails in an object-oriented way now -* **OCP\\IRequest** contains more methods now such as getting the request URI -* **OCP\\Encryption** allows writing custom encryption backends - -Furthermore all public APIs have received a **@since** annotation allowing developers to see when a function has been introduced. - Deprecations ============ This is a deprecation roadmap which lists all current deprecation targets and will be updated from release to release. This lists the version when a specific method or class will be removed. diff --git a/developer_manual/app/code_signing.rst b/developer_manual/app/code_signing.rst index 3ce60bf92..5d81e6e13 100644 --- a/developer_manual/app/code_signing.rst +++ b/developer_manual/app/code_signing.rst @@ -16,14 +16,14 @@ FAQ --- Why Did Nextcloud Add Code Signing? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ By supporting Code Signing we add another layer of security by ensuring that nobody other than authorized persons can push updates for applications, and ensuring proper upgrades. Do We Lock Down Nextcloud? -^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^ The Nextcloud project is open source and always will be. We do not want to make it more difficult for our users to run Nextcloud. Any code signing errors on @@ -104,8 +104,8 @@ still be ensured by having a new certificate issued. How Code Signing Affects Apps in the App Store ---------------------------------------------- -- Apps which have an ``official`` tag **MUST** be code signed starting with - Nextcloud 9.0. Unsigned ``official`` apps won't be installable anymore. +- Apps which have an ``official`` tag **MUST** be code signed. + Unsigned ``official`` apps won't be installable anymore. - Apps which have been signed in a previous release **MUST** be code-signed in all future releases as well, otherwise the update will be refused. diff --git a/developer_manual/app/container.rst b/developer_manual/app/container.rst index cd3a17e9c..277ee01e9 100644 --- a/developer_manual/app/container.rst +++ b/developer_manual/app/container.rst @@ -153,7 +153,6 @@ So basically the container is used as a giant factory to build all the classes t Use automatic dependency assembly (recommended) =============================================== -.. versionadded:: 8 It is possible to omit the **appinfo/application.php** and use automatic dependency assembly instead. diff --git a/developer_manual/app/controllers.rst b/developer_manual/app/controllers.rst index 72a0f2134..170ae754f 100644 --- a/developer_manual/app/controllers.rst +++ b/developer_manual/app/controllers.rst @@ -26,7 +26,7 @@ To create a controller, simply extend the Controller class and create a method t Connecting a controller and a route -==================================== +=================================== To connect a controller and a route the controller has to be registered in the :doc:`container` like this: .. code-block:: php @@ -422,8 +422,6 @@ By default there is only a responder for JSON but more can be added easily: .. note:: The above example would only return XML if the **format** parameter was *xml*. If you want to return an XMLResponse regardless of the format parameter, extend the Response class and return a new instance of it from the controller method instead. -.. versionadded:: 8 - Because returning values works fine in case of a success but not in case of failure that requires a custom HTTP error code, you can always wrap the value in a **DataResponse**. This works for both normal responses and error responses. .. code-block:: php @@ -557,7 +555,6 @@ Creating a custom XMLResponse class could look like this: Streamed and lazily rendered responses -------------------------------------- -.. versionadded:: 8.1 By default all responses are rendered at once and sent as a string through middleware. In certain cases this is not a desirable behavior, for instance if you want to stream a file in order to save memory. To do that use the now available **OCP\\AppFramework\\Http\\StreamResponse** class: @@ -602,7 +599,6 @@ If you want to use a custom, lazily rendered response simply implement the inter Modifying the Content Security Policy ------------------------------------- -.. versionadded:: 8.1 By default Nextcloud disables all resources which are not served on the same domain, forbids cross domain requests and disables inline CSS and JavaScript by setting a `Content Security Policy `_. However if an app relies on thirdparty media or other features which are forbidden by the current policy the policy can be relaxed. @@ -655,8 +651,6 @@ The following policy for instance allows images, audio and videos from other dom OCS --- -.. versionadded:: 8.1 - .. note:: This is purely for compatibility reasons. If you are planning to offer an external API, go for a :doc:`api` instead. In order to ease migration from OCS API routes to the App Framework, an additional controller and response have been added. To migrate your API you can use the **OCP\\AppFramework\\OCSController** baseclass and return your data in the form of an array in the following way: diff --git a/developer_manual/app/info.rst b/developer_manual/app/info.rst index 6479f0196..5149f762d 100644 --- a/developer_manual/app/info.rst +++ b/developer_manual/app/info.rst @@ -16,7 +16,6 @@ The :file:`appinfo/info.xml` contains metadata about the app: 1.0 AGPL Your Name - 5 YourAppsNamespace @@ -53,6 +52,7 @@ The :file:`appinfo/info.xml` contains metadata about the app: + 5 appinfo/caldav.php @@ -95,10 +95,6 @@ author ------ **Required**: The name of the app author or authors. -requiremin ----------- -Required if not added in the **** tag. The minimal version of Nextcloud. - namespace --------- Required if routes.php returns an array. If your app is namespaced like **\\OCA\\MyApp\\Controller\\PageController** the required namespace value is **MyApp**. If not given it tries to default to the first letter upper cased app id, e.g. **myapp** would be tried under **Myapp** @@ -116,7 +112,6 @@ Nextcloud allows to specify four kind of ``types``. Currently supported ``types` * **logging**: apps which implement a logging system * **prevent_group_restriction**: apps which can not be enabled for specific groups (e.g. notifications app). - Introduced with Nextcloud 9.0, can also be used in earlier versions, but the functionality is ignored. .. note:: @@ -182,7 +177,7 @@ Defines the required target operating system the app can run on. Valid values ar owncloud ======== -Defines minimum and maximum versions of the Nextcloud core. In case undefined the values will be taken from the tag 'requiremin'. +**Required**: Defines minimum and maximum versions of the Nextcloud core. In case undefined the values will be taken from the tag 'requiremin'. Deprecated @@ -193,6 +188,10 @@ The following sections are just listed for reference and should not be used beca * **public/remote**: Use :doc:`api` instead because you'll have to use :doc:`../core/externalapi` which is known to be buggy (works only properly with GET/POST) * **standalone/default_enable**: They tell core what do on setup, you will not be able to even activate your app if it has those entries. This should be replaced by a config file inside core. +requiremin +========== +Deprecated in favor of the **** tag. + public ====== Used to provide a public interface (requires no login) for the app. The id is appended to the URL **/nextcloud/index.php/public**. Example with id set to 'calendar':: diff --git a/developer_manual/app/l10n.rst b/developer_manual/app/l10n.rst index cfcedffcf..ee95b27a1 100644 --- a/developer_manual/app/l10n.rst +++ b/developer_manual/app/l10n.rst @@ -4,6 +4,8 @@ Translation .. sectionauthor:: Bernhard Posselt +Nextcloud's translation system is powered by `Transifex `_. To start translating sign up and enter a group. If your app should be added to Transifex just post a new topic in the `translations forum `_ and we will set it up for you. + PHP === Should it ever be needed to use localized strings on the server-side, simply inject the L10N service from the ServerContainer into the needed constructor diff --git a/developer_manual/app/publishing.rst b/developer_manual/app/publishing.rst index 3492e2a01..e75a84296 100644 --- a/developer_manual/app/publishing.rst +++ b/developer_manual/app/publishing.rst @@ -5,7 +5,7 @@ App store publishing .. sectionauthor:: Jos Poortvliet The Nextcloud App Store ----------------------- +----------------------- The Nextcloud app store is build into Nextcloud to allow you to get your apps to users as easily and safely as possible. The app store and the process of publishing apps aims to be: * secure diff --git a/developer_manual/app/tutorial.rst b/developer_manual/app/tutorial.rst index 10e6b0c11..149902032 100644 --- a/developer_manual/app/tutorial.rst +++ b/developer_manual/app/tutorial.rst @@ -13,7 +13,7 @@ After the `development tool `_ * `Least commented issues `_ -* `Bugs which need info `_ +* `Bugs which need info `_ But there are more methods. For example, if you are a user of Nextcloud with a specific setup like using nginx as Web server or dropbox as storage, or using the encryption app, you could look for bugs with these keywords. You can then use your knowledge of your installation and your installation itself to see if bugs are (still) valid or reproduce them. @@ -116,8 +116,8 @@ Finalizing and tagging ---------------------- Once you are done reproducing an issue, it is time to finish up and make clear to the developers what they can do: -* If it is a genuine bug (or you are pretty sure it is) add the 'Bug' tag. -* If it is a genuine feature request (or you are pretty sure it is) add the 'enhancement' tag. -* If the issue is clearly related to something specific, @mention a maintainer. examples: @schiesbn for encryption, @blizzz for LDAP, @PVince81 for quota stuff... You can find a `list of maintainers here `_. +* If it is a genuine bug (or you are pretty sure it is) add the 'bug' label. +* If it is a genuine feature request (or you are pretty sure it is) add the 'enhancement' label. +* If the issue is clearly related to something specific, set the specific feature label and @mention a maintainer Now, the developers can pick the issue up. Note that while we wish we would always pick up and solve problems promptly, not all areas of Nextcloud get the same amount of attention and contribution, so this can occasionally take a long time. diff --git a/developer_manual/core/unit-testing.rst b/developer_manual/core/unit-testing.rst index 1bcce6451..1fbcd3c3a 100644 --- a/developer_manual/core/unit-testing.rst +++ b/developer_manual/core/unit-testing.rst @@ -7,7 +7,7 @@ PHP unit testing Getting PHPUnit ~~~~~~~~~~~~~~~ -Nextcloud uses PHPUnit >= 3.7 for unit testing. +Nextcloud uses PHPUnit >= 4.8 for unit testing. To install it, either get it via your packagemanager:: diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/general/codingguidelines.rst index ac5caa9b0..1d5540954 100644 --- a/developer_manual/general/codingguidelines.rst +++ b/developer_manual/general/codingguidelines.rst @@ -21,41 +21,21 @@ We assign labels to issues and pull requests to make it easy to find them and to The most important labels and their meaning: +* #backport-request - the pull requests also needs to be applied to older Nextcloud versions * #bug - this issue is a bug * #enhancement - this issue is a feature request/idea for improvement of Nextcloud * #design - this needs help from the design team or is a design-related issue/pull request -* #sharing - this issue or PR is related to sharing * #technical debt - this issue or PR is about `technical debt `_ -* #sev1-critical #sev2-high #sev3-medium #sev4-low signify how important the bug is. -* #p1-urgent #p2-high #p3-medium #p4-low signify the priority of the bug. -* #Junior Job - these are issues which are relatively easy to solve and ideal for people who want to learn how to code in Nextcloud -* Tags showing the state of the issue or PR, numbered 1-6: - * #1 - Backlog - (please don't use, we prefer using a backlog milestone) - * #2 - Triaging - (please don't use, we prefer using the triage label) - * #3 - To develop - ready to start development on this - * #4 - Developing - development in progress - * #5 - To Review - ready for review - * #6 - Reviewing - review in progress - * #7 - To Release - reviewed PR that awaits unfreeze of a branch to get merged -* App tags: #app:files #app:user_ldap #app:files_versions and so on. These tags indicate the app that is impacted by the issue or which the PR is related to -* Settings tags: #settings:personal #settings:apps #settings:admin and so on. These tags indicate the settings area that is impacted by the issue or which the PR is related to -* db tags: #db:mysql #db:sqlite #db:postgresql and so on. These tags indicate the database that is impacted by the issue or which the PR is related to -* Browser tags: #browser:ie #browser:safari and so on. These tags indicate the browser that is impacted by the issue or which the PR is related to -* Component tags: #comp:filesystem #comp:javascript and so on. These tags indicate the components of Nextcloud impacted by the issue or which the PR is related to -* Development tool tags: #dev:unit_testing #dev:public_API and so on. These tags indicate development-specific tools like those for testing and public developer-facing API's impacted by the issue or which the PR is related -* Feature tags: #feature:something. These tags indicate the features across apps and components which are impacted by the issue or which the PR is related to -* #triage - this issue *has to be* `triaged <../bugtracker/triaging.html>`_ -* #needs info - this issue needs further information from the reporter, see `triaging <../bugtracker/triaging.html>`_ old tag is #clarification request, please don't use that one anymore. -* #discussion - this issue needs to be discussed -* #security - this is a security related issue -* #windows server - this is related to windows server -* #research - this item requires some research before it can continue -* #packaging - this is related to packaging -* #theming - refers to theming issues or improvements -* #l10n - refers to translation issues or improvements -* #release note - relevant for the release notes -* #privacy - refers to issues that might lead to privacy concerns -* #won't fix - This problem won't be fixed (can be for a wide variety of reasons...) +* #starter issue - these are issues which are relatively easy to solve and ideal for people who want to learn how to code in Nextcloud +* #needs info - this issue needs further information from the reporter, see `triaging <../bugtracker/triaging.html>`_ +* #high #medium #low signify how important the bug is. +* Tags showing the state of the issue or PR, numbered 0-4: + * #0 - Needs triage - ready to start development on this + * #1 - To develop - ready to start development on this + * #2 - Developing - development in progress + * #3 - To Review - ready for review + * #4 - To Release - reviewed PR that awaits unfreeze of a branch to get merged +* Feature tags: #feature: something. These tags indicate the features across apps and components which are impacted by the issue or which the PR is related to If you want a label not in the list above, please first discuss on the mailing list. diff --git a/developer_manual/general/debugging.rst b/developer_manual/general/debugging.rst index 7860cb9a4..cf40a1de5 100644 --- a/developer_manual/general/debugging.rst +++ b/developer_manual/general/debugging.rst @@ -18,7 +18,7 @@ When debug mode is enabled in Nextcloud, a variety of debugging features are ena Identifying errors ------------------ -Nextcloud uses custom error PHP handling that prevents errors being printed to Web server log files or command line output. Instead, errors are generally stored in Nextcloud's own log file, located at: :file:`/data/owncloud.log` +Nextcloud uses custom error PHP handling that prevents errors being printed to Web server log files or command line output. Instead, errors are generally stored in Nextcloud's own log file, located at: :file:`/data/nextcloud.log` Debugging variables diff --git a/developer_manual/general/performance.rst b/developer_manual/general/performance.rst index f2d95b7f2..4294a9dab 100644 --- a/developer_manual/general/performance.rst +++ b/developer_manual/general/performance.rst @@ -1,7 +1,7 @@ Performance Considerations ========================== -.. sectionauthor:: Frank Karlitschek +.. sectionauthor:: Frank Karlitschek This document introduces some common considerations and tips on improving performance of Nextcloud. Speed of Nextcloud is important - nobody likes to wait and often, what is *just slow* for a small amount of data will become *unusable* with a large amount of data. Please keep these tips in mind when developing for Nextcloud and consider reviewing your app to make it faster. diff --git a/developer_manual/index.rst b/developer_manual/index.rst index 1add0674d..726dbd559 100644 --- a/developer_manual/index.rst +++ b/developer_manual/index.rst @@ -4,8 +4,9 @@ Nextcloud Developer Documentation ================================= -.. _Nextcloud appstore: https://apps.owncloud.com/ -.. _Documentation: https://github.com/nextcloud/documentation#nextcloud-documentation +.. _ownCloud appstore: https://apps.owncloud.com/ +.. _Translation: https://www.transifex.com/nextcloud/nextcloud/ +.. _Documentation: https://github.com/nextcloud/documentation Table of Contents ================= diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index f45de5511..11c0af75f 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -12,7 +12,7 @@ Nextcloud Desktop and Mobile Clients ------------------------------------ The recommended method for keeping your desktop PC synchronized with your -Nextcloud server is by using the `Nextcloud Desktop Client +Nextcloud server is by using the `Nextcloud/ownCloud sync clients `_. You can configure the client to save files in any local directory you want, and you choose which directories on the Nextcloud server to sync with. The client displays the current connection @@ -503,10 +503,6 @@ To get the properties of files in the root folder: .. _KB2668751: https://support.microsoft.com/kb/2668751 .. _KB2123563: https://support.microsoft.com/kb/2123563 -.. _in your file manager: http://en.wikipedia.org/wiki/Webdav#WebDAV_client_applications -.. _Nextcloud sync clients: https://doc.owncloud.org/desktop/2.1/ -.. _Mount Nextcloud to a local folder without sync: https://docs.nextcloud.org/server/9/admin_manual/configuration_files/external_storage/webdav.html?highlight=webdav -.. _Android: https://github.com/nextcloud/android .. _WebDAV Navigator: http://seanashton.net/webdav/ .. _Android devices: https://play.google.com/store/apps/details?id=com.schimera.webdavnavlite .. _iPhones: https://itunes.apple.com/app/webdav-navigator/id382551345 diff --git a/user_manual/files/federated_cloud_sharing.rst b/user_manual/files/federated_cloud_sharing.rst index 2ff5f0761..119af4f22 100644 --- a/user_manual/files/federated_cloud_sharing.rst +++ b/user_manual/files/federated_cloud_sharing.rst @@ -9,8 +9,8 @@ users on other Nextcloud servers. Creating a New Federation Share ------------------------------- -Federation sharing is enabled on Nextcloud installations by default. -Follow these steps to create a new share with other Nextcloud 9 servers: +Federation sharing is enabled on new or upgraded Nextcloud installations +by default. Follow these steps to create a new share with other Nextcloud or ownCloud 9+ servers: 1. Go to your ``Files`` page and click the Share icon on the file or directory you want to share. In the sidebar enter the username and URL of the remote user @@ -31,6 +31,8 @@ share, and does not delete any files. Creating a New Federated Cloud Share via Email ---------------------------------------------- +Use this method when you are sharing with users on ownCloud 8.x and older. + What if you do not know the username or URL? Then you can have Nextcloud create the link for you and email it to your recipient. @@ -43,7 +45,7 @@ a Web browser, and then click the **Add to your Nextcloud** button. .. figure:: ../images/create_public_share-8.png The **Add to your Nextcloud** button changes to a form field, and your recipient -needs to enter the URL of their Nextcloud server in this field and press the +needs to enter the URL of their Nextcloud or ownCloud server in this field and press the return key, or click the arrow. .. figure:: ../images/create_public_share-9.png diff --git a/user_manual/index.rst b/user_manual/index.rst index ef5ab95ec..0a608d76c 100644 --- a/user_manual/index.rst +++ b/user_manual/index.rst @@ -18,8 +18,8 @@ using the Nextcloud / ownCloud Desktop Sync Client, Android app. To learn more about the Nextcloud desktop and mobile clients, please refer to their respective manuals: -* `Nextcloud Desktop Client`_ +* `Nextcloud/ownCloud Desktop Client`_ * `Nextcloud Android App`_ -.. _`Nextcloud Desktop Client`: https://doc.owncloud.org/desktop/2.1/ +.. _`Nextcloud/ownCloud Desktop Client`: https://doc.owncloud.org/desktop/2.2/ .. _`Nextcloud Android App`: https://docs.nextcloud.org/android/