diff --git a/_shared_assets/static/logo-blue.pdf b/_shared_assets/static/logo-blue.pdf index 81562944c65..10429b550d8 100644 Binary files a/_shared_assets/static/logo-blue.pdf and b/_shared_assets/static/logo-blue.pdf differ diff --git a/_shared_assets/static/logo-blue.png b/_shared_assets/static/logo-blue.png index 4e3850e56c2..b986ede2ced 100644 Binary files a/_shared_assets/static/logo-blue.png and b/_shared_assets/static/logo-blue.png differ diff --git a/_shared_assets/themes/nextcloud_com/layout.html b/_shared_assets/themes/nextcloud_com/layout.html index 3f7b2cd10e7..19ce94541a3 100644 --- a/_shared_assets/themes/nextcloud_com/layout.html +++ b/_shared_assets/themes/nextcloud_com/layout.html @@ -67,11 +67,14 @@ diff --git a/_shared_assets/themes/nextcloud_com/static/styles.css b/_shared_assets/themes/nextcloud_com/static/styles.css index 3d7305d1558..4d0ec737f23 100644 --- a/_shared_assets/themes/nextcloud_com/static/styles.css +++ b/_shared_assets/themes/nextcloud_com/static/styles.css @@ -7,15 +7,6 @@ border-color: red; }*/ -.menu-install { - background: #35537a !important; -} - -.menu-install:hover { - background: #2A6496 !important; -} - - @font-face { font-family: 'Open Sans'; font-style: normal; diff --git a/admin_manual/conf.py b/admin_manual/conf.py index 03b5f266fd2..5b63d60ac5a 100644 --- a/admin_manual/conf.py +++ b/admin_manual/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# ownCloud Documentation documentation build configuration file, created by +# Nextcloud Documentation documentation build configuration file, created by # sphinx-quickstart on Mon Oct 22 23:16:40 2012. # # This file is execfile()d with the current directory set to its containing dir. @@ -44,13 +44,13 @@ # built documents. # # The short X.Y version. -version = '9.1' +version = '10' # The full version, including alpha/beta/rc tags. -release = '9.1' +release = '10' # General information about the project. -project = u'ownCloud %s Server Administration Manual' % (version) -copyright = u'2012-2016, The ownCloud developers' +project = u'Nextcloud %s Server Administration Manual' % (version) +copyright = u'2012-2016, The Nextcloud developers' # The language for content autogenerated by Sphinx. Refer to documentation @@ -166,7 +166,7 @@ #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'ownCloudServerAdminManual' +htmlhelp_basename = 'NextcloudServerAdminManual' # -- Options for LaTeX output -------------------------------------------------- @@ -185,7 +185,7 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [('contents', 'ownCloud_Server_Administration_Manual.tex', u'ownCloud Server Administration Manual', u'The ownCloud developers', 'manual'),] +latex_documents = [('contents', 'Nextcloud_Server_Administration_Manual.tex', u'Nextcloud Server Administration Manual', u'The Nextcloud developers', 'manual'),] # The name of an image file (relative to this directory) to place at the top of # the title page. @@ -209,13 +209,13 @@ # -- Options for pdf page output ----------------------------------------------- -pdf_documents = [('contents', u'owncloud Server Administration Manual', u'ownCloud Server Administration Manual', u'The ownCloud developers'),] +pdf_documents = [('contents', u'nextcloud Server Administration Manual', u'Nextcloud Server Administration Manual', u'The Nextcloud developers'),] # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ ('contents', 'owncloudserveradminmanual', u'ownCloud Server Administration Manual', [u'The ownCloud developers'], 1) ] +man_pages = [ ('contents', 'nextcloudserveradminmanual', u'Nextcloud Server Administration Manual', [u'The Nextcloud developers'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False @@ -226,7 +226,7 @@ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) -texinfo_documents = [ ('contents', 'ownCloud Server Admin Manual', u'ownCloud Server Administration Manual', u'The ownCloud developers', 'ownCloud', 'The ownCloud Server Administration Manual.', 'Miscellaneous'), ] +texinfo_documents = [ ('contents', 'Nextcloud Server Admin Manual', u'Nextcloud Server Administration Manual', u'The Nextcloud developers', 'Nextcloud', 'The Nextcloud Server Administration Manual.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] @@ -241,10 +241,10 @@ # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = u'ownCloud Server Administration Manual' -epub_author = u'The ownCloud developers' -epub_publisher = u'The ownCloud developers' -epub_copyright = u'2012-2016, The ownCloud developers' +epub_title = u'Nextcloud Server Administration Manual' +epub_author = u'The Nextcloud developers' +epub_publisher = u'The Nextcloud developers' +epub_copyright = u'2012-2016, The Nextcloud developers' # The language of the text. It defaults to the language option # or en if the language is not set. @@ -282,5 +282,3 @@ # Include todos? todo_include_todos = True - - diff --git a/admin_manual/configuration_database/linux_database_configuration.rst b/admin_manual/configuration_database/linux_database_configuration.rst index 9fec93f737f..6e5b5addf01 100644 --- a/admin_manual/configuration_database/linux_database_configuration.rst +++ b/admin_manual/configuration_database/linux_database_configuration.rst @@ -2,11 +2,11 @@ Database Configuration ====================== -ownCloud requires a database in which administrative data is stored. The following databases are currently supported: +Nextcloud requires a database in which administrative data is stored. The following databases are currently supported: * `MySQL `_ / `MariaDB `_ * `PostgreSQL `_ -* `Oracle `_ (ownCloud Enterprise edition only) +* `Oracle `_ The MySQL or MariaDB databases are the recommended database engines. @@ -25,12 +25,12 @@ requires that you install and set up the server software first. MySQL / MariaDB with Binary Logging Enabled ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -ownCloud is currently using a ``TRANSACTION_READ_COMMITTED`` transaction isolation +Nextcloud is currently using a ``TRANSACTION_READ_COMMITTED`` transaction isolation to avoid data loss under high load scenarios (e.g. by using the sync client with many clients/users and many parallel operations). This requires a disabled or correctly configured binary logging when using MySQL or MariaDB. Your system is affected if you see the following in your log file during the installation or -update of ownCloud: +update of Nextcloud: An unhandled exception has been thrown: exception 'PDOException' with message 'SQLSTATE[HY000]: General error: 1665 @@ -65,7 +65,7 @@ for detailed information. Parameters ---------- -For setting up ownCloud to use any database, use the instructions in :doc:`../installation/installation_wizard`. You should not have to edit the respective values in the :file:`config/config.php`. However, in special cases (for example, if you want to connect your ownCloud instance to a database created by a previous installation of ownCloud), some modification might be required. +For setting up Nextcloud to use any database, use the instructions in :doc:`../installation/installation_wizard`. You should not have to edit the respective values in the :file:`config/config.php`. However, in special cases (for example, if you want to connect your Nextcloud instance to a database created by a previous installation of Nextcloud), some modification might be required. Configuring a MySQL or MariaDB Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -74,7 +74,7 @@ If you decide to use a MySQL or MariaDB database, ensure the following: * That you have installed and enabled the pdo_mysql extension in PHP -* That the **mysql.default_socket** points to the correct socket (if the database runs on the same server as ownCloud). +* That the **mysql.default_socket** points to the correct socket (if the database runs on the same server as Nextcloud). .. note:: MariaDB is backwards compatible with MySQL. All instructions work for both. You will not need to replace mysql with anything. @@ -100,7 +100,7 @@ The PHP configuration in :file:`/etc/php5/conf.d/mysql.ini` could look like this mysql.trace_mode=Off Now you need to create a database user and the database itself by using the -MySQL command line interface. The database tables will be created by ownCloud +MySQL command line interface. The database tables will be created by Nextcloud when you login for the first time. To start the MySQL command line mode use:: @@ -112,14 +112,14 @@ Then a **mysql>** or **MariaDB [root]>** prompt will appear. Now enter the follo :: CREATE USER 'username'@'localhost' IDENTIFIED BY 'password'; - CREATE DATABASE IF NOT EXISTS owncloud; - GRANT ALL PRIVILEGES ON owncloud.* TO 'username'@'localhost' IDENTIFIED BY 'password'; + CREATE DATABASE IF NOT EXISTS nextcloud; + GRANT ALL PRIVILEGES ON nextcloud.* TO 'username'@'localhost' IDENTIFIED BY 'password'; You can quit the prompt by entering:: quit -An ownCloud instance configured with MySQL would contain the hostname on which +An 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 @@ -130,7 +130,7 @@ this: "mysql", - "dbname" => "owncloud", + "dbname" => "nextcloud", "dbuser" => "username", "dbpassword" => "password", "dbhost" => "localhost", @@ -168,13 +168,13 @@ Then a **template1=#** prompt will appear. Now enter the following lines and con :: CREATE USER username CREATEDB; - CREATE DATABASE owncloud OWNER username; + CREATE DATABASE nextcloud OWNER username; You can quit the prompt by entering:: \q -An ownCloud instance configured with PostgreSQL would contain the path to the socket on +An Nextcloud instance configured with PostgreSQL would contain the path to the socket on which the database is running as the hostname, the system username the php process is using, and an empty 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 @@ -185,7 +185,7 @@ this: "pgsql", - "dbname" => "owncloud", + "dbname" => "nextcloud", "dbuser" => "username", "dbpassword" => "", "dbhost" => "/var/run/postgresql", @@ -196,7 +196,7 @@ this: If you use another authentication method (not peer), you'll need to use the following steps to get the database setup: Now you need to create a database user and the database itself by using the PostgreSQL command line interface. The database tables will be created by -ownCloud when you login for the first time. +Nextcloud when you login for the first time. To start the postgres command line mode use:: @@ -215,7 +215,7 @@ You can quit the prompt by entering:: \q -An ownCloud instance configured with PostgreSQL would contain the hostname on +An Nextcloud instance configured with PostgreSQL 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 @@ -226,7 +226,7 @@ this: "pgsql", - "dbname" => "owncloud", + "dbname" => "nextcloud", "dbuser" => "username", "dbpassword" => "password", "dbhost" => "localhost", @@ -246,7 +246,7 @@ refer to the manual of your database for how to raise the configuration options ``wait_timeout`` and/or ``max_allowed_packet``. Some shared hosters are not allowing the access to these config options. For such -systems ownCloud is providing a ``dbdriveroptions`` configuration option within your +systems Nextcloud is providing a ``dbdriveroptions`` configuration option within your :file:`config/config.php` where you can pass such options to the database driver. Please refer to :doc:`../configuration_server/config_sample_php_parameters` for an example. @@ -302,12 +302,12 @@ the respective host name:: Assuming the database server is installed on the same system you're running the command from, use:: - psql -Uusername -downcloud + psql -Uusername -dnextcloud To access a MySQL installation on a different machine, add the -h option with the respective host name:: - psql -Uusername -downcloud -h HOSTNAME + psql -Uusername -dnextcloud -h HOSTNAME :: @@ -330,10 +330,10 @@ Useful SQL commands MySQL : SHOW DATABASES; PostgreSQL: \l -**Show ownCloud Tables in Database**:: +**Show Nextcloud Tables in Database**:: - MySQL : USE owncloud; SHOW TABLES; - PostgreSQL: \c owncloud; \d + MySQL : USE nextcloud; SHOW TABLES; + PostgreSQL: \c nextcloud; \d **Quit Database**:: diff --git a/admin_manual/configuration_files/collaborative_documents_configuration.rst b/admin_manual/configuration_files/collaborative_documents_configuration.rst index 7513ff55aa4..a1db237b89f 100644 --- a/admin_manual/configuration_files/collaborative_documents_configuration.rst +++ b/admin_manual/configuration_files/collaborative_documents_configuration.rst @@ -48,4 +48,4 @@ If the mentioned test fails please make sure that: * 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/owncloud.log``. +More hints why the test is failing can be found in your ``data/nextcloud.log``. diff --git a/admin_manual/configuration_files/federated_cloud_sharing_configuration.rst b/admin_manual/configuration_files/federated_cloud_sharing_configuration.rst index bab1ec9ea92..785c484ae21 100644 --- a/admin_manual/configuration_files/federated_cloud_sharing_configuration.rst +++ b/admin_manual/configuration_files/federated_cloud_sharing_configuration.rst @@ -6,20 +6,14 @@ Federated Cloud Sharing is now managed by the Federation app (9.0+), and is now called Federation sharing. When you enable the Federation app you can easily and securely link file shares between Nextcloud servers, in effect creating a cloud of Nextclouds. - -Sharing With ownCloud 8 and Older ---------------------------------- - -Direct Federation shares (:ref:`label-direct-share-link`) are not supported in -ownCloud 8 and older, so you must create Federation shares with public links -(:ref:`label-public-link-share`). + .. _label-direct-share-link: -Creating a new Federation Share (9.0+ only) -------------------------------------------- +Creating a new Federation Share +------------------------------- -Follow these steps to create a new Federation share between two Nextcloud 9.0+ +Follow these steps to create a new Federation share between two Nextcloud servers. This requires no action by the user on the remote server; all it takes is a few steps on the originating server. @@ -39,7 +33,7 @@ is a few steps on the originating server. .. figure:: images/federation-0.png -3. Now go to your Files page and select a folder to share. Click the share +4. Now go to your Files page and select a folder to share. Click the share icon, and then enter the username and URL of the user on the remote Nextcloud server. In this example, that is ``freda@https://example.com/nextcloud``. When Nextcloud verifies the link, it displays it with the **(remote)** label. @@ -47,7 +41,7 @@ is a few steps on the originating server. .. figure:: images/federation-2.png -3. When the link is successfully completed, you have a single share option, +5. When the link is successfully completed, you have a single share option, and that is **can edit**. .. figure:: images/federation-3.png @@ -75,9 +69,6 @@ exchanged. A red light means the connection failed. Creating Federation Shares via Public Link Share ------------------------------------------------ -You'll need to use a Public Link Share to create Federation shares with -ownCloud 8.x and older. - Check the ``Share Link`` checkbox to expose more sharing options (which are described more fully in :doc:`file_sharing_configuration`). You may create a Federation share by allowing Nextcloud to create a public link for you, and then diff --git a/admin_manual/configuration_files/previews_configuration.rst b/admin_manual/configuration_files/previews_configuration.rst index 96c29b84265..3722828bfb0 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 ownCloud 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_mimetypes/mimetype_aliases.rst b/admin_manual/configuration_mimetypes/mimetype_aliases.rst index 5829c2497d4..ca02d5661c5 100644 --- a/admin_manual/configuration_mimetypes/mimetype_aliases.rst +++ b/admin_manual/configuration_mimetypes/mimetype_aliases.rst @@ -2,16 +2,16 @@ Mimetype Aliases ================ -ownCloud allows you to create aliases for mimetypes, so that you can display +Nextcloud allows you to create aliases for mimetypes, so that you can display custom icons for files. For example, you might want a nice audio icon for audio files instead of the default file icon. -By default ownCloud is distributed with -``owncloud/resources/config/mimetypealiases.dist.json``. -Do not modify this file, as it will be replaced when ownCloud is updated. -Instead, create your own ``owncloud/config/mimetypealiases.json`` +By default Nextcloud is distributed with +``nextcloud/resources/config/mimetypealiases.dist.json``. +Do not modify this file, as it will be replaced when Nextcloud is updated. +Instead, create your own ``nextcloud/config/mimetypealiases.json`` file with your custom aliases. Use the same syntax as in -``owncloud/resources/config/mimetypealiases.dist.json``. +``nextcloud/resources/config/mimetypealiases.dist.json``. Once you have made changes to your ``mimetypealiases.json``, use the ``occ`` command to propagate the changes through the system. This example is for diff --git a/admin_manual/configuration_mimetypes/mimetype_mapping.rst b/admin_manual/configuration_mimetypes/mimetype_mapping.rst index 45cc8d60de0..e1e03a8f292 100644 --- a/admin_manual/configuration_mimetypes/mimetype_mapping.rst +++ b/admin_manual/configuration_mimetypes/mimetype_mapping.rst @@ -1,13 +1,13 @@ Mimetype mapping ================ -ownCloud allows administrators to specify the mapping of a file extension to a +Nextcloud allows administrators to specify the mapping of a file extension to a mimetype. For example files ending in ``mp3`` map to ``audio/mpeg``. Which -then in turn allows ownCloud to show the audio icon. +then in turn allows Nextcloud to show the audio icon. -By default ownCloud comes with ``mimetypemapping.dist.json``. This is a +By default Nextcloud comes with ``mimetypemapping.dist.json``. This is a simple json array. Administrators should not update this file as it will get replaced on upgrades -of ownCloud. Instead the file ``mimetypemapping.json`` should be created and +of Nextcloud. Instead the file ``mimetypemapping.json`` should be created and modified, this file has precedence over the shipped file. diff --git a/admin_manual/configuration_server/activity_configuration.rst b/admin_manual/configuration_server/activity_configuration.rst index 142468a007a..bfc11fa9b4e 100644 --- a/admin_manual/configuration_server/activity_configuration.rst +++ b/admin_manual/configuration_server/activity_configuration.rst @@ -1,7 +1,7 @@ Configuring the Activity App ============================ -You can configure your ownCloud server to automatically send out e-mail notifications +You can configure your Nextcloud server to automatically send out e-mail notifications to your users for various events like: * A file or folder has been shared @@ -16,12 +16,12 @@ Enabling the Activity App ------------------------- The Activity App is shipped and enabled by default. If it is not enabled -simply go to your ownCloud Apps page to enable it. +simply go to your Nextcloud Apps page to enable it. -Configuring your ownCloud for the Activity App +Configuring your Nextcloud for the Activity App ---------------------------------------------- -To configure your ownCloud to send out e-mail notifications a working +To configure your Nextcloud to send out e-mail notifications a working :doc:`email_configuration` is mandatory. Furthermore it is recommended to configure the background job ``Webcron`` or diff --git a/admin_manual/configuration_server/antivirus_configuration.rst b/admin_manual/configuration_server/antivirus_configuration.rst index 8bf8132b13a..decfa31aeb5 100644 --- a/admin_manual/configuration_server/antivirus_configuration.rst +++ b/admin_manual/configuration_server/antivirus_configuration.rst @@ -1,10 +1,10 @@ Configuring the ClamAV Antivirus Scanner ======================================== -You can configure your ownCloud server to automatically run a virus scan on +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 -`_ with ownCloud. ClamAV detects all forms +`_ 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 @@ -12,9 +12,9 @@ daemon automatically updates its malware signature database at scheduled intervals. ClamAV runs on Linux and any Unix-type operating system, and Microsoft Windows. -However, it has only been tested with ownCloud on Linux, so these instructions +However, it has only been tested with Nextcloud on Linux, so these instructions are for Linux systems. You must first install ClamAV, and then install and -configure the Antivirus App for Files on ownCloud. +configure the Antivirus App for Files on Nextcloud. Installing ClamAV ----------------- @@ -77,14 +77,14 @@ and ``freshclam.conf`` until it is running the way you want. Enabling the Antivirus App for Files ------------------------------------ -Simply go to your ownCloud Apps page to enable it. +Simply go to your Nextcloud Apps page to enable it. .. figure:: ../images/antivirus-app.png -Configuring ClamAV on ownCloud ------------------------------- +Configuring ClamAV on Nextcloud +------------------------------- -Next, go to your ownCloud Admin page and set your ownCloud logging level to +Next, go to your Nextcloud Admin page and set your Nextcloud logging level to Everything. .. figure:: ../images/antivirus-logging.png @@ -95,21 +95,21 @@ Now find your Antivirus Configuration panel on your Admin page. ClamAV runs in one of three modes: -* Daemon (Socket): ClamAV is running on the same server as ownCloud. The ClamAV +* Daemon (Socket): ClamAV is running on the same server as Nextcloud. The ClamAV daemon, ``clamd``, runs in the background. When there is no activity ``clamd`` places a minimal load on your system. If your users upload large volumes of files you will see high CPU usage. * Daemon: ClamAV is running on a different server. This is a good option - for ownCloud servers with high volumes of file uploads. + for Nextcloud servers with high volumes of file uploads. -* Executable: ClamAV is running on the same server as ownCloud, and the +* Executable: ClamAV is running on the same server as Nextcloud, and the ``clamscan`` command is started and then stopped with each file upload. ``clamscan`` is slow and not always reliable for on-demand usage; it is better to use one of the daemon modes. Daemon (Socket) - ownCloud should detect your ``clamd`` socket and fill in the ``Socket`` + Nextcloud should detect your ``clamd`` socket and fill in the ``Socket`` field. This is the ``LocalSocket`` option in ``clamd.conf``. You can run ``netstat`` to verify:: @@ -135,7 +135,7 @@ Daemon Executable The Executable option requires the path to ``clamscan``, which is the - interactive ClamAV scanning command. ownCloud should find it automatically. + interactive ClamAV scanning command. Nextcloud should find it automatically. .. figure:: ../images/antivirus-executable.png diff --git a/admin_manual/configuration_server/caching_configuration.rst b/admin_manual/configuration_server/caching_configuration.rst index d64f0ce27a7..e3c04bc590c 100644 --- a/admin_manual/configuration_server/caching_configuration.rst +++ b/admin_manual/configuration_server/caching_configuration.rst @@ -2,11 +2,11 @@ Configuring Memory Caching ========================== -You can significantly improve your ownCloud server performance with memory +You can significantly improve your Nextcloud server performance with memory caching, where frequently-requested objects are stored in memory for faster retrieval. There are two types of caches to use: a PHP opcode cache, which is commonly called *opcache*, and data caching for your Web server. If you do not -install and enable a local memcache you will see a warning on your ownCloud +install and enable a local memcache you will see a warning on your Nextcloud admin page. **A memcache is not required and you may safely ignore the warning if you prefer.** @@ -19,7 +19,7 @@ every time they are called. PHP bundles the Zend OPcache in core since version 5.5, so you don't need to install an opcache for PHP 5.5+. If you are using PHP 5.4, which is the oldest supported PHP version for -ownCloud, you may install the Alternative PHP Cache (APC). This is both an +Nextcloud, you may install the Alternative PHP Cache (APC). This is both an opcache and data cache. APC has not been updated since 2012 and is essentially dead, and PHP 5.4 is old and lags behind later releases. If it is possible to upgrade to a later PHP release that is the best option. @@ -27,7 +27,7 @@ to upgrade to a later PHP release that is the best option. Data caching is supplied by the Alternative PHP Cache, user (APCu) in PHP 5.5+, Memcached, or Redis. -ownCloud supports multiple memory caching backends, so you can choose the type +Nextcloud supports multiple memory caching backends, so you can choose the type of memcache that best fits your needs. The supported caching backends are: * `APC `_ @@ -35,11 +35,11 @@ of memcache that best fits your needs. The supported caching backends are: * `APCu `_, APCu 4.0.6 and up required. A local cache for systems running PHP 5.5 and up. * `Memcached `_ - Distributed cache for multi-server ownCloud installations. + Distributed cache for multi-server Nextcloud installations. * `Redis `_, PHP module 2.2.5 and up required. For distributed caching. -Memcaches must be explicitly configured in ownCloud 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). @@ -52,10 +52,10 @@ APC --- APC is only for systems running PHP 5.4 and older. The oldest supported PHP -version in ownCloud is 5.4. +version in Nextcloud is 5.4. .. note:: RHEL 6 and CentOS 6 ship with PHP 5.3 and must be upgraded to PHP - 5.4 to run ownCloud. See :doc:`../installation/php_54_installation`. + 5.4 to run Nextcloud. See :doc:`../installation/php_54_installation`. On Red Hat/CentOS/Fedora systems running PHP 5.4, install ``php-pecl-apc``. On Debian/Ubuntu/Mint systems install ``php-apc``. Then restart your Web server. @@ -64,7 +64,7 @@ After restarting your Web server, add this line to your ``config.php`` file:: 'memcache.local' => '\OC\Memcache\APC', -Refresh your ownCloud admin page, and the cache warning should disappear. +Refresh your Nextcloud admin page, and the cache warning should disappear. APCu ---- @@ -74,7 +74,7 @@ distributions it is enabled by default. However, it does not bundle a data cache. APCu is a data cache, and it is available in most Linux distributions. On Red Hat/CentOS/Fedora systems running PHP 5.5 and up install ``php-pecl-apcu``. On Debian/Ubuntu/Mint systems install ``php5-apcu``. -On Ubuntu 14.04LTS, the APCu version is 4.0.2, which is too old to use with ownCloud. ownCloud requires 4.0.6+. You may install 4.0.7 from Ubuntu backports with this command:: +On Ubuntu 14.04LTS, the APCu version is 4.0.2, which is too old to use with Nextcloud. Nextcloud requires 4.0.6+. You may install 4.0.7 from Ubuntu backports with this command:: apt-get install php5-apcu/trusty-backports @@ -84,19 +84,19 @@ After restarting your Web server, add this line to your ``config.php`` file:: 'memcache.local' => '\OC\Memcache\APCu', -Refresh your ownCloud admin page, and the cache warning should disappear. +Refresh your Nextcloud admin page, and the cache warning should disappear. Memcached --------- Memcached is a reliable oldtimer for shared caching on distributed servers, -and performs well with ownCloud with one exception: it is not suitable to use +and performs well with Nextcloud with one exception: it is not suitable to use with :doc:`Transactional File Locking <../configuration_files/files_locking_transactional>` because it does not store locks, and data can disappear from the cache at any time (Redis is the best memcache for this). .. note:: Be sure to install the **memcached** PHP module, and not memcache, as - in the following examples. ownCloud supports only the **memcached** PHP + in the following examples. Nextcloud supports only the **memcached** PHP module. Setting up Memcached is easy. On Debian/Ubuntu/Mint install ``memcached`` and @@ -115,7 +115,7 @@ You can verify that the Memcached daemon is running with ``ps ax``:: 127.0.0.1 Restart your Web server, add the appropriate entries to your -``config.php``, and refresh your ownCloud admin page. This example uses APCu +``config.php``, and refresh your Nextcloud admin page. This example uses APCu for the local cache, Memcached as the distributed memcache, and lists all the servers in the shared cache pool with their port numbers:: @@ -153,7 +153,7 @@ You can verify that the Redis daemon is running with ``ps ax``:: 22203 ? Ssl 0:00 /usr/bin/redis-server 127.0.0.1:6379 Restart your Web server, add the appropriate entries to your ``config.php``, and -refresh your ownCloud admin page. This example ``config.php`` configuration uses +refresh your Nextcloud admin page. This example ``config.php`` configuration uses Redis for the local server cache:: 'memcache.local' => '\OC\Memcache\Redis', @@ -167,7 +167,7 @@ For best performance, use Redis for file locking by adding this:: 'memcache.locking' => '\OC\Memcache\Redis', If you want to connect to Redis configured to listen on an Unix socket (which is -recommended if Redis is running on the same system as ownCloud) use this example +recommended if Redis is running on the same system as Nextcloud) use this example ``config.php`` configuration:: 'memcache.local' => '\OC\Memcache\Redis', diff --git a/admin_manual/configuration_server/config_sample_php_parameters.rst b/admin_manual/configuration_server/config_sample_php_parameters.rst index 414ef9f9371..ca96e07365a 100644 --- a/admin_manual/configuration_server/config_sample_php_parameters.rst +++ b/admin_manual/configuration_server/config_sample_php_parameters.rst @@ -19,10 +19,10 @@ 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 -ownCloud, and the values in these files take precedence over :file:`config.php`. +Nextcloud, and the values in these files take precedence over :file:`config.php`. .. The following section is auto-generated from -.. https://github.com/owncloud/core/blob/master/config/config.sample.php +.. 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 @@ -152,9 +152,9 @@ installation. Default config.php Examples --------------------------- When you use SQLite as your Nextcloud database, your ``config.php`` looks like -this after installation. The SQLite database is stored in your ownCloud +this after installation. The SQLite database is stored in your Nextcloud ``data/`` directory. SQLite is a simple, lightweight embedded database that -is good for testing and for simple installations, but for production ownCloud +is good for testing and for simple installations, but for production Nextcloud systems you should use MySQL, MariaDB, or PosgreSQL. :: @@ -190,7 +190,7 @@ This example is from a new Nextcloud installation using MariaDB:: 'datadirectory' => '/var/www/nextcloud/data', 'dbtype' => 'mysql', 'version' => '7.0.2.1', - 'dbname' => 'owncloud', + 'dbname' => 'nextcloud', 'dbhost' => 'localhost', 'dbtableprefix' => 'oc_', 'dbuser' => 'oc_carla', @@ -531,7 +531,7 @@ to be deleted. Both minimum and maximum times can be set together to explicitly define file and folder deletion. For migration purposes, this setting is installed initially set to "auto", which is equivalent to the default setting in -ownCloud 8.1 and before. +Nextcloud 8.1 and before. Available values: @@ -572,7 +572,7 @@ to be deleted. Both minimum and maximum times can be set together to explicitly define version deletion. For migration purposes, this setting is installed initially set to "auto", which is equivalent to the default setting in -ownCloud 8.1 and before. +Nextcloud 8.1 and before. Available values: @@ -774,7 +774,7 @@ Some of the Nextcloud code may be stored in alternate locations. 'customclient_android' => 'https://play.google.com/store/apps/details?id=com.nextcloud.client', 'customclient_ios' => - 'https://itunes.apple.com/us/app/owncloud/id543672169?mt=8', + 'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8', This section is for configuring the download links for Nextcloud clients, as seen in the first-run wizard and on Personal pages. @@ -793,7 +793,7 @@ When enabled, admins may install apps from the Nextcloud app store. :: - 'appstoreurl' => 'https://api.owncloud.com/v1', + 'appstoreurl' => 'https://api.nextcloud.com/v1', The URL of the appstore to use. @@ -1303,12 +1303,12 @@ AES-256-CFB are supported. 'minimum.supported.desktop.version' => '1.7.0', -The minimum ownCloud desktop client version that will be allowed to sync with +The minimum Nextcloud desktop client version that will be allowed to sync with this server instance. All connections made from earlier clients will be denied -by the server. Defaults to the minimum officially supported ownCloud desktop +by the server. Defaults to the minimum officially supported Nextcloud desktop clientversion at the time of release of this server version. -When changing this, note that older unsupported versions of the ownCloud desktop +When changing this, note that older unsupported versions of the Nextcloud desktop client may not function as expected, and could lead to permanent data loss for clients or other unexpected results. diff --git a/admin_manual/configuration_server/custom_client_repos.rst b/admin_manual/configuration_server/custom_client_repos.rst index 3e7880962d9..a7ac0ad40dc 100644 --- a/admin_manual/configuration_server/custom_client_repos.rst +++ b/admin_manual/configuration_server/custom_client_repos.rst @@ -2,7 +2,7 @@ Custom Client Download Repositories =================================== -You may configure the URLs to your own download repositories for your ownCloud +You may configure the URLs to your own download repositories for your Nextcloud desktop clients and mobile apps in :file:`config/config.php`. This example shows the default download locations: @@ -12,7 +12,7 @@ the default download locations: "customclient_desktop" => "https://nextcloud.com/install/", "customclient_android" => "https://play.google.com/store/apps/details?id=com.nextcloud.client", - "customclient_ios" => "https://itunes.apple.com/us/app/owncloud/id543672169?mt=8", + "customclient_ios" => "https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8", Simply replace the URLs with the links to your own preferred download repos. diff --git a/admin_manual/configuration_server/email_configuration.rst b/admin_manual/configuration_server/email_configuration.rst index 979d0981cfe..05b2daa5b8f 100644 --- a/admin_manual/configuration_server/email_configuration.rst +++ b/admin_manual/configuration_server/email_configuration.rst @@ -1,26 +1,26 @@ Email Configuration =================== -ownCloud is capable of sending password reset emails, notifying users of new +Nextcloud is capable of sending password reset emails, notifying users of new file shares, changes in files, and activity notifications. Your users configure which notifications they want to receive on their Personal pages. -ownCloud does not contain a full email server, but rather connects to your -existing mail server. You must have a functioning mail server for ownCloud to be -able to send emails. You may have a mail server on the same machine as ownCloud, +Nextcloud does not contain a full email server, but rather connects to your +existing mail server. You must have a functioning mail server for Nextcloud to be +able to send emails. You may have a mail server on the same machine as Nextcloud, or it may be a remote server. -ownCloud 7 introduces a new feature, the graphical Email Configuration Wizard. +Nextcloud 7 introduces a new feature, the graphical Email Configuration Wizard. .. figure:: ../images/smtp-config-wizard.png -With the new wizard, connecting ownCloud to your mail server is fast and easy. +With the new wizard, connecting Nextcloud to your mail server is fast and easy. The wizard fills in the values in ``config/config.php``, so you may use either or both as you prefer. -The ownCloud Email wizard supports three types of mail server connections: +The Nextcloud Email wizard supports three types of mail server connections: SMTP, PHP, and Sendmail. Use the SMTP configurator for a remote server, and PHP -or Sendmail when your mail server is on the same machine as ownCloud. +or Sendmail when your mail server is on the same machine as Nextcloud. .. note:: The Sendmail option refers to the Sendmail SMTP server, and any drop-in Sendmail replacement such as Postfix, Exim, or Courier. All of @@ -30,11 +30,11 @@ Configuring an SMTP Server -------------------------- You need the following information from your mailserver administrator to -connect ownCloud to a remote SMTP server: +connect Nextcloud to a remote SMTP server: * Encryption type: None, SSL, or TLS -* The From address you want your outgoing ownCloud mails to use +* The From address you want your outgoing Nextcloud mails to use * Whether authentication is required @@ -53,8 +53,8 @@ configured on your Personal page. The test message says:: If you received this email, the settings seem to be correct. -- - ownCloud - web services under your control + Nextcloud + a safe home for all your data Configuring PHP and Sendmail ---------------------------- @@ -79,7 +79,7 @@ Using Email Templates --------------------- Another useful new feature is editable email templates. Now you can edit -ownCloud's email templates on your Admin page. These are your available +Nextcloud's email templates on your Admin page. These are your available templates: * Sharing email (HTML) -- HTML version of emails notifying users of new file @@ -237,7 +237,7 @@ PHP mail If you want to use PHP mail it is necessary to have an installed and working email system on your server. Which program in detail is used to send email is defined by the configuration settings in the **php.ini** file. (On \*nix -systems this will most likely be Sendmail.) ownCloud should be able to send +systems this will most likely be Sendmail.) Nextcloud should be able to send email out of the box. :: @@ -259,7 +259,7 @@ Sendmail If you want to use the well known Sendmail program to send email, it is necessary to have an installed and working email system on your \*nix server. The sendmail binary (**/usr/sbin/sendmail**) is usually part of that system. -ownCloud should be able to send email out of the box. +Nextcloud should be able to send email out of the box. :: @@ -280,7 +280,7 @@ qmail If you want to use the qmail program to send email, it is necessary to have an installed and working qmail email system on your server. The sendmail binary -(**/var/qmail/bin/sendmail**) will then be used to send email. ownCloud should +(**/var/qmail/bin/sendmail**) will then be used to send email. Nextcloud should be able to send email out of the box. :: @@ -324,7 +324,7 @@ the ``mail_smtpdebug parameter`` in ``config/config.php``. **Question**: Why is my web domain different from my mail domain? **Answer**: The default domain name used for the sender address is the hostname -where your ownCloud installation is served. If you have a different mail domain +where your Nextcloud installation is served. If you have a different mail domain name you can override this behavior by setting the following configuration parameter: @@ -334,7 +334,7 @@ parameter: "mail_domain" => "example.com", -This setting results in every email sent by ownCloud (for example, the password +This setting results in every email sent by Nextcloud (for example, the password reset email) having the domain part of the sender address appear as follows:: no-reply@example.com diff --git a/admin_manual/configuration_server/external_sites.rst b/admin_manual/configuration_server/external_sites.rst index 49430f41477..d736c140985 100644 --- a/admin_manual/configuration_server/external_sites.rst +++ b/admin_manual/configuration_server/external_sites.rst @@ -2,7 +2,7 @@ Linking External Sites ====================== -You can embed external Web sites inside your ownCloud pages with the External +You can embed external Web sites inside your Nextcloud pages with the External Sites app, as this screenshot shows. .. figure:: ../images/external-sites-1.png @@ -11,12 +11,12 @@ Sites app, as this screenshot shows. *Click to enlarge* This is useful for quick access to important Web pages such as the -ownCloud manuals and informational pages for your company, and for presenting -external pages inside your custom ownCloud branding, if you use your own custom +Nextcloud manuals and informational pages for your company, and for presenting +external pages inside your custom Nextcloud branding, if you use your own custom themes. -The External sites app is included in all versions of ownCloud. Go to **Apps > -Not Enabled** to enable it. Then go to your ownCloud Admin page to create your +The External sites app is included in all versions of Nextcloud. Go to **Apps > +Not Enabled** to enable it. Then go to your Nextcloud Admin page to create your links, which are saved automatically. There is a dropdown menu to select an icon, but there is only one default icon so you don't have to select one. Hover your cursor to the right of your links to make the trashcan icon appear when you @@ -27,7 +27,7 @@ want to remove them. *Click to enlarge* -The links appear in the ownCloud dropdown menu on the top left after +The links appear in the Nextcloud dropdown menu on the top left after refreshing your page, and have globe icons. .. figure:: ../images/external-sites-3.png @@ -37,10 +37,10 @@ browsers and Web sites handle HTTP and HTTPS URLs, and because the External Sites app embeds external links in IFrames. Modern Web browsers try very hard to protect Web surfers from dangerous links, and safety apps like `Privacy Badger `_ and ad-blockers may block -embedded pages. It is strongly recommended to enforce HTTPS on your ownCloud +embedded pages. It is strongly recommended to enforce HTTPS on your Nextcloud server; do not weaken this, or any of your security tools, just to make embedded Web pages work. After all, you can freely access them outside of -ownCloud. +Nextcloud. Most Web sites that offer login functionalities use the ``X-Frame-Options`` or ``Content-Security-Policy`` HTTP header which instructs browsers to not diff --git a/admin_manual/configuration_server/harden_server.rst b/admin_manual/configuration_server/harden_server.rst index 4954b5bef27..e515a4b5aa0 100644 --- a/admin_manual/configuration_server/harden_server.rst +++ b/admin_manual/configuration_server/harden_server.rst @@ -2,23 +2,23 @@ Hardening and Security Guidance =============================== -ownCloud aims to ship with secure defaults that do not need to get modified by +Nextcloud aims to ship with secure defaults that do not need to get modified by administrators. However, in some cases some additional security hardening can be applied in scenarios were the administrator has complete control over -the ownCloud instance. This page assumes that you run ownCloud Server on Apache2 +the Nextcloud instance. This page assumes that you run Nextcloud Server on Apache2 in a Linux environment. -.. note:: ownCloud will warn you in the administration interface if some +.. note:: Nextcloud will warn you in the administration interface if some critical security-relevant options are missing. However, it is still up to the server administrator to review and maintain system security. Limit on Password Length ------------------------ -ownCloud uses the bcrypt algorithm, and thus for security and performance +Nextcloud uses the bcrypt algorithm, and thus for security and performance reasons, e.g. Denial of Service as CPU demand increases exponentially, it only verifies the first 72 characters of passwords. This applies to all passwords -that you use in ownCloud: user passwords, passwords on link shares, and +that you use in Nextcloud: user passwords, passwords on link shares, and passwords on external shares. Operating system @@ -27,11 +27,11 @@ Operating system .. _dev-urandom-label: Give PHP read access to ``/dev/urandom`` -***************************************** +**************************************** -ownCloud uses a `RFC 4086 ("Randomness Requirements for Security")`_ compliant +Nextcloud uses a `RFC 4086 ("Randomness Requirements for Security")`_ compliant mixer to generate cryptographically secure pseudo-random numbers. This means -that when generating a random number ownCloud will request multiple random +that when generating a random number Nextcloud will request multiple random numbers from different sources and derive from these the final random number. The random number generation also tries to request random numbers from @@ -65,7 +65,7 @@ installation. Disable preview image generation ******************************** -ownCloud is able to generate preview images of common filetypes such as images +Nextcloud is able to generate preview images of common filetypes such as images or text files. By default the preview generation for some file types that we consider secure enough for deployment is enabled by default. However, administrators should be aware that these previews are generated using PHP @@ -81,7 +81,7 @@ modifying the ``enabledPreviewProviders`` option switch. Use HTTPS --------- -Using ownCloud without using an encrypted HTTPS connection opens up your server +Using Nextcloud without using an encrypted HTTPS connection opens up your server to a man-in-the-middle (MITM) attack, and risks the interception of user data and passwords. It is a best practice, and highly recommended, to always use HTTPS on production servers, and to never allow unencrypted HTTP. @@ -110,7 +110,7 @@ Enable HTTP Strict Transport Security While redirecting all traffic to HTTPS is good, it may not completely prevent man-in-the-middle attacks. Thus administrators are encouraged to set the HTTP Strict Transport Security header, which instructs browsers to not allow any -connection to the ownCloud instance using HTTP, and it attempts to prevent site +connection to the Nextcloud instance using HTTP, and it attempts to prevent site visitors from bypassing invalid certificate warnings. This can be achieved by setting the following settings within the Apache @@ -136,35 +136,35 @@ 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 +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. -Use a dedicated domain for ownCloud ------------------------------------ +Use a dedicated domain for Nextcloud +------------------------------------ -Administrators are encouraged to install ownCloud on a dedicated domain such as +Administrators are encouraged to install Nextcloud on a dedicated domain such as cloud.domain.tld instead of domain.tld to gain all the benefits offered by the Same-Origin-Policy. -Ensure that your ownCloud instance is installed in a DMZ --------------------------------------------------------- +Ensure that your Nextcloud instance is installed in a DMZ +--------------------------------------------------------- -As ownCloud supports features such as Federated File Sharing we do not consider +As Nextcloud supports features such as Federated File Sharing we do not consider Server Side Request Forgery (SSRF) part of our threat model. In fact, given all our external storage adapters this can be considered a feature and not a vulnerability. -This means that a user on your ownCloud instance could probe whether other hosts -are accessible from the ownCloud network. If you do not want this you need to -ensure that your ownCloud is properly installed in a segregated network and proper +This means that a user on your Nextcloud instance could probe whether other hosts +are accessible from the Nextcloud network. If you do not want this you need to +ensure that your Nextcloud is properly installed in a segregated network and proper firewall rules are in place. Serve security related Headers by the Web server ------------------------------------------------ -Basic security headers are served by ownCloud already in a default environment. +Basic security headers are served by Nextcloud already in a default environment. These include: - ``X-Content-Type-Options: nosniff`` @@ -174,9 +174,9 @@ These include: - ``X-Robots-Tag: none`` - Instructs search machines to not index these pages. - ``X-Frame-Options: SAMEORIGIN`` - - Prevents embedding of the ownCloud instance within an iframe from other domains to prevent Clickjacking and other similar attacks. + - Prevents embedding of the Nextcloud instance within an iframe from other domains to prevent Clickjacking and other similar attacks. -These headers are hard-coded into the ownCloud server, and need no intervention +These headers are hard-coded into the Nextcloud server, and need no intervention by the server administrator. For optimal security, administrators are encouraged to serve these basic HTTP diff --git a/admin_manual/configuration_server/images/theming-log-in-page.png b/admin_manual/configuration_server/images/theming-log-in-page.png new file mode 100644 index 00000000000..bab36e98ba8 Binary files /dev/null and b/admin_manual/configuration_server/images/theming-log-in-page.png differ diff --git a/admin_manual/configuration_server/images/theming.png b/admin_manual/configuration_server/images/theming.png new file mode 100644 index 00000000000..661aedf429d Binary files /dev/null and b/admin_manual/configuration_server/images/theming.png differ diff --git a/admin_manual/configuration_server/index.rst b/admin_manual/configuration_server/index.rst index 92e25b1cac9..364dd663f92 100644 --- a/admin_manual/configuration_server/index.rst +++ b/admin_manual/configuration_server/index.rst @@ -1,6 +1,6 @@ -============================= -ownCloud Server Configuration -============================= +============================== +Nextcloud Server Configuration +============================== .. toctree:: :maxdepth: 2 @@ -24,4 +24,4 @@ ownCloud Server Configuration js_css_asset_management_configuration automatic_configuration oc_server_tuning - \ No newline at end of file + theming diff --git a/admin_manual/configuration_server/js_css_asset_management_configuration.rst b/admin_manual/configuration_server/js_css_asset_management_configuration.rst index 69b68737017..4a06e3a2047 100644 --- a/admin_manual/configuration_server/js_css_asset_management_configuration.rst +++ b/admin_manual/configuration_server/js_css_asset_management_configuration.rst @@ -3,11 +3,11 @@ JavaScript and CSS Asset Management In production environments, JavaScript and CSS files should be delivered in a concatenated and compressed format. -ownCloud can automatically collect all JavaScript and CSS files, aggregate and compress them to then save the result in a folder called 'assets' which can be found in the folder where ownCloud has been installed. +Nextcloud can automatically collect all JavaScript and CSS files, aggregate and compress them to then save the result in a folder called 'assets' which can be found in the folder where Nextcloud has been installed. -If your Web server has write access to your ownCloud installation, then the 'assets' folder will be automatically created for you, otherwise, you need to create it yourself before enabling that option and you must give write access to your Web server user. +If your Web server has write access to your Nextcloud installation, then the 'assets' folder will be automatically created for you, otherwise, you need to create it yourself before enabling that option and you must give write access to your Web server user. -Assets found in that folder will from now on be served as static files by your Web server and will be automatically refreshed whenever ownCloud or one of its apps is updated. +Assets found in that folder will from now on be served as static files by your Web server and will be automatically refreshed whenever Nextcloud or one of its apps is updated. It's important to note that apps installed via git might not always update their version number with every commit and this could lead to an out-of-sync asset folder. It is not recommended to enable asset-pipelining when using apps pulled via git. diff --git a/admin_manual/configuration_server/knowledgebase_configuration.rst b/admin_manual/configuration_server/knowledgebase_configuration.rst index 18346b34026..f50b1fbb322 100644 --- a/admin_manual/configuration_server/knowledgebase_configuration.rst +++ b/admin_manual/configuration_server/knowledgebase_configuration.rst @@ -1,13 +1,13 @@ Knowledge Base Configuration ============================ -The usage of ownCloud is more or less self explaining but nevertheless a user -might run into a problem where he needs to consult the documentation or knowledge base. To ease access to the ownCloud +The usage of Nextcloud is more or less self explaining but nevertheless a user +might run into a problem where he needs to consult the documentation or knowledge base. To ease access to the Nextcloud documentation and knowledge base, a help menu item is shown in the settings menu by default. Parameters ---------- -If you want to disable the ownCloud help menu item you can use the **knowledgebaseenabled** parameter inside the +If you want to disable the Nextcloud help menu item you can use the **knowledgebaseenabled** parameter inside the :file:`config/config.php`. :: diff --git a/admin_manual/configuration_server/language_configuration.rst b/admin_manual/configuration_server/language_configuration.rst index 82abe30b40c..e713fd11e8d 100644 --- a/admin_manual/configuration_server/language_configuration.rst +++ b/admin_manual/configuration_server/language_configuration.rst @@ -1,8 +1,8 @@ Language Configuration ====================== -In normal cases ownCloud will automatically detect the language of the Web-GUI. -If this does not work properly or you want to make sure that ownCloud always +In normal cases Nextcloud will automatically detect the language of the Web-GUI. +If this does not work properly or you want to make sure that Nextcloud always starts with a given language, you can use the **default_language** parameter. Please keep in mind, that this will not effect a users language preference, diff --git a/admin_manual/configuration_server/logging_configuration.rst b/admin_manual/configuration_server/logging_configuration.rst index 4124f5c3f65..f2f3a706748 100644 --- a/admin_manual/configuration_server/logging_configuration.rst +++ b/admin_manual/configuration_server/logging_configuration.rst @@ -2,7 +2,7 @@ Logging Configuration ===================== -Use your ownCloud log to review system status, or to help debug problems. You may adjust logging levels, and choose between using the ownCloud log or your syslog. +Use your Nextcloud log to review system status, or to help debug problems. You may adjust logging levels, and choose between using the Nextcloud log or your syslog. Parameters ---------- @@ -17,14 +17,14 @@ Logging levels range from **DEBUG**, which logs all activity, to **FATAL**, whic By default the log level is set to **2** (WARN). Use **DEBUG** when you have a problem to diagnose, and then reset your log level to a less-verbose level as **DEBUG** outputs a lot of information, and can affect your server performance. -Logging level parameters are set in the :file:`config/config.php` file, or on the Admin page of your ownCloud Web GUI. +Logging level parameters are set in the :file:`config/config.php` file, or on the Admin page of your Nextcloud Web GUI. ownCloud ~~~~~~~~ All log information will be written to a separate log file which can be viewed using the log viewer on your Admin page. By default, a log -file named **owncloud.log** will be created in the directory which has +file named **nextcloud.log** will be created in the directory which has been configured by the **datadirectory** parameter in :file:`config/config.php`. The desired date format can optionally be defined using the **logdateformat** parameter in :file:`config/config.php`. @@ -36,7 +36,7 @@ date format in the example below, the date/time format will be written in the fo :: "log_type" => "owncloud", - "logfile" => "owncloud.log", + "logfile" => "nextcloud.log", "loglevel" => "3", "logdateformat" => "F d, Y H:i:s", diff --git a/admin_manual/configuration_server/oc_server_tuning.rst b/admin_manual/configuration_server/oc_server_tuning.rst index 58b1dcc6518..74405c9fb6b 100644 --- a/admin_manual/configuration_server/oc_server_tuning.rst +++ b/admin_manual/configuration_server/oc_server_tuning.rst @@ -1,6 +1,6 @@ -====================== -ownCloud Server Tuning -====================== +======================= +Nextcloud Server Tuning +======================= Using cron to perform background jobs ------------------------------------- @@ -20,19 +20,18 @@ Caching ------- Caching improves performance by storing data, code, and other objects in memory. -Memory cache configuration for the ownCloud server is no longer automatic in -ownCloud 8.1 and up, but must be installed and configured. See -:doc:`caching_configuration`. +Memory cache configuration for the Nextcloud server must be installed and configured. +See :doc:`caching_configuration`. Using MariaDB/MySQL instead of SQLite ------------------------------------- MySQL or MariaDB are preferred because of the `performance limitations of SQLite with highly concurrent applications -`_, like ownCloud. +`_, like Nextcloud. See the section :doc:`../configuration_database/linux_database_configuration` for how to -configure ownCloud for MySQL or MariaDB. If your installation is already running on +configure Nextcloud for MySQL or MariaDB. If your installation is already running on SQLite then it is possible to convert to MySQL or MariaDB using the steps provided in :doc:`../configuration_database/db_conversion`. @@ -42,7 +41,7 @@ Using Redis-based Transactional File Locking File locking is enabled by default, using the database locking backend. This places a significant load on your database. See the section :doc:`../configuration_files/files_locking_transactional` for how to -configure ownCloud to use Redis-based Transactional File Locking. +configure Nextcloud to use Redis-based Transactional File Locking. SSL / Encryption App -------------------- @@ -73,4 +72,4 @@ AES-NI extension: coreinfo, it is maybe disabled in the BIOS. * If your environment runs virtualized, check the virtualization vendor for - support. \ No newline at end of file + support. diff --git a/admin_manual/configuration_server/occ_command.rst b/admin_manual/configuration_server/occ_command.rst index e231a3992ac..e20738f440d 100644 --- a/admin_manual/configuration_server/occ_command.rst +++ b/admin_manual/configuration_server/occ_command.rst @@ -2,17 +2,15 @@ Using the occ Command ===================== -ownCloud's ``occ`` command (ownCloud console) is ownCloud'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 ownCloud, manage users, encryption, passwords, LDAP +installing and upgrading Nextcloud, manage users, encryption, passwords, LDAP setting, and more. -``occ`` is in the :file:`owncloud/` directory; for example -:file:`/var/www/owncloud` on Ubuntu Linux. ``occ`` is a PHP script. **You must +``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 ownCloud files and directories. In ownCloud 8.2+ you may run it from -any directory (specifying the filepath); in previous releases it had to be -run from the :file:`owncloud/` directory. +on your Nextcloud files and directories. occ Command Directory --------------------- @@ -59,13 +57,13 @@ If your HTTP server is configured to use a different PHP version than the default (/usr/bin/php), ``occ`` should be run with the same version. For example, in CentOS 6.5 with SCL-PHP54 installed, the command looks like this:: - sudo -u apache /opt/rh/php54/root/usr/bin/php /var/www/html/owncloud/occ + sudo -u apache /opt/rh/php54/root/usr/bin/php /var/www/html/nextcloud/occ Running ``occ`` with no options lists all commands and options, like this example on Ubuntu:: sudo -u www-data php occ - ownCloud version 9.0.0 + Nextcloud version 9.0.0 Usage: command [options] [arguments] @@ -97,12 +95,12 @@ Run it with the ``-h`` option for syntax help:: sudo -u www-data php occ -h -Display your ownCloud version:: +Display your Nextcloud version:: sudo -u www-data php occ -V - ownCloud version 9.0.0 + Nextcloud version 9.0.0 -Query your ownCloud server status:: +Query your Nextcloud server status:: sudo -u www-data php occ status - installed: true @@ -167,7 +165,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 @@ -185,7 +182,7 @@ Disable an app:: sudo -u www-data php occ app:disable files_external files_external disabled -``app:check-code`` has multiple checks: it checks if an app uses ownCloud's +``app:check-code`` has multiple checks: it checks if an app uses Nextcloud's public API (``OCP``) or private API (``OC_``), and it also checks for deprecated methods and the validity of the ``info.xml`` file. By default all checks are enabled. The Activity app is an example of a correctly-formatted app:: @@ -196,7 +193,7 @@ enabled. The Activity app is an example of a correctly-formatted app:: If your app has issues, you'll see output like this:: sudo -u www-data php occ app:check-code foo_app - Analysing /var/www/owncloud/apps/files/foo_app.php + Analysing /var/www/nextcloud/apps/files/foo_app.php 4 errors line 45: OCP\Response - Static method of deprecated class must not be called @@ -209,7 +206,7 @@ If your app has issues, you'll see output like this:: You can get the full filepath to an app:: sudo -u www-data php occ app:getpath notifications - /var/www/owncloud/apps/notifications + /var/www/nextcloud/apps/notifications .. _background_jobs_selector_label: @@ -218,7 +215,7 @@ Background Jobs Selector Use the ``background`` command to select which scheduler you want to use for controlling background jobs, Ajax, Webcron, or Cron. This is the same as using -the **Cron** section on your ownCloud Admin page:: +the **Cron** section on your Nextcloud Admin page:: background background:ajax Use ajax to run background jobs @@ -242,7 +239,7 @@ See :doc:`../configuration_server/background_jobs_configuration` to learn more. Config Commands --------------- -The ``config`` commands are used to configure the ownCloud server:: +The ``config`` commands are used to configure the Nextcloud server:: config config:app:delete Delete an app config value @@ -279,7 +276,7 @@ It is also possible to import remote files, by piping the input:: .. note:: While it is possible to update/set/delete the versions and installation - statuses of apps and ownCloud itself, it is **not** recommended to do this + statuses of apps and Nextcloud itself, it is **not** recommended to do this directly. Use the ``occ app:enable``, ``occ app:disable`` and ``occ update`` commands instead. @@ -328,7 +325,7 @@ When you want to e.g. disable the maintenance mode run the following command:: sudo -u www-data php occ config:system:set maintenance --value=false --type=boolean - ownCloud is in maintenance mode - no app have been loaded + Nextcloud is in maintenance mode - no app have been loaded System config value maintenance set to boolean false Setting an array Configuration Value @@ -340,7 +337,7 @@ In order to set (and also get) the value of one key, you can specify multiple sudo -u www-data php occ config:system:get trusted_domains localhost - owncloud.local + nextcloud.local sample.tld To replace ``sample.tld`` with ``example.com`` trusted_domains => 2 needs to be @@ -352,7 +349,7 @@ set:: sudo -u www-data php occ config:system:get trusted_domains localhost - owncloud.local + nextcloud.local example.com Deleting a Single Configuration Value @@ -419,7 +416,7 @@ Run this command to migrate calendars:: sudo -u www-data php occ dav:migrate-calendars [user] -See `ownCloud 9.0 - calendar migration analysis +See `ownCloud 9.0 - calendar migration analysis `_ for help with troubleshooting and reporting problems. @@ -433,15 +430,13 @@ bernie:: addressbook:: sudo -u www-data php occ dav:sync-system-addressbook - -Added in 9.0. .. _database_conversion_label: Database Conversion ------------------- -The SQLite database is good for testing, and for ownCloud servers with small +The SQLite database is good for testing, and for Nextcloud servers with small single-user workloads that do not use sync clients, but production servers with multiple users should use MariaDB, MySQL, or PostgreSQL. You can use ``occ`` to convert from SQLite to one of these other databases. @@ -449,7 +444,7 @@ convert from SQLite to one of these other databases. :: db - db:convert-type Convert the ownCloud database to the newly + db:convert-type Convert the Nextcloud database to the newly configured one db:generate-change-script generates the change script from the current connected db to db_structure.xml @@ -518,7 +513,7 @@ see a list of modules only if you have enabled the Encryption app. Use ``encryption:set-default-module [module name]`` to set your desired module. ``encryption:encrypt-all`` encrypts all data files for all users. You must first -put your ownCloud server into :ref:`single-user +put your Nextcloud server into :ref:`single-user mode` to prevent any user activity until encryption is completed. @@ -528,12 +523,12 @@ user:: sudo -u www-data php occ encryption:decrypt freda Users must have enabled recovery keys on their Personal pages. You must first -put your ownCloud server into :ref:`single-user +put your Nextcloud server into :ref:`single-user mode ` to prevent any user activity until decryption is completed. Use ``encryption:disable`` to disable your encryption module. You must first put -your ownCloud server into :ref:`single-user mode ` +your Nextcloud server into :ref:`single-user mode ` to prevent any user activity. ``encryption:enable-master-key`` creates a new master key, which is used for all @@ -542,7 +537,7 @@ single-sign on. Use this only on fresh installations with no existing data, or on systems where encryption has not already been enabled. It is not possible to disable it. -``encryption:migrate`` migrates encryption keys after a major ownCloud version +``encryption:migrate`` migrates encryption keys after a major Nextcloud version upgrade. You may optionally specify individual users in a space-delimited list. See :doc:`../configuration_files/encryption_configuration` to learn more. @@ -556,31 +551,29 @@ Federation Sync This command is only available when the "Federation" app (``federation``) is enabled. -Synchronize the addressbooks of all federated ownCloud servers:: +Synchronize the addressbooks of all federated Nextcloud servers:: federation:sync-addressbooks Synchronizes addressbooks of all federated clouds -In ownCloud 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 --------------- -``occ`` has three commands for managing files in ownCloud:: +``occ`` has three commands for managing files in Nextcloud:: files 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 @@ -644,9 +637,6 @@ before removing a user:: Files External -------------- -These commands replace the ``data/mount.json`` configuration file used in -ownCloud releases before 9.0. - .. note:: These commands are only available when the "External storage support" app (``files_external``) is enabled. @@ -665,24 +655,22 @@ Commands for managing external storage:: files_external:option Manage mount options for a mount files_external:verify Verify mount configuration -These commands replicate the functionality in the ownCloud Web GUI, plus two new +These commands replicate the functionality in the Nextcloud Web GUI, plus two new features: ``files_external:export`` and ``files_external:import``. Use ``files_external:export`` to export all admin mounts to stdout, and ``files_external:export [user_id]`` to export the mounts of the specified -ownCloud user. +Nextcloud user. Use ``files_external:import [filename]`` to import legacy JSON configurations, -and to copy external mount configurations to another ownCloud server. - -Added in 9.0. +and to copy external mount configurations to another Nextcloud server. .. _integrity_check_label: Integrity Check --------------- -Apps which have an official tag MUST be code signed starting with ownCloud 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. @@ -699,13 +687,12 @@ Verify your app:: sudo -u www-data php occ integrity:check-app --path=/pathto/app appname When it returns nothing, your app is signed correctly. When it returns a message then there is an error. See `Code Signing -`_ in the Developer manual for more detailed information. +`_ in the Developer manual for more detailed information. +.. TODO ON RELEASE: Update version number above on release -``integrity:sign-core`` is for ownCloud core developers only. +``integrity:sign-core`` is for Nextcloud core developers only. See :doc:`../issues/code_signing` to learn more. - -Added in 9.0. .. _create_javascript_translation_files_label: @@ -713,7 +700,7 @@ l10n, Create Javascript Translation Files for Apps -------------------------------------------------- This command is for app developers to update their translation mechanism from -ownCloud 7 to ownCloud 8 and later. +ownCloud 7 to Nextcloud. .. _ldap_commands_label: @@ -736,7 +723,7 @@ you can run the following LDAP commands with ``occ``:: ldap:show-config shows the LDAP configuration ldap:show-remnants shows which users are not available on LDAP anymore, but have remnants in - ownCloud. + Nextcloud. ldap:test-config tests an LDAP configuration Search for an LDAP user, using this syntax:: @@ -760,7 +747,7 @@ User search attributes are set with ``ldap:set-config`` quickly. For example, you'll find Terri Hanson by searching for ``te ha``. Trailing whitespaces are ignored. -Check if an LDAP user exists. This works only if the ownCloud server is +Check if an LDAP user exists. This works only if the Nextcloud server is connected to an LDAP server:: sudo -u www-data php occ ldap:check-user robert @@ -819,17 +806,17 @@ documented in :doc:`../configuration_user/user_auth_ldap_cleanup`. Logging Commands ---------------- -These commands view and configure your ownCloud logging preferences:: +These commands view and configure your Nextcloud logging preferences:: log log:manage manage logging configuration - log:owncloud manipulate ownCloud logging backend + log:owncloud manipulate Nextcloud logging backend Run ``log:owncloud`` to see your current logging status:: sudo -u www-data php occ log:owncloud - Log backend ownCloud: enabled - Log file: /opt/owncloud/data/owncloud.log + Log backend Nextcloud: enabled + Log file: /opt/nextcloud/data/nextcloud.log Rotate at: disabled Use the ``--enable`` option to turn on logging. Use ``--file`` to set a @@ -847,7 +834,7 @@ are ``owncloud``, ``Warning``, and ``UTC``. Available options are: Maintenance Commands -------------------- -Use these commands when you upgrade ownCloud, manage encryption, perform +Use these commands when you upgrade Nextcloud, manage encryption, perform backups and other tasks that require locking users out until you are finished:: maintenance @@ -867,7 +854,7 @@ logged-in users must refresh their Web browsers to continue working:: sudo -u www-data php occ maintenance:mode --on sudo -u www-data php occ maintenance:mode --off -Putting your ownCloud server into single-user mode allows admins to log in and +Putting your Nextcloud server into single-user mode allows admins to log in and work, but not ordinary users. This is useful for performing maintenance and troubleshooting on a running server:: @@ -885,7 +872,7 @@ to:: sudo -u www-data php occ maintenance:repair -``maintenance:mimetype:update-db`` updates the ownCloud database and file cache +``maintenance:mimetype:update-db`` updates the Nextcloud database and file cache with changed mimetypes found in ``config/mimetypemapping.json``. Run this command after modifying ``config/mimetypemapping.json``. If you change a mimetype, run ``maintenance:mimetype:update-db --repair-filecache`` to apply the @@ -896,7 +883,7 @@ change to existing files. Security -------- -Use these commands to manage server-wide SSL certificates. These are useful when you create federation shares with other ownCloud servers that use self-signed certificates:: +Use these commands to manage server-wide SSL certificates. These are useful when you create federation shares with other Nextcloud servers that use self-signed certificates:: security security:certificates list trusted certificates @@ -989,7 +976,7 @@ memberships with the ``user:add`` command. The syntax is:: uid The ``display-name`` corresponds to the **Full Name** on the Users page in your -ownCloud Web UI, and the ``uid`` is their **Username**, which is their +Nextcloud Web UI, and the ``uid`` is their **Username**, which is their login name. This example adds new user Layla Smith, and adds her to the **users** and **db-admins** groups. Any groups that do not exist are created:: @@ -1127,22 +1114,19 @@ Command Line Installation ------------------------- These commands are available only after you have downloaded and unpacked the -ownCloud archive, and taken no further installation steps. +Nextcloud archive, and taken no further installation steps. -You can install ownCloud entirely from the command line. After downloading the -tarball and copying ownCloud into the appropriate directories, or -after installing ownCloud packages (See -:doc:`../installation/linux_installation` and -:doc:`../installation/source_installation`) you can use ``occ`` commands in -place of running the graphical Installation Wizard. +You can install Nextcloud entirely from the command line. After downloading the +tarball and copying Nextcloud into the appropriate directories you can use ``occ`` +commands in place of running the graphical Installation Wizard. -Apply correct permissions to your ownCloud directories; see +Apply correct permissions to your Nextcloud directories; see :ref:`strong_perms_label`. Then choose your ``occ`` options. This lists your available options:: - sudo -u www-data php /var/www/owncloud/occ - ownCloud is not installed - only a limited number of commands are available - ownCloud version 9.0.0 + sudo -u www-data php /var/www/nextcloud/occ + Nextcloud is not installed - only a limited number of commands are available + Nextcloud version 9.0.0 Usage: [options] command [arguments] @@ -1167,12 +1151,12 @@ available options:: l10n l10n:createjs Create javascript translation files for a given app maintenance - maintenance:install install ownCloud + maintenance:install install Nextcloud Display your ``maintenance:install`` options:: sudo -u www-data php occ help maintenance:install - ownCloud is not installed - only a limited number of commands are available + Nextcloud is not installed - only a limited number of commands are available Usage: maintenance:install [--database="..."] [--database-name="..."] [--database-host="..."] [--database-user="..."] [--database-pass[="..."]] @@ -1189,7 +1173,7 @@ Display your ``maintenance:install`` options:: --admin-user User name of the admin account (default: "admin") --admin-pass Password of the admin account --data-dir Path to data directory (default: - "/var/www/owncloud/data") + "/var/www/nextcloud/data") --help (-h) Display this help message --quiet (-q) Do not output any message --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal @@ -1201,19 +1185,19 @@ Display your ``maintenance:install`` options:: This example completes the installation:: - cd /var/www/owncloud/ + cd /var/www/nextcloud/ sudo -u www-data php occ maintenance:install --database - "mysql" --database-name "owncloud" --database-user "root" --database-pass + "mysql" --database-name "nextcloud" --database-user "root" --database-pass "password" --admin-user "admin" --admin-pass "password" - ownCloud is not installed - only a limited number of commands are available - ownCloud was successfully installed + Nextcloud is not installed - only a limited number of commands are available + Nextcloud was successfully installed Supported databases are:: - - sqlite (SQLite3 - ownCloud Community edition only) + - sqlite (SQLite3 - Nextcloud Community edition only) - mysql (MySQL/MariaDB) - pgsql (PostgreSQL) - - oci (Oracle - ownCloud Enterprise edition only) + - oci (Oracle - Nextcloud Enterprise edition only) .. _command_line_upgrade_label: @@ -1244,7 +1228,7 @@ List all options, like this example on CentOS Linux:: --no-ansi Disable ANSI output. --no-interaction (-n) Do not ask any interactive question -When you are performing an update or upgrade on your ownCloud server (see the +When you are performing an update or upgrade on your Nextcloud server (see the Maintenance section of this manual), it is better to use ``occ`` to perform the database upgrade step, rather than the Web GUI, in order to avoid timeouts. PHP scripts invoked from the Web interface are limited to 3600 seconds. In larger @@ -1254,7 +1238,7 @@ state. After performing all the preliminary steps (see like this example on CentOS Linux. Note how it details the steps:: sudo -u www-data php occ upgrade - ownCloud or one of the apps require upgrade - only a limited number of + Nextcloud or one of the apps require upgrade - only a limited number of commands are available Turned on maintenance mode Checked database schema update @@ -1270,7 +1254,7 @@ like this example on CentOS Linux. Note how it details the steps:: Enabling verbosity displays timestamps:: sudo -u www-data php occ upgrade -v - ownCloud or one of the apps require upgrade - only a limited number of commands are available + Nextcloud or one of the apps require upgrade - only a limited number of commands are available 2015-06-23T09:06:15+0000 Turned on maintenance mode 2015-06-23T09:06:15+0000 Checked database schema update 2015-06-23T09:06:15+0000 Checked database schema update for apps @@ -1280,7 +1264,7 @@ Enabling verbosity displays timestamps:: 2015-06-23T09:06:15+0000 Turned off maintenance mode If there is an error it throws an exception, and the error is detailed in your -ownCloud logfile, so you can use the log output to figure out what went wrong, +Nextcloud logfile, so you can use the log output to figure out what went wrong, or to use in a bug report:: Turned on maintenance mode @@ -1293,7 +1277,7 @@ or to use in a bug report:: Update failed Turned off maintenance mode -Before completing the upgrade, ownCloud first runs a simulation by copying all +Before completing the upgrade, Nextcloud first runs a simulation by copying all database tables to new tables, and then performs the upgrade on them, to ensure that the upgrade will complete correctly. The copied tables are deleted after the upgrade. This takes twice as much time, which on large installations can be diff --git a/admin_manual/configuration_server/security_setup_warnings.rst b/admin_manual/configuration_server/security_setup_warnings.rst index 07b24169b48..cc2810cf758 100644 --- a/admin_manual/configuration_server/security_setup_warnings.rst +++ b/admin_manual/configuration_server/security_setup_warnings.rst @@ -2,7 +2,7 @@ Warnings on Admin Page ====================== -Your ownCloud server has a built-in configuration checker, and it reports its +Your Nextcloud server has a built-in configuration checker, and it reports its findings at the top of your Admin page. These are some of the warnings you might see, and what to do about them. @@ -12,7 +12,7 @@ Cache Warnings -------------- "No memory cache has been configured. To enhance your performance please -configure a memcache if available." ownCloud supports multiple php caching +configure a memcache if available." Nextcloud supports multiple php caching extensions: * APC (PHP 5.4 only) @@ -47,7 +47,7 @@ You are accessing this site via HTTP server to require using HTTPS instead." Please take this warning seriously; using HTTPS is a fundamental security measure. You must configure your Web server to support it, and then there are some settings in the **Security** -section of your ownCloud Admin page to enable. The following pages +section of your Nextcloud Admin page to enable. The following pages describe how to enable HTTPS on the Apache and Nginx Web servers. :ref:`enabling_ssl_label` (on Apache) @@ -59,7 +59,7 @@ describe how to enable HTTPS on the Apache and Nginx Web servers. The test with getenv(\"PATH\") only returns an empty response ------------------------------------------------------------- -Some environments are not passing a valid PATH variable to ownCloud. The +Some environments are not passing a valid PATH variable to Nextcloud. The :ref:`php_fpm_tips_label` provides the information about how to configure your environment. @@ -103,7 +103,7 @@ Cloud Sharing will not work reliably." There are known bugs in older OpenSSL and NSS versions leading to misbehaviour in combination with remote hosts using SNI. A technology used by most of the HTTPS -websites. To ensure that ownCloud will work properly you need to update OpenSSL +websites. To ensure that Nextcloud will work properly you need to update OpenSSL to at least 1.0.2b or 1.0.1d. For NSS the patch version depends on your distribution and an heuristic is running the test which actually reproduces the bug. There are distributions such as RHEL/CentOS which have this backport still `pending @@ -112,7 +112,7 @@ are distributions such as RHEL/CentOS which have this backport still `pending Your Web server is not set up properly to resolve /.well-known/caldav/ or /.well-known/carddav/ ----------------------------------------------------------------------------------------------- -Both URLs need to be correctly redirected to the DAV endpoint of ownCloud. Please +Both URLs need to be correctly redirected to the DAV endpoint of Nextcloud. Please refer to :ref:`service-discovery-label` for more info. Some files have not passed the integrity check @@ -126,4 +126,4 @@ 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. \ No newline at end of file +Please refer to :ref:`db-transaction-label` how to configure your database for this requirement. diff --git a/admin_manual/configuration_server/theming.rst b/admin_manual/configuration_server/theming.rst new file mode 100644 index 00000000000..11374e28ca4 --- /dev/null +++ b/admin_manual/configuration_server/theming.rst @@ -0,0 +1,20 @@ +======= +Theming +======= + +In the administrative settings you can modify the appearance of Nextcloud: + +* Name +* Web Address +* Slogan +* Color: The color of header bar, checkboxes and folder icon +* Logo: The logo will appear in the header and on the log in page +* Log in image: The background image of the log in page + + +.. figure:: ../configuration_server/images/theming.png + + +Log in page + +.. figure:: ../configuration_server/images/theming-log-in-page.png diff --git a/admin_manual/configuration_server/thirdparty_php_configuration.rst b/admin_manual/configuration_server/thirdparty_php_configuration.rst index 980fe05b23c..3d9cf242727 100644 --- a/admin_manual/configuration_server/thirdparty_php_configuration.rst +++ b/admin_manual/configuration_server/thirdparty_php_configuration.rst @@ -1,7 +1,7 @@ Using Third Party PHP Components ================================ -ownCloud uses some third party PHP components to provide some of its functionality. These components are part of the software package and are contained in the **/3rdparty** folder. +Nextcloud uses some third party PHP components to provide some of its functionality. These components are part of the software package and are contained in the **/3rdparty** folder. Managing Third Party Parameters ------------------------------- @@ -10,7 +10,7 @@ When using third party components, keep the following parameters in mind: * **3rdpartyroot** -- Specifies the location of the 3rd-party folder. To change the default location of this folder, you can use this parameter to define the absolute file system path to the folder location. -* **3rdpartyurl** -- Specifies the http web path to the 3rdpartyroot folder, starting at the ownCloud web root. +* **3rdpartyurl** -- Specifies the http web path to the 3rdpartyroot folder, starting at the Nextcloud web root. An example of what these parameters might look like is as follows: diff --git a/admin_manual/configuration_user/index.rst b/admin_manual/configuration_user/index.rst index f73bde281dc..f047572707f 100644 --- a/admin_manual/configuration_user/index.rst +++ b/admin_manual/configuration_user/index.rst @@ -8,7 +8,8 @@ User Management user_configuration reset_admin_password reset_user_password + user_password_policy user_auth_ftp_smb_imap user_auth_ldap user_auth_ldap_cleanup - user_provisioning_api \ No newline at end of file + user_provisioning_api diff --git a/admin_manual/configuration_user/reset_admin_password.rst b/admin_manual/configuration_user/reset_admin_password.rst index f47ebb353bf..bd3fce9a6ca 100644 --- a/admin_manual/configuration_user/reset_admin_password.rst +++ b/admin_manual/configuration_user/reset_admin_password.rst @@ -6,7 +6,7 @@ The normal ways to recover a lost password are: 1. Click the password reset link on the login screen; this appears after a failed login attempt. This works only if you have entered your email address - on your Personal page in the ownCloud Web interface, so that the ownCloud + on your Personal page in the Nextcloud Web interface, so that the Nextcloud server can email a reset link to you. 2. Ask another Nextcloud server admin to reset it for you. diff --git a/admin_manual/configuration_user/reset_user_password.rst b/admin_manual/configuration_user/reset_user_password.rst index 4268c63fbc1..9958261d431 100644 --- a/admin_manual/configuration_user/reset_user_password.rst +++ b/admin_manual/configuration_user/reset_user_password.rst @@ -2,8 +2,8 @@ Resetting a User Password ========================= -The ownCloud login screen displays a **Wrong password. Reset it?** message -after a user enters an incorrect password, and then ownCloud automatically +The Nextcloud login screen displays a **Wrong password. Reset it?** message +after a user enters an incorrect password, and then Nextcloud automatically resets their password. However, if you are using a read-only authentication backend such as LDAP or Active Directory, this will not work. In this case you may specify a custom URL in your ``config.php`` file to direct your user to a diff --git a/admin_manual/configuration_user/user_auth_ftp_smb_imap.rst b/admin_manual/configuration_user/user_auth_ftp_smb_imap.rst index 0873dfdc302..d7265d52200 100644 --- a/admin_manual/configuration_user/user_auth_ftp_smb_imap.rst +++ b/admin_manual/configuration_user/user_auth_ftp_smb_imap.rst @@ -3,7 +3,7 @@ User Authentication with IMAP, SMB, and FTP =========================================== You may configure additional user backends -in ownCloud's configuration :file:`config/config.php` using the following +in Nextcloud's configuration :file:`config/config.php` using the following syntax: :: diff --git a/admin_manual/configuration_user/user_auth_ldap.rst b/admin_manual/configuration_user/user_auth_ldap.rst index 567f931093d..65b35206256 100644 --- a/admin_manual/configuration_user/user_auth_ldap.rst +++ b/admin_manual/configuration_user/user_auth_ldap.rst @@ -2,23 +2,23 @@ User Authentication with LDAP ============================= -ownCloud ships with an LDAP application to allow LDAP users (including Active -Directory) to appear in your ownCloud user listings. These users will -authenticate to ownCloud with their LDAP credentials, so you don't have to -create separate ownCloud user accounts for them. You will manage their ownCloud -group memberships, quotas, and sharing permissions just like any other ownCloud +Nextcloud ships with an LDAP application to allow LDAP users (including Active +Directory) to appear in your Nextcloud user listings. These users will +authenticate to Nextcloud with their LDAP credentials, so you don't have to +create separate Nextcloud user accounts for them. You will manage their Nextcloud +group memberships, quotas, and sharing permissions just like any other Nextcloud 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 ownCloud 8.1. + required in Nextcloud. The LDAP application supports: * LDAP group support -* File sharing with ownCloud users and groups -* Access via WebDAV and ownCloud Desktop Client -* Versioning, external Storage and all other ownCloud features +* File sharing with Nextcloud users and groups +* Access via WebDAV and Nextcloud Desktop Client +* Versioning, external Storage and all other Nextcloud features * Seamless connectivity to Active Directory, with no extra configuration required * Support for primary groups in Active Directory @@ -37,7 +37,7 @@ Configuration ------------- First enable the ``LDAP user and group backend`` app on the Apps page in -ownCloud. Then go to your Admin page to configure it. +Nextcloud. Then go to your Admin page to configure it. The LDAP configuration panel has four tabs. A correctly completed first tab ("Server") is mandatory to access the other tabs. A green indicator lights when @@ -49,9 +49,9 @@ Server Tab Start with the Server tab. You may configure multiple servers if you have them. At a minimum you must supply the LDAP server's hostname. If your server requires -authentication, enter your credentials on this tab. ownCloud will then attempt +authentication, enter your credentials on this tab. Nextcloud will then attempt to auto-detect the server's port and base DN. The base DN and port are -mandatory, so if ownCloud cannot detect them you must enter them manually. +mandatory, so if Nextcloud cannot detect them you must enter them manually. .. figure:: ../images/ldap-wizard-1-server.png :alt: LDAP wizard, server tab @@ -74,7 +74,7 @@ Port: The port on which to connect to the LDAP server. The field is disabled in the beginning of a new configuration. If the LDAP server is running on a standard port, the port will be detected automatically. If you are using a - non-standard port, ownCloud will attempt to detect it. If this fails you must + non-standard port, Nextcloud will attempt to detect it. If this fails you must enter the port number manually. Example: @@ -96,9 +96,9 @@ Password: Base DN: The base DN of LDAP, from where all users and groups can be reached. You may enter multiple base DNs, one per line. (Base DNs for users and groups can be - set in the Advanced tab.) This field is mandatory. ownCloud attempts to + set in the Advanced tab.) This field is mandatory. Nextcloud attempts to determine the Base DN according to the provided User DN or the provided - Host, and you must enter it manually if ownCloud does not detect it. + Host, and you must enter it manually if Nextcloud does not detect it. Example: @@ -107,8 +107,8 @@ Base DN: User Filter ^^^^^^^^^^^ -Use this to control which LDAP users are listed as ownCloud users on your -ownCloud server. In order to control which LDAP users can login to your ownCloud +Use this to control which LDAP users are listed as Nextcloud users on your +Nextcloud server. In order to control which LDAP users can login to your Nextcloud server use the Login filter. Those LDAP users who have access but are not listed as users (if there are any) will be hidden users. You may bypass the form fields and enter a raw LDAP filter if you prefer. @@ -117,15 +117,15 @@ and enter a raw LDAP filter if you prefer. :alt: User filter only those object classes: - ownCloud will determine the object classes that are typically available for - user objects in your LDAP. ownCloud will automatically select the object + Nextcloud will determine the object classes that are typically available for + user objects in your LDAP. Nextcloud will automatically select the object class that returns the highest amount of users. You may select multiple object classes. only from those groups: If your LDAP server supports the ``member-of-overlay`` in LDAP filters, you can define that only users from one or more certain groups are allowed to - appear in user listings in ownCloud. By default, no value will be selected. + appear in user listings in Nextcloud. By default, no value will be selected. You may select multiple groups. @@ -141,13 +141,13 @@ Edit raw filter instead: x users found: This is an indicator that tells you approximately how many users will be - listed in ownCloud. The number updates automatically after any changes. + listed in Nextcloud. The number updates automatically after any changes. Login Filter ^^^^^^^^^^^^ The settings in the Login Filter tab determine which LDAP users can log in to -your ownCloud system and which attribute or attributes the provided login name +your Nextcloud system and which attribute or attributes the provided login name is matched against (e.g. LDAP/AD username, email address). You may select multiple user details. (You may bypass the form fields and enter a raw LDAP filter if you prefer.) @@ -161,7 +161,7 @@ LDAP filter. LDAP Username: If this value is checked, the login value will be compared to the username in the LDAP directory. The corresponding attribute, usually *uid* or - *samaccountname* will be detected automatically by ownCloud. + *samaccountname* will be detected automatically by Nextcloud. LDAP Email Address: If this value is checked, the login value will be compared to an email address @@ -195,22 +195,22 @@ Edit raw filter instead: Group Filter ^^^^^^^^^^^^ -By default, no LDAP groups will be available in ownCloud. The settings in the -group filter tab determine which groups will be available in ownCloud. You may +By default, no LDAP groups will be available in Nextcloud. The settings in the +group filter tab determine which groups will be available in Nextcloud. You may also elect to enter a raw LDAP filter instead. .. figure:: ../images/ldap-wizard-4-group.png :alt: Group filter only those object classes: - ownCloud will determine the object classes that are typically available for - group objects in your LDAP server. ownCloud will only list object + Nextcloud will determine the object classes that are typically available for + group objects in your LDAP server. Nextcloud will only list object classes that return at least one group object. You can select multiple object classes. A typical object class is "group", or "posixGroup". only from those groups: - ownCloud will generate a list of available groups found in your LDAP server. - and then you select the group or groups that get access to your ownCloud + Nextcloud will generate a list of available groups found in your LDAP server. + and then you select the group or groups that get access to your Nextcloud server. Edit raw filter instead: @@ -223,7 +223,7 @@ Edit raw filter instead: * *objectClass=posixGroup* y groups found: - This tells you approximately how many groups will be available in ownCloud. + This tells you approximately how many groups will be available in Nextcloud. The number updates automatically after any change. @@ -249,12 +249,12 @@ Connection Settings Configuration Active: Enables or Disables the current configuration. By default, it is turned off. - When ownCloud makes a successful test connection it is automatically turned + When Nextcloud makes a successful test connection it is automatically turned on. Backup (Replica) Host: If you have a backup LDAP server, enter the connection settings here. - ownCloud will then automatically connect to the backup when the main server + Nextcloud will then automatically connect to the backup when the main server cannot be reached. The backup server must be a replica of the main server so that the object UUIDs match. @@ -271,7 +271,7 @@ Backup (Replica) Port: * *389* Disable Main Server: - You can manually override the main server and make ownCloud only connect to + You can manually override the main server and make Nextcloud only connect to the backup server. This is useful for planned downtimes. Turn off SSL certificate validation: @@ -304,7 +304,7 @@ Directory Settings :alt: Directory settings. User Display Name Field: - The attribute that should be used as display name in ownCloud. + The attribute that should be used as display name in Nextcloud. * Example: *displayName* @@ -339,7 +339,7 @@ User Search Attributes: | *mail* Group Display Name Field: - The attribute that should be used as ownCloud group name. ownCloud allows a + The attribute that should be used as Nextcloud group name. Nextcloud allows a limited set of characters (a-zA-Z0-9.-_@). Once a group name is assigned it cannot be changed. @@ -372,7 +372,7 @@ Group Member association: The attribute that is used to indicate group memberships, i.e. the attribute used by LDAP groups to refer to their users. - ownCloud detects the value automatically. You should only change it if you + Nextcloud detects the value automatically. You should only change it if you have a very valid reason and know what you are doing. * Example: *uniquemember* @@ -384,15 +384,15 @@ Special Attributes :alt: Special Attributes. Quota Field: - ownCloud can read an LDAP attribute and set the user quota according to its + Nextcloud can read an LDAP attribute and set the user quota according to its value. Specify the attribute here, and it will return human-readable values, - e.g. "2 GB". Any quota set in LDAP overrides quotas set on the ownCloud user + e.g. "2 GB". Any quota set in LDAP overrides quotas set on the Nextcloud user management page. - * Example: *ownCloudQuota* + * Example: *NextcloudQuota* Quota Default: - Override ownCloud default quota for LDAP users who do not have a quota set in + Override Nextcloud default quota for LDAP users who do not have a quota set in the Quota Field. * Example: *15 GB* @@ -411,9 +411,9 @@ User Home Folder Naming Rule: * Example: *cn* -In new ownCloud 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 ownCloud installations the old behavior still applies, which is using the ownCloud 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 ownCloud 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 @@ -427,20 +427,20 @@ In the Expert Settings fundamental behavior can be adjusted to your needs. The configuration should be well-tested before starting production use. Internal Username: - The internal username is the identifier in ownCloud for LDAP users. By default + The internal username is the identifier in Nextcloud for LDAP users. By default it will be created from the UUID attribute. The UUID attribute ensures that the username is unique, and that characters do not need to be converted. Only these characters are allowed: [\a-\zA-\Z0-\9_.@-]. Other characters are replaced with their ASCII equivalents, or are simply omitted. The LDAP backend ensures that there are no duplicate internal usernames in - ownCloud, i.e. that it is checking all other activated user backends - (including local ownCloud users). On collisions a random number (between 1000 + Nextcloud, i.e. that it is checking all other activated user backends + (including local Nextcloud users). On collisions a random number (between 1000 and 9999) will be attached to the retrieved value. For example, if "alice" exists, the next username may be "alice_1337". The internal username is the default name for the user home folder in - ownCloud. It is also a part of remote URLs, for instance for all \*DAV + Nextcloud. It is also a part of remote URLs, for instance for all \*DAV services. You can override all of this with the Internal Username setting. Leave it @@ -449,7 +449,7 @@ Internal Username: * Example: *uid* Override UUID detection - By default, ownCloud auto-detects the UUID attribute. The UUID attribute is + By default, Nextcloud auto-detects the UUID attribute. The UUID attribute is used to uniquely identify LDAP users and groups. The internal username will be created based on the UUID, if not specified otherwise. @@ -459,23 +459,23 @@ Override UUID detection have effect only on newly mapped LDAP users and groups. It also will have effect when a user's or group's DN changes and an old UUID was cached, which will result in a new user. Because of this, the setting should be - applied before putting ownCloud in production use and clearing the bindings + applied before putting Nextcloud in production use and clearing the bindings (see the ``User and Group Mapping`` section below). * Example: *cn* Username-LDAP User Mapping - ownCloud uses usernames as keys to store and assign data. In order to + Nextcloud uses usernames as keys to store and assign data. In order to precisely identify and recognize users, each LDAP user will have a internal - username in ownCloud. This requires a mapping from ownCloud username to LDAP + username in Nextcloud. This requires a mapping from Nextcloud username to LDAP user. The created username is mapped to the UUID of the LDAP user. Additionally the DN is cached as well to reduce LDAP interaction, but it is not used for identification. If the DN changes, the change will be detected by - ownCloud by checking the UUID value. + Nextcloud by checking the UUID value. The same is valid for groups. - The internal ownCloud name is used all over in ownCloud. Clearing the Mappings + The internal Nextcloud name is used all over in Nextcloud. Clearing the Mappings will have leftovers everywhere. Never clear the mappings in a production environment, but only in a testing or experimental server. @@ -487,7 +487,7 @@ Testing the configuration The **Test Configuration** button checks the values as currently given in the input fields. You do not need to save before testing. By clicking on the -button, ownCloud will try to bind to the ownCloud server using the +button, Nextcloud will try to bind to the Nextcloud server using the settings currently given in the input fields. If the binding fails you'll see a yellow banner with the error message "The configuration is invalid. Please have a look at the logs for further details." @@ -495,10 +495,10 @@ a look at the logs for further details." When the configuration test reports success, save your settings and check if the users and groups are fetched correctly on the Users page. -ownCloud Avatar integration ---------------------------- +Nextcloud Avatar integration +---------------------------- -ownCloud supports user profile pictures, which are also called avatars. If a user +Nextcloud supports user profile pictures, which are also called avatars. If a user has a photo stored in the *jpegPhoto* or *thumbnailPhoto* attribute on your LDAP server, it will be used as their avatar. In this case the user cannot alter their avatar (on their Personal page) as it must be changed in LDAP. *jpegPhoto* is @@ -508,15 +508,15 @@ preferred over *thumbnailPhoto*. :alt: Profile picture fetched from LDAP. If the *jpegPhoto* or *thumbnailPhoto* attribute is not set or empty, then -users can upload and manage their avatars on their ownCloud Personal pages. -Avatars managed in ownCloud are not stored in LDAP. +users can upload and manage their avatars on their Nextcloud Personal pages. +Avatars managed in Nextcloud are not stored in LDAP. The *jpegPhoto* or *thumbnailPhoto* attribute is fetched once a day to make -sure the current photo from LDAP is used in ownCloud. LDAP avatars override -ownCloud avatars, and when an LDAP avatar is deleted then the most recent -ownCloud avatar replaces it. +sure the current photo from LDAP is used in Nextcloud. LDAP avatars override +Nextcloud avatars, and when an LDAP avatar is deleted then the most recent +Nextcloud avatar replaces it. -Photos served from LDAP are automatically cropped and resized in ownCloud. This +Photos served from LDAP are automatically cropped and resized in Nextcloud. This affects only the presentation, and the original image is not changed. Troubleshooting, Tips and Tricks @@ -528,7 +528,7 @@ SSL Certificate Verification (LDAPS, TLS) A common mistake with SSL certificates is that they may not be known to PHP. If you have trouble with certificate validation make sure that -* You have the certificate of the server installed on the ownCloud server +* 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* @@ -542,8 +542,8 @@ If you have trouble with certificate validation make sure that Microsoft Active Directory -------------------------- -Compared to earlier ownCloud versions, no further tweaks need to be done to -make ownCloud work with Active Directory. ownCloud will automatically find the +Compared to earlier Nextcloud versions, no further tweaks need to be done to +make Nextcloud work with Active Directory. Nextcloud will automatically find the correct configuration in the set-up process. memberOf / Read MemberOf permissions @@ -570,15 +570,15 @@ In case you have a working configuration and want to create a similar one or Now you can modify and enable the configuration. -ownCloud LDAP Internals ------------------------ +Nextcloud LDAP Internals +------------------------ Some parts of how the LDAP backend works are described here. User and Group Mapping ^^^^^^^^^^^^^^^^^^^^^^ -In ownCloud the user or group name is used to have all relevant information in +In Nextcloud the user or group name is used to have all relevant information in the database assigned. To work reliably a permanent internal user name and group name is created and mapped to the LDAP DN and UUID. If the DN changes in LDAP it will be detected, and there will be no conflicts. @@ -588,7 +588,7 @@ Those mappings are done in the database table ``ldap_user_mapping`` and if something else is specified in *User Home Folder Naming Rule*), which contains files and meta data. -As of ownCloud 5 the internal user name and a visible display name are separated. +As of Nextcloud 5 the internal user name and a visible display name are separated. This is not the case for group names, yet, i.e. a group name cannot be altered. That means that your LDAP configuration should be good and ready before putting @@ -598,9 +598,9 @@ testing, you can empty the tables any time. Do not do this in production. Caching ^^^^^^^ -The LDAP cache has changed in ownCloud 8.1. There is no more file cache, but -only a memory cache, and you must install and configure the memory cache (see -:doc:`../configuration_server/caching_configuration`). The ownCloud **Cache** +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 expires. User logins are not cached, so if you need to improve login times set @@ -626,7 +626,7 @@ steps of 30 until the limit is reached or no results are left. For this to work on an oC-Server and LDAP-Server, **Paged Results** must be supported, which presumes PHP >= 5.4. -ownCloud remembers which user belongs to which LDAP-configuration. That means +Nextcloud remembers which user belongs to which LDAP-configuration. That means each request will always be directed to the right server unless a user is defunct, for example due to a server migration or unreachable server. In this case the other servers will also receive the request. @@ -634,8 +634,8 @@ case the other servers will also receive the request. Handling with Backup Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -When ownCloud is not able to contact the main LDAP server, ownCloud assumes it +When Nextcloud is not able to contact the main LDAP server, Nextcloud assumes it is offline and will not try to connect again for the time specified in **Cache -Time-To-Live**. If you have a backup server configured ownCloud will connect to +Time-To-Live**. If you have a backup server configured Nextcloud will connect to it instead. When you have scheduled downtime, check **Disable Main Server** to avoid unnecessary connection attempts. diff --git a/admin_manual/configuration_user/user_auth_ldap_cleanup.rst b/admin_manual/configuration_user/user_auth_ldap_cleanup.rst index 3e2a53d31c2..9526f03a50d 100644 --- a/admin_manual/configuration_user/user_auth_ldap_cleanup.rst +++ b/admin_manual/configuration_user/user_auth_ldap_cleanup.rst @@ -4,17 +4,17 @@ LDAP User Cleanup LDAP User Cleanup is a new feature in the ``LDAP user and group backend`` application. LDAP User Cleanup is a background process that automatically -searches the ownCloud LDAP mappings table, and verifies if the LDAP users are +searches the Nextcloud LDAP mappings table, and verifies if the LDAP users are still available. Any users that are not available are marked as ``deleted`` in the ``oc_preferences`` database table. Then you can run a command to display this table, displaying only the users marked as ``deleted``, and then you have -the option of removing their data from your ownCloud data directory. +the option of removing their data from your Nextcloud data directory. These items are removed upon cleanup: -* Local ownCloud group assignments +* Local Nextcloud group assignments * User preferences (DB table ``oc_preferences``) -* User's ownCloud home folder +* User's Nextcloud home folder * User's corresponding entry in ``oc_storages`` There are two prerequisites for LDAP User Cleanup to operate: @@ -35,7 +35,7 @@ minutes later the next 50, and so on. There are two ``occ`` commands to use for examining a table of users marked as deleted, and then manually deleting them. The ``occ`` command is in your -ownCloud directory, for example ``/var/www/owncloud/occ``, and it must be run as +Nextcloud directory, for example ``/var/www/nextcloud/occ``, and it must be run as your HTTP user. To learn more about ``occ``, see :doc:`../configuration_server/occ_command`. @@ -45,13 +45,13 @@ These examples are for Ubuntu Linux: users that have been marked as deleted, and their LDAP data. 2. ``sudo -u www-data php occ user:delete [user]`` removes the user's data from the - ownCloud data directory. + Nextcloud data directory. This example shows what the table of users marked as ``deleted`` looks like:: $ sudo -u www-data php occ ldap:show-remnants +-----------------+-----------------+------------------+--------------------------------------+ - | ownCloud 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 | @@ -60,10 +60,10 @@ This example shows what the table of users marked as ``deleted`` looks like:: +-----------------+-----------------+------------------+--------------------------------------+ Then you can run ``sudo -u www-data php occ user:delete aaliyah_brown`` to delete -user aaliyah_brown. You must use the user's ownCloud name. +user aaliyah_brown. You must use the user's Nextcloud name. -Deleting Local ownCloud Users ------------------------------ +Deleting Local Nextcloud Users +------------------------------ -You may also use ``occ user:delete [user]`` to remove a local ownCloud user; +You may also use ``occ user:delete [user]`` to remove a local Nextcloud user; this removes their user account and their data. diff --git a/admin_manual/configuration_user/user_configuration.rst b/admin_manual/configuration_user/user_configuration.rst index c0c7990b575..c6caabe2706 100644 --- a/admin_manual/configuration_user/user_configuration.rst +++ b/admin_manual/configuration_user/user_configuration.rst @@ -2,7 +2,7 @@ User Management =============== -On the User management page of your ownCloud Web UI you can: +On the User management page of your Nextcloud Web UI you can: * Create new users * View all of your users in a single scrolling window @@ -33,10 +33,10 @@ Show user backend, Send email to new users,** and **Show email address**. User accounts have the following properties: *Login Name (Username)* - The unique ID of an ownCloud user, and it cannot be changed. + The unique ID of an Nextcloud user, and it cannot be changed. *Full Name* - The user's display name that appears on file shares, the ownCloud Web + The user's display name that appears on file shares, the Nextcloud Web interface, and emails. Admins and users may change the Full Name anytime. If the Full Name is not set it defaults to the login name. @@ -75,7 +75,7 @@ leave it for the user to complete. If you have checked **Send email to new user** in the control panel on the lower left sidebar, you may also enter the new user's email address, and -ownCloud will automatically send them a notification with their new login +Nextcloud will automatically send them a notification with their new login information. You may edit this email using the email template editor on your Admin page (see :doc:`../configuration_server/email_configuration`). @@ -96,7 +96,7 @@ password resets. Please see Renaming a User ~~~~~~~~~~~~~~~ -Each ownCloud user has two names: a unique **Login Name** used for +Each Nextcloud user has two names: a unique **Login Name** used for authentication, and a **Full Name**, which is their display name. You can edit the display name of a user, but you cannot change the login name of any user. @@ -110,7 +110,7 @@ To set or change a user's display name: Granting Administrator Privileges to a User ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -ownCloud has two types of administrators: **Super Administrators** and **Group +Nextcloud has two types of administrators: **Super Administrators** and **Group Administrators**. Group administrators have the rights to create, edit and delete users in their assigned groups. Group administrators cannot access system settings, or add or modify users in the groups that they are not **Group @@ -119,7 +119,7 @@ assign group admin privileges. .. figure:: ../images/users-groups.png -**Super Administrators** have full rights on your ownCloud server, and can +**Super Administrators** have full rights on your Nextcloud server, and can access and modify all settings. To assign the **Super Administrators** role to a user, simply add them to the ``admin`` group. @@ -183,7 +183,7 @@ user. All of the files owned by the user are deleted as well, including all files they have shared. If you need to preserve the user's files and shares, you must first -download them from your ownCloud Files page, which compresses them into a zip +download them from your Nextcloud Files page, which compresses them into a zip file, or use a sync client to copy them to your local computer. See :doc:`../configuration_files/file_sharing_configuration` to learn how to create persistent file shares that survive user deletions. diff --git a/admin_manual/configuration_user/user_password_policy.rst b/admin_manual/configuration_user/user_password_policy.rst new file mode 100644 index 00000000000..c8be05b4414 --- /dev/null +++ b/admin_manual/configuration_user/user_password_policy.rst @@ -0,0 +1,16 @@ +======================== +User Password Policy App +======================== + +A password policy is a set of rules designed to enhance computer security by encouraging users to employ strong passwords and use them properly. + +You can configure + +* a minimal length of a password. Default is 10 characters. +* to forbid common passwords like 'california' or 'enterprise'. +* enforce upper and lower case characters +* Enforce numeric characters +* Enforce special characters like ! or : + +.. figure:: ../images/user_password_policy_configuration_app.png + diff --git a/admin_manual/configuration_user/user_provisioning_api.rst b/admin_manual/configuration_user/user_provisioning_api.rst index c0af203ad5d..080a369add9 100644 --- a/admin_manual/configuration_user/user_provisioning_api.rst +++ b/admin_manual/configuration_user/user_provisioning_api.rst @@ -4,14 +4,14 @@ User Provisioning API The Provisioning API application enables a set of APIs that external systems can use to create, edit, delete and query user attributes, query, set and remove groups, set quota -and query total storage used in ownCloud. Group admin users can also query -ownCloud and perform the same functions as an admin for groups they manage. The -API also enables an admin to query for active ownCloud applications, application +and query total storage used in Nextcloud. Group admin users can also query +Nextcloud and perform the same functions as an admin for groups they manage. The +API also enables an admin to query for active Nextcloud applications, application info, and to enable or disable an app remotely. HTTP requests can be used via a Basic Auth header to perform any of the functions listed above. The Provisioning API app is enabled by default. -The base URL for all calls to the share API is **owncloud_base_url/ocs/v1.php/cloud**. +The base URL for all calls to the share API is **nextcloud_base_url/ocs/v1.php/cloud**. Instruction Set For Users ========================= @@ -19,7 +19,7 @@ Instruction Set For Users **users / adduser** ------------------- -Create a new user on the ownCloud server. Authentication is done by sending a +Create a new user on the Nextcloud server. Authentication is done by sending a basic HTTP authentication header. **Syntax: ocs/v1.php/cloud/users** @@ -60,7 +60,7 @@ XML Output **users / getusers** -------------------- -Retrieves a list of users from the ownCloud server. Authentication is done by +Retrieves a list of users from the Nextcloud server. Authentication is done by sending a Basic HTTP Authorization header. **Syntax: ocs/v1.php/cloud/users** @@ -183,7 +183,7 @@ XML Output **users / deleteuser** ---------------------- -Deletes a user from the ownCloud server. Authentication is done by sending a +Deletes a user from the Nextcloud server. Authentication is done by sending a Basic HTTP Authorization header. **Syntax: ocs/v1.php/cloud/users/{userid}** @@ -465,7 +465,7 @@ Instruction Set For Groups **groups / getgroups** ---------------------- -Retrieves a list of groups from the ownCloud server. Authentication is done by +Retrieves a list of groups from the Nextcloud server. Authentication is done by sending a Basic HTTP Authorization header. **Syntax: ocs/v1.php/cloud/groups** @@ -662,7 +662,7 @@ Instruction Set For Apps **apps / getapps** ------------------ -Returns a list of apps installed on the ownCloud server. Authentication is done +Returns a list of apps installed on the Nextcloud server. Authentication is done by sending a Basic HTTP Authorization header. diff --git a/admin_manual/images/user_password_policy_configuration_app.png b/admin_manual/images/user_password_policy_configuration_app.png new file mode 100644 index 00000000000..6101b28730b Binary files /dev/null and b/admin_manual/images/user_password_policy_configuration_app.png differ diff --git a/admin_manual/index.rst b/admin_manual/index.rst index d4a6b84b542..2f6405d4e6f 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -12,19 +12,18 @@ Linux, client applications for Microsoft Windows, Mac OS X and Linux, and mobile clients for the Android and Apple iOS operating systems. Current editions of Nextcloud manuals are always available online at -`doc.owncloud.org `_ and `doc.owncloud.com -`_. +`docs.nextcloud.org `_. Nextcloud server is available: * As a free, full featured community-supported server, with all enterprise features. * Or with full enterprise support, including phone and email access to Nextcloud developers. -See :doc:`../whats_new_admin` for more information on the different ownCloud +See :doc:`../whats_new_admin` for more information on the different Nextcloud editions. -ownCloud Videos and Blogs -------------------------- +Nextcloud Videos and Blogs +-------------------------- See the `official Nextcloud channel `_ @@ -46,7 +45,9 @@ respective manuals: * `Nextcloud Android App`_ * `Nextcloud iOS App`_ -.. _`Nextcloud User Manual`: https://docs.nextcloud.org/server/9.0/user_manual/ +.. _`Nextcloud User Manual`: https://docs.nextcloud.org/server/10/user_manual/ .. _`Nextcloud/ownCloud Desktop Client`: https://doc.owncloud.org/desktop/2.2/ .. _`Nextcloud Android App`: https://docs.nextcloud.org/android/ .. _`Nextcloud iOS App`: https://docs.nextcloud.org/ios/ + +.. TODO ON RELEASE: Update version number above on release diff --git a/admin_manual/installation/appliance_installation.rst b/admin_manual/installation/appliance_installation.rst deleted file mode 100644 index 90073c399b0..00000000000 --- a/admin_manual/installation/appliance_installation.rst +++ /dev/null @@ -1,77 +0,0 @@ -============================ -ownCloud Community Appliance -============================ - -ownCloud has a publicly developed community appliance `on GitHub`_. Download the -latest release from the Appliances tab on the `ownCloud server installation -page`_. The easiest way to get the VM up and running is by using `VirtualBox`_ -and downloading the OVA image from the installation page. - -Instructions for VirtualBox and OVA ------------------------------------ - -Follow these steps to get the appliance working: - -1. Download the Virtual Machine image zip file and unpack it. - -2. Start VirtualBox and click on *File ...* > *Import Appliance* and import - your new ownCloud image. - -3. Click the green Start arrow. After a minute you should see the console - greeting message. - -.. figure:: images/community-vm-console.png - :alt: screenshot of Ubuntu console login for newly-created virtual machine - -4. Note the username and password here. It is a random password that we generate - for you on first boot. If you log in at the console, you'll be prompted to - change the password. This is optional. - -5. With your Web browser try ``http://localhost:8888`` or - ``http://localhost:80`` or the address printed on the console. One of them - should work. If not, please review and adjust the network setup of - Virtualbox to bridged mode. - -6. You should see a Web page with login credentials (if you haven't changed - them already) and a list of URLs to try to reach the ownCloud web - service. Which one works, again depends on the network setup of your - hypervisor. - -.. figure:: images/community-vm-splash.png - :scale: 50% - :alt: screenshot of new virtual machine Web GUI with login credentials - - *Click to enlarge* - -.. note:: You should write down your admin password, and make sure the login - credentials are no longer displayed. Click the *[Hide Credentials]* button. - When using the ownCloud Proxy app, this Web page may be publicly visible. - -.. note:: Inside the VM, ownCloud runs with a default disk size of 40 GB and its - own MySQL database. The ownCloud admin user is also a valid account on the - Ubuntu system that runs inside the VM. You can administer the VM via SSH. - -**For VMware** - -You can follow most of the steps above, however, after opening the VMX file, you will have to configure ``Bridged Network`` as *Network Adapter* - -Software Appliances -------------------- - -There are a number of unofficial pre-made virtual machine-based appliances: - -- `Tech and me - ownCloud VM on Ubuntu 16.04 with PHP 7, MySQL, and Apache`_, fully configured - environment. -- `SUSE Studio, ownCloud on openSuSE`_, which runs directly from an USB stick. -- `Amahi home server`_ - -.. _on Github: https://github.com/ownCloud/vm -.. _VirtualBox: https://www.virtualbox.org -.. _ownCloud server installation page: https://owncloud.org/install/#instructions-server -.. _Amahi home server: https://wiki.amahi.org/index.php/OwnCloud -.. _Tech and me - ownCloud VM on Ubuntu 16.04 with PHP 7, MySQL, and Apache: https://www.techandme.se/pre-configured-owncloud-installaton/ -.. _ownCloud 7 on Raspberry Pi (Arch Linux) using Lighttpd: http://eiosifidis.blogspot.de/2014/07/install-owncloud-7-on-raspberry-pi-arch.html -.. _OpenWrt Guide: http://wiki.openwrt.org/doc/howto/owncloud -.. _SUSE Studio, ownCloud on openSuSE: http://susestudio.com/a/TadMax/owncloud-in-a-box -.. _QNAP Guide: http://wiki.qnap.com/wiki/Category:OwnCloud -.. _Synology Package: http://www.cphub.net/index.php?id=40&pid=213 diff --git a/admin_manual/installation/apps_management_installation.rst b/admin_manual/installation/apps_management_installation.rst index 95b666ce45a..9ccaf5901a9 100644 --- a/admin_manual/installation/apps_management_installation.rst +++ b/admin_manual/installation/apps_management_installation.rst @@ -2,7 +2,7 @@ Installing and Managing Apps ============================ -After installing ownCloud, you may provide added functionality by installing +After installing Nextcloud, you may provide added functionality by installing applications. Supported Apps @@ -13,58 +13,59 @@ See :doc:`apps_supported` for a list of supported Enterprise edition apps. Viewing Enabled Apps -------------------- -During the ownCloud installation, some apps are enabled by default. To see which +During the Nextcloud installation, some apps are enabled by default. To see which apps are enabled go to your Apps page. .. figure:: ../images/oc_admin_app_page.png :alt: Apps page for enabling and disabling apps. -You will see which apps are enabled, not enabled, and recommended. You'll also -see additional filters, such as Multimedia, Productivity, and Tool for finding +You will see which apps are enabled, not enabled, and recommended. You'll also +see additional filters, such as Multimedia, Productivity, and Tool for finding more apps quickly. Managing Apps ------------- -In the Apps page you can enable or disable applications. Some apps have -configurable options on the Apps page, such as **Enable only for specific -groups**, but mainly they are enabled or disabled here, and are configured on -your ownCloud Admin page, Personal page, or in ``config.php``. +In the Apps page you can enable or disable applications. Some apps have +configurable options on the Apps page, such as **Enable only for specific +groups**, but mainly they are enabled or disabled here, and are configured on +your Nextcloud Admin page, Personal page, or in ``config.php``. Adding Third Party Apps ----------------------- -Some apps are developed and supported by ownCloud directly. These have an -**Official** tag. Apps with the **Approved** tag are community-developed and -supported; they are maintained by trusted developers, and are under active -development. Only **Official** and **Approved** apps are linked on the Apps +Some apps are developed and supported by Nextcloud directly. These have an +**Official** tag. Apps with the **Approved** tag are community-developed and +supported; they are maintained by trusted developers, and are under active +development. Only **Official** and **Approved** apps are linked on the Apps 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 ownCloud installation, it will be downloaded from the app store, installed and enabled. +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 `ownCloud 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 -``'appcodechecker' => true,`` is enabled in ``config.php``. When ``appcodechecker`` is -enabled it checks if third-party apps are using the private API, rather than the public +``'appcodechecker' => true,`` is enabled in ``config.php``. When ``appcodechecker`` is +enabled it checks if third-party apps are using the private API, rather than the public API. If they are then they will not be installed. -.. note:: If you would like to create or add your own ownCloud app, please +.. note:: If you would like to create or add your own Nextcloud app, please refer to the `developer manual - `_. + `_. +.. TODO ON RELEASE: Update version number above on release Using Custom App Directories ---------------------------- -Use the **apps_paths** array in ``config.php`` to set any custom apps directory -locations. The key **path** defines the absolute file system path to the app -folder. The key **url** defines the HTTP web path to that folder, starting at -the ownCloud web root. The key **writable** indicates if a user can install apps +Use the **apps_paths** array in ``config.php`` to set any custom apps directory +locations. The key **path** defines the absolute file system path to the app +folder. The key **url** defines the HTTP web path to that folder, starting at +the Nextcloud web root. The key **writable** indicates if a user can install apps in that folder. -.. note:: To ensure that the default **/apps/** folder only contains apps - shipped with ownCloud, follow this example to setup an **/apps2/** folder +.. note:: To ensure that the default **/apps/** folder only contains apps + shipped with Nextcloud, follow this example to setup an **/apps2/** folder which will be used to store all other apps. :: @@ -87,18 +88,18 @@ in that folder. Using Your Own Appstore ----------------------- -You can enable the installation of apps from your own apps store. This requires that you +You can enable the installation of apps from your own apps store. This requires that you can write to at least one of the configured apps directories. To enable installation from your own apps store: 1. Set the **appstoreenabled** parameter to "true". - This parameter is used to enable your apps store in ownCloud. + This parameter is used to enable your apps store in Nextcloud. -2. Set the **appstoreurl** to the URL of your ownCloud apps store. +2. Set the **appstoreurl** to the URL of your Nextcloud apps store. - This parameter is used to set the http path to the ownCloud apps store. The appstore + This parameter is used to set the http path to the Nextcloud apps store. The appstore server must use :abbr:`OCS (Open Collaboration Services)`. :: @@ -106,4 +107,4 @@ To enable installation from your own apps store: true, - "appstoreurl" => "https://api.owncloud.com/v1", + "appstoreurl" => "https://api.nextcloud.com/v1", diff --git a/admin_manual/installation/apps_supported.rst b/admin_manual/installation/apps_supported.rst index 14319692fed..2f20e5b0571 100644 --- a/admin_manual/installation/apps_supported.rst +++ b/admin_manual/installation/apps_supported.rst @@ -1,47 +1,42 @@ -========================== -Supported Apps in ownCloud -========================== +=========================== +Supported Apps in Nextcloud +=========================== AGPL Apps --------- * Activity +* Admin Audit Log * AntiVirus +* Calendar * Collaborative Tags -* Comments +* Comments +* Contacts * Encryption * External Sites * External Storage -* ownCloud WebDAV Endpoint (handles old and new webdav endpoints) -* Federated File Sharing (allows file sharing across ownCloud instances) -* Federation (allows usernname auto-complete across ownCloud instances) +* Federated File Sharing (allows file sharing across Nextcloud instances) +* Federation (allows usernname auto-complete across Nextcloud instances) * Files (cannot be disabled) +* Files Access Control +* Files Automated Tagging * Files PDF Viewer * Files Sharing -* Files TextEditor +* Files Text Editor * Files Trashbin * Files Versions -* Files VideoPlayer +* Files Video Player * First Run Wizard * Gallery * Notifications * Object Storage (Swift) +* Password Policy * Provisioning API * Template Editor (for notification emails) +* Theming * 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 +* User Shibboleth/SAML +* WebDAV Endpoint (handles old and new webdav endpoints) +* Workflow Engine (cannot be disabled) diff --git a/admin_manual/installation/command_line_installation.rst b/admin_manual/installation/command_line_installation.rst index 6c6fb576485..6111d530412 100644 --- a/admin_manual/installation/command_line_installation.rst +++ b/admin_manual/installation/command_line_installation.rst @@ -7,9 +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 via your package manager, or download -and unpack the tarball in the appropriate directories. (See -:doc:`linux_installation` and :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/installation/deployment_recommendations.rst b/admin_manual/installation/deployment_recommendations.rst index 987833890ac..76713e0aa79 100644 --- a/admin_manual/installation/deployment_recommendations.rst +++ b/admin_manual/installation/deployment_recommendations.rst @@ -433,7 +433,7 @@ makes migration less painful) although we have yet to find a customer who uses a master-slave setup. .. comment: PostgreSQL may produce excessive amounts of dead tuples due to - owncloud transactions preventing the execution of the autovacum process. + Nextcloud transactions preventing the execution of the autovacum process. What about the other DBMS? @@ -480,14 +480,13 @@ References `How to Set Up a Redis Server as a Session Handler for PHP on Ubuntu 14.04`_ +.. TODO ON RELEASE: Update version number below on release .. _Maintenance: - https://docs.nextcloud.org/server/9/admin_manual/maintenance/index.html + https://docs.nextcloud.org/server/10/admin_manual/maintenance/index.html .. _User Authentication with LDAP: - https://docs.nextcloud.org/server/9/admin_manual/configuration_user/ - user_auth_ldap.html + https://docs.nextcloud.org/server/10/admin_manual/configuration_user/user_auth_ldap.html .. _Configuring Memory Caching: - https://docs.nextcloud.org/server/9/admin_manual/configuration_server/ - caching_configuration.html + https://docs.nextcloud.org/server/10/admin_manual/configuration_server/caching_configuration.html .. _Nextcloud Server or Enterprise Edition: https://nextcloud.com/enterprise/ .. _F5 Big-IP: https://f5.com/products/big-ip/ diff --git a/admin_manual/installation/index.rst b/admin_manual/installation/index.rst index 3b17aac9be4..fee5b7a2086 100644 --- a/admin_manual/installation/index.rst +++ b/admin_manual/installation/index.rst @@ -7,7 +7,6 @@ Installation system_requirements deployment_recommendations - linux_installation installation_wizard command_line_installation apps_management_installation diff --git a/admin_manual/installation/linux_installation.rst b/admin_manual/installation/linux_installation.rst deleted file mode 100644 index f7b7088b09f..00000000000 --- a/admin_manual/installation/linux_installation.rst +++ /dev/null @@ -1,139 +0,0 @@ -=================================== -Preferred Linux Installation Method -=================================== - -Nextcloud ---------- - -.. warning:: Nextcloud Linux distribution packages are not available at the moment (June 2016)! - -The following Text reffers to the OwnCloud packages - -Changes in 9.0 --------------- - -Linux distribution packages (from `Open Build Service`_) have been divided into -multiple packages for ownCloud 9: ``owncloud-deps`` and ``owncloud-files``. - -The ``owncloud-files`` package installs only ownCloud, with no Apache, database, -or PHP dependencies. - -The ``owncloud-deps`` packages install all dependencies: Apache, PHP, and MySQL. -``owncloud-deps`` is not intended to be installed by itself, but rather is -pulled in by the metapackage ``owncloud``. - -Install ``owncloud`` to get a complete installation with dependencies. - -Split packages are available for the following Linux distributions: - -* CentOS 7 -* Debian 8 -* RHEL 7 -* SLES 12 -* Ubuntu 14.04, 15.10 -* openSUSE 13.2, Leap 42.1 - -``owncloud-files`` is available for the following distributions, but not -``owncloud-deps``. You will have to install your own LAMP stack first. This -allows you to create your own custom LAMP stack without dependency conflicts -with the ownCloud package. Browse -``_ to find -the ``owncloud-files`` package for your distro: - -* CentOS 6 -* Debian 7 -* RHEL 6 -* Ubuntu 12.04, 14.10 - -Repositories for Fedora, openSUSE Tumbleweed and Ubuntu 15.04 were dropped. If -you use Fedora, install ``owncloud-files`` over your own LAMP stack. openSUSE -users can rely on LEAP packages for Tumbleweed, and Ubuntu 15.04 users can use -the 15.10 packages. - -Follow the instructions on the download page to install ownCloud. Then run the -Installation Wizard to complete your installation. (see -:doc:`installation_wizard`). - -.. warning:: Do not move the folders provided by these packages after the - installation, as this will break updates. - -See the :doc:`system_requirements` for the recommended ownCloud setup and -supported platforms. - -Repos: Stable or Version? -------------------------- - -You may use either of the following repositories for ownCloud 9: - -* ``_ -* ``_ - -When you use the Stable repo, you never have to change it as it always tracks -the current stable ownCloud version through all major releases: 8.2, 9.0, -and so on. (Major releases are indicated by the second number, so 8.0, 8.1, -8.2, and 9.0 were all major releases.) - -If you wish to track a specific major release, such as 8.2 or 9.0, then use -that repo. That way you won't accidentally find yourself looking at an upgrade -to the next major release before you're ready. - -Downgrading Not Supported -------------------------- - -Downgrading is not supported and risks corrupting your data! If you want to -revert to an older ownCloud version, install it from scratch and then restore -your data from backup. Before doing this, file a support ticket (if you have -paid support) or ask for help in the ownCloud forums to see if your issue can be -resolved without downgrading. - -BINLOG_FORMAT = STATEMENT -------------------------- - -If your ownCloud installation fails and you see this in your ownCloud log:: - - An unhandled exception has been thrown: exception ‘PDOException’ with message - 'SQLSTATE[HY000]: General error: 1665 Cannot execute statement: impossible to - write to binary log since BINLOG_FORMAT = STATEMENT and at least one table - uses a storage engine limited to row-based logging. InnoDB is limited to - row-logging when transaction isolation level is READ COMMITTED or READ - UNCOMMITTED.' - -See :ref:`db-binlog-label`. - -Additional Installation Guides and Notes ----------------------------------------- - -See :doc:`installation_wizard` for important steps such as choosing the best -database and setting correct directory permissions. - -See :doc:`selinux_configuration` for a suggested configuration for -SELinux-enabled distributions such as Fedora and CentOS. - -If your distribution is not listed, your Linux distribution may maintain its -own -ownCloud packages, or you may prefer to install from source code (see -:doc:`source_installation`). - -**Archlinux:** The current `stable version`_ is in the -official community repository, and more packages are in -the `Arch User Repository`_. - -.. _stable version: https://www.archlinux.org/packages/community/any/owncloud -.. _Arch User Repository: https://aur.archlinux.org/packages/?O=0&K=owncloud - -**Mageia:** The `Mageia Wiki`_ has a good page on installing ownCloud from the -Mageia software repository. - -.. _Mageia Wiki: https://wiki.mageia.org/en/OwnCloud - -**Running ownCloud in a subdirectory**: If you're running ownCloud in a -subdirectory and want to use CalDAV or CardDAV clients make sure you have -configured the correct :ref:`service-discovery-label` URLs. - -**Note for MySQL/MariaDB environments**: Please refer to :ref:`db-binlog-label` -on how to correctly configure your environment if you have binary logging enabled. - - -.. _Open Build Service: - https://download.owncloud.org/download/repositories/9.0/owncloud/ - diff --git a/admin_manual/installation/source_installation.rst b/admin_manual/installation/source_installation.rst index a5c28179858..021e22f966b 100644 --- a/admin_manual/installation/source_installation.rst +++ b/admin_manual/installation/source_installation.rst @@ -439,6 +439,3 @@ Other Web Servers `Other HTTP servers (Nextcloud) `_ - -`Univention Corporate Server installation (ownCloud) -`_ diff --git a/admin_manual/issues/code_signing.rst b/admin_manual/issues/code_signing.rst index 6e439227a58..30fd02e0bb9 100644 --- a/admin_manual/issues/code_signing.rst +++ b/admin_manual/issues/code_signing.rst @@ -2,51 +2,51 @@ Code Signing ============ -.. sectionauthor:: Lukas Reschke +.. sectionauthor:: Lukas Reschke .. _code_signing_label: -ownCloud supports code signing for the core releases, and for ownCloud -applications. Code signing gives our users an additional layer of security by +Nextcloud supports code signing for the core releases, and for Nextcloud +applications. Code signing gives our users an additional layer of security by ensuring that nobody other than authorized persons can push updates. -It also ensures that all upgrades have been executed properly, so that no files -are left behind, and all old files are properly replaced. In the past, invalid -updates were a significant source of errors when updating ownCloud. +It also ensures that all upgrades have been executed properly, so that no files +are left behind, and all old files are properly replaced. In the past, invalid +updates were a significant source of errors when updating Nextcloud. FAQ --- -Why Did ownCloud Add Code Signing? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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 +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 ownCloud? -^^^^^^^^^^^^^^^^^^^^^^^^^ +Do We Lock Down Nextcloud? +^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ownCloud project is open source and always will be. We do not want to -make it more difficult for our users to run ownCloud. Any code signing errors on -upgrades will not prevent ownCloud from running, but will display a warning on -the Admin page. For applications that are not tagged "Official" the code signing +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 +upgrades will not prevent Nextcloud from running, but will display a warning on +the Admin page. For applications that are not tagged "Official" the code signing process is optional. Not Open Source Anymore? ^^^^^^^^^^^^^^^^^^^^^^^^ -The ownCloud project is open source and always will be. The code signing -process is optional, though highly recommended. The code check for the -core parts of ownCloud is enabled when the ownCloud release version branch has +The Nextcloud project is open source and always will be. The code signing +process is optional, though highly recommended. The code check for the +core parts of Nextcloud is enabled when the Nextcloud release version branch has been set to stable. -For custom distributions of ownCloud it is recommended to change the release +For custom distributions of Nextcloud it is recommended to change the release version branch in version.php to something else than "stable". Is Code Signing Mandatory For Apps? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Code signing is optional for all third-party applications. Applications +Code signing is optional for all third-party applications. Applications with a tag of "Official" on apps.owncloud.com require code signing. .. _code_signing_fix_warning_label: @@ -54,16 +54,16 @@ with a tag of "Official" on apps.owncloud.com require code signing. Fixing Invalid Code Integrity Messages -------------------------------------- -A code integrity error message ("There were problems with the code integrity -check. More information…") appears in a yellow banner at the top of your -ownCloud Web interface: +A code integrity error message ("There were problems with the code integrity +check. More information…") appears in a yellow banner at the top of your +Nextcloud Web interface: .. image:: images/code-integrity-notification.png :alt: Code integrity warning banner. .. note:: The yellow banner is only shown for admin users. -Clicking on this link will take you to your ownCloud admin page, which provides +Clicking on this link will take you to your Nextcloud admin page, which provides the following options: 1. Link to this documentation entry. @@ -73,8 +73,8 @@ the following options: .. image:: images/code-integrity-admin.png :alt: Links for resolving code integrity warnings. -To debug issues caused by the code integrity check click on "List of invalid -files...", and you will be shown a text document listing the different issues. The +To debug issues caused by the code integrity check click on "List of invalid +files...", and you will be shown a text document listing the different issues. The content of the file will look similar to the following example: :: @@ -108,11 +108,11 @@ content of the file will look similar to the following example: ( [/index.php] => Array ( - [expected] => + [expected] => f1c5e2630d784bc9cb02d5a28f55d6f24d06dae2a0fee685f3 c2521b050955d9d452769f61454c9ddfa9c308146ade10546c fa829794448eaffbc9a04a29d216 - [current] => + [current] => ce08bf30bcbb879a18b49239a9bec6b8702f52452f88a9d321 42cad8d2494d5735e6bfa0d8642b2762c62ca5be49f9bf4ec2 31d4a230559d4f3e2c471d3ea094 @@ -120,11 +120,11 @@ content of the file will look similar to the following example: [/version.php] => Array ( - [expected] => + [expected] => c5a03bacae8dedf8b239997901ba1fffd2fe51271d13a00cc4 b34b09cca5176397a89fc27381cbb1f72855fa18b69b6f87d7 d5685c3b45aee373b09be54742ea - [current] => + [current] => 88a3a92c11db91dec1ac3be0e1c87f862c95ba6ffaaaa3f2c3 b8f682187c66f07af3a3b557a868342ef4a271218fe1c1e300 c478e6c156c5955ed53c40d06585 @@ -137,7 +137,7 @@ content of the file will look similar to the following example: [/test.php] => Array ( [expected] => - [current] => + [current] => 09563164f9904a837f9ca0b5f626db56c838e5098e0ccc1d8b 935f68fa03a25c5ec6f6b2d9e44a868e8b85764dafd1605522 b4af8db0ae269d73432e9a01e63a @@ -162,31 +162,31 @@ content of the file will look similar to the following example: In above error output it can be seen that: -1. In the ownCloud core (that is, the ownCloud server itself) the files +1. In the Nextcloud core (that is, the Nextcloud server itself) the files "index.php" and "version.php" do have the wrong version. -2. In the ownCloud core the unrequired extra file "/test.php" has been found. +2. In the Nextcloud core the unrequired extra file "/test.php" has been found. 3. It was not possible to verify the signature of the calendar application. The solution is to upload the correct "index.php" and "version.php" files, and delete the "test.php" file. For the calendar exception contact the developer of the application. For other means on how to receive support please take a look at -https://owncloud.org/support/. After fixing these problems verify by clicking +https://nextcloud.com/support/. After fixing these problems verify by clicking "Rescan…". .. note:: When using a FTP client to upload those files make sure it is using the ``Binary`` transfer mode instead of the ``ASCII`` transfer mode. - -.. _rescans_label: - + +.. _rescans_label: + Rescans ------- -Rescans are triggered at installation, and by updates. You may run scans manually with the ``occ`` command. The first command scans the ownCloud 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 - -See :doc:`../configuration_server/occ_command` to learn more about using ``occ``. + +See :doc:`../configuration_server/occ_command` to learn more about using ``occ``. Errors ------ @@ -198,20 +198,20 @@ The following errors can be encountered when trying to verify a code signature. - ``INVALID_HASH`` - The file has a different hash than specified within ``signature.json``. This - usually happens when the file has been modified after writing the signature + usually happens when the file has been modified after writing the signature data. - ``MISSING_FILE`` - - The file cannot be found but has been specified within ``signature.json``. - Either a required file has been left out, or ``signature.json`` needs to be + - The file cannot be found but has been specified within ``signature.json``. + Either a required file has been left out, or ``signature.json`` needs to be edited. - ``EXTRA_FILE`` - - The file does not exist in ``signature.json``. This usually happens when a + - The file does not exist in ``signature.json``. This usually happens when a file has been removed and ``signature.json`` has not been updated. It also - happens if you have placed additional files in your ownCloud installation + happens if you have placed additional files in your Nextcloud installation folder. - ``EXCEPTION`` @@ -221,18 +221,18 @@ The following errors can be encountered when trying to verify a code signature. - ``Signature data not found.``` - - The app has mandatory code signing enforced but no ``signature.json`` + - The app has mandatory code signing enforced but no ``signature.json`` file has been found in its ``appinfo`` folder. - ``Certificate is not valid.`` - - The certificate has not been issued by the official ownCloud Code + - The certificate has not been issued by the official Nextcloud Code Signing Root Authority. - ``Certificate is not valid for required scope. (Requested: %s, current: %s)`` - - The certificate is not valid for the defined application. Certificates - are only valid for the defined app identifier and cannot be used for + - The certificate is not valid for the defined application. Certificates + are only valid for the defined app identifier and cannot be used for others. - ``Signature could not get verified.`` diff --git a/admin_manual/issues/general_troubleshooting.rst b/admin_manual/issues/general_troubleshooting.rst index ce7eed5279f..c64adc34478 100644 --- a/admin_manual/issues/general_troubleshooting.rst +++ b/admin_manual/issues/general_troubleshooting.rst @@ -2,31 +2,30 @@ General Troubleshooting ======================= -If you have trouble installing, configuring or maintaining ownCloud, please +If you have trouble installing, configuring or maintaining Nextcloud, please refer to our community support channels: -* `The ownCloud Forums`_ +* `The Nextcloud Forums`_ -.. note:: The ownCloud forums have a `FAQ page`_ where each topic corresponds +.. note:: The Nextcloud forums have a `FAQ page`_ where each topic corresponds to typical mistakes or frequently occurring issues -* `The ownCloud User mailing list`_ -* The ownCloud IRC chat channel ``irc://#owncloud@freenode.net`` on +* `The Nextcloud forums`_ +* The Nextcloud IRC chat channel ``irc://#nextcloud@freenode.net`` on freenode.net, also accessible via `webchat`_ Please understand that all these channels essentially consist of users like you helping each other out. Consider helping others out where you can, to contribute back for the help you get. This is the only way to keep a community like -ownCloud healthy and sustainable! +Nextcloud healthy and sustainable! -If you are using ownCloud in a business or otherwise large scale deployment, -note that ownCloud Inc. offers the `Enterprise Edition`_ with commercial -support options. +If you are using Nextcloud in a business or otherwise large scale deployment, +note that Nextcloud GmbH offers commercial support options. Bugs ---- -If you think you have found a bug in ownCloud, please: +If you think you have found a bug in Nextcloud, please: * Search for a solution (see the options above) * Double-check your configuration @@ -35,20 +34,15 @@ If you can't find a solution, please use our `bugtracker`_. You can generate a configuration report with the :ref:`occ config command `, with passwords automatically obscured. -.. _the ownCloud Forums: https://forum.owncloud.org -.. _FAQ page: https://forum.owncloud.org/viewforum.php?f=17 -.. _the ownCloud User mailing list: - https://mailman.owncloud.org/mailman/listinfo/user -.. _webchat: http://webchat.freenode.net/?channels=owncloud -.. _Enterprise Edition: https://owncloud.com/lp/community-or-enterprise/ -.. _bugtracker: - https://doc.owncloud.org/server/9.1/developer_manual/bugtracker/index.html +.. _the Nextcloud Forums: https://help.nextcloud.com +.. _webchat: http://webchat.freenode.net/?channels=nextcloud + https://docs.nextcloud.org/server/10/developer_manual/bugtracker/index.html .. TODO ON RELEASE: Update version number above on release General Troubleshooting ----------------------- -Check the ownCloud :doc:`../installation/system_requirements`, especially +Check the Nextcloud :doc:`../installation/system_requirements`, especially supported browser versions. When you see warnings about ``code integrity``, refer to :doc:`code_signing`. @@ -61,12 +55,12 @@ different issues. Always disable 3rd party apps before upgrades, and for troubleshooting. Please refer to the :ref:`apps_commands_label` on how to disable an app from command line. -ownCloud Logfiles -^^^^^^^^^^^^^^^^^ +Nextcloud Logfiles +^^^^^^^^^^^^^^^^^^ -In a standard ownCloud installation the log level is set to ``Normal``. To find +In a standard Nextcloud installation the log level is set to ``Normal``. To find any issues you need to raise the log level to ``All`` in your ``config.php`` -file, or to **Everything** on your ownCloud Admin page. Please see +file, or to **Everything** on your Nextcloud Admin page. Please see :doc:`../configuration_server/logging_configuration` for more information on these log levels. @@ -79,8 +73,8 @@ major browsers have developer tools for viewing the console, and you usually access them by pressing F12. For Firefox we recommend to installing the `Firebug extension `_. -.. note:: The logfile of ownCloud is located in the data directory - ``owncloud/data/owncloud.log``. +.. note:: The logfile of Nextcloud is located in the data directory + ``nextcloud/data/nextcloud.log``. .. _label-phpinfo: @@ -109,7 +103,7 @@ security risk to expose such sensitive data. Debugging Sync Issues ^^^^^^^^^^^^^^^^^^^^^ -.. warning:: The data directory on the server is exclusive to ownCloud and must +.. warning:: The data directory on the server is exclusive to Nextcloud and must not be modified manually. Disregarding this can lead to unwanted behaviours like: @@ -120,7 +114,7 @@ Disregarding this can lead to unwanted behaviours like: If you need to directly upload files from the same server please use a WebDAV command line client like ``cadaver`` to upload files to the WebDAV interface at: -``https://example.com/owncloud/remote.php/dav`` +``https://example.com/nextcloud/remote.php/dav`` Common problems / error messages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -139,16 +133,16 @@ Some common problems / error messages found in your logfiles as described above: refer to :ref:`db-troubleshooting-label` for more information. * ``SQLSTATE[HY000] [2002] No such file or directory`` -> There is a problem accessing your SQLite database file in your data directory - (``data/owncloud.db``). Please check the permissions of this folder/file or + (``data/nextcloud.db``). Please check the permissions of this folder/file or if it exists at all. If you're using MySQL please start your database. * ``Connection closed / Operation cancelled`` -> This could be caused by wrong ``KeepAlive`` settings within your Apache config. Make sure that ``KeepAlive`` is set to ``On`` and also try to raise the limits of ``KeepAliveTimeout`` and ``MaxKeepAliveRequests``. * ``No basic authentication headers were found`` -> This error is shown in your - ``data/owncloud.log`` file. Some Apache modules like ``mod_fastcgi``, ``mod_fcgid`` + ``data/nextcloud.log`` file. Some Apache modules like ``mod_fastcgi``, ``mod_fcgid`` or ``mod_proxy_fcgi`` are not passing the needed authentication headers to - PHP and so the login to ownCloud via WebDAV, CalDAV and CardDAV clients is + PHP and so the login to Nextcloud via WebDAV, CalDAV and CardDAV clients is failing. Information on how to correctly configure your environment can be found at the `forums `_. @@ -159,7 +153,7 @@ Logfiles ^^^^^^^^ When having issues the first step is to check the logfiles provided by PHP, the -Web server and ownCloud itself. +Web server and Nextcloud itself. .. note:: In the following the paths to the logfiles of a default Debian installation running Apache2 with mod_php is assumed. On other Web servers, @@ -170,13 +164,13 @@ Web server and ownCloud itself. You need to set the directive ``log_errors`` to ``On`` and choose the path to store the logfile in the ``error_log`` directive. After those changes you need to restart your Web server. -* The logfile of ownCloud is located in the data directory - ``/var/www/owncloud/data/owncloud.log``. +* The logfile of Nextcloud is located in the data directory + ``/var/www/nextcloud/data/nextcloud.log``. Web server and PHP modules ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. note:: Lighttpd is not supported with ownCloud, and some ownCloud features +.. note:: Lighttpd is not supported with Nextcloud, and some Nextcloud features may not work at all on Lighttpd. There are some Web server or PHP modules which are known to cause various @@ -212,11 +206,11 @@ these modules: Troubleshooting WebDAV ---------------------- -ownCloud uses SabreDAV, and the SabreDAV documentation is comprehensive and +Nextcloud uses SabreDAV, and the SabreDAV documentation is comprehensive and helpful. -.. note: Lighttpd is not supported on ownCloud, and Lighttpd WebDAV does not - work with ownCloud. +.. note: Lighttpd is not supported on Nextcloud, and Lighttpd WebDAV does not + work with Nextcloud. See: @@ -233,7 +227,7 @@ See: `_ (Describes problems with Finder on various Web servers) -There is also a well maintained FAQ thread available at the `ownCloud Forums +There is also a well maintained FAQ thread available at the `ownCloud Forums `_ which contains various additional information about WebDAV problems. @@ -248,7 +242,7 @@ Service discovery Some clients - especially on iOS/Mac OS X - have problems finding the proper sync URL, even when explicitly configured to use it. -If you want to use CalDAV or CardDAV clients together with ownCloud it is +If you want to use CalDAV or CardDAV clients together with Nextcloud it is important to have a correct working setup of the following URLs: | ``https://example.com/.well-known/carddav`` @@ -256,26 +250,26 @@ important to have a correct working setup of the following URLs: | Those need to be redirecting your clients to the correct DAV endpoints. If -running ownCloud at the document root of your Web server the correct URL is: +running Nextcloud at the document root of your Web server the correct URL is: ``https://example.com/remote.php/dav`` -and if running in a subfolder like ``owncloud``: +and if running in a subfolder like ``nextcloud``: -``https://example.com/owncloud/remote.php/dav`` +``https://example.com/nextcloud/remote.php/dav`` -For the first case the :file:`.htaccess` file shipped with ownCloud should do +For the first case the :file:`.htaccess` file shipped with Nextcloud should do this work for your when running Apache. You only need to make sure that your Web server is using this file. When running NGINX please refer to :doc:`../installation/nginx_examples`. -If your ownCloud instance is installed in a subfolder called ``owncloud`` and +If your Nextcloud instance is installed in a subfolder called ``nextcloud`` and you're running Apache create or edit the :file:`.htaccess` file within the document root of your Web server and add the following lines:: - Redirect 301 /.well-known/carddav /owncloud/remote.php/dav - Redirect 301 /.well-known/caldav /owncloud/remote.php/dav + Redirect 301 /.well-known/carddav /nextcloud/remote.php/dav + Redirect 301 /.well-known/caldav /nextcloud/remote.php/dav Now change the URL in the client settings to just use: @@ -283,7 +277,7 @@ Now change the URL in the client settings to just use: instead of e.g. -``https://example.com/owncloud/remote.php/dav/principals/username``. +``https://example.com/nextcloud/remote.php/dav/principals/username``. There are also several techniques to remedy this, which are described extensively at the `Sabre DAV website `_. diff --git a/admin_manual/maintenance/manual_upgrade.rst b/admin_manual/maintenance/manual_upgrade.rst index 654d34f5c4d..77950e507d3 100644 --- a/admin_manual/maintenance/manual_upgrade.rst +++ b/admin_manual/maintenance/manual_upgrade.rst @@ -83,7 +83,7 @@ If you need to reverse your upgrade, see :doc:`restore`. Troubleshooting --------------- -When upgrading ownCloud and you are running MySQL or MariaDB with binary +When upgrading Nextcloud and you are running MySQL or MariaDB with binary logging enabled, your upgrade may fail with these errors in your MySQL/MariaDB log:: diff --git a/admin_manual/maintenance/migrating.rst b/admin_manual/maintenance/migrating.rst index 311b439fb9d..cf5cb4039a2 100644 --- a/admin_manual/maintenance/migrating.rst +++ b/admin_manual/maintenance/migrating.rst @@ -31,7 +31,7 @@ the new location. It is also assumed that the authentication method #. Set up the new machine with the desired OS, install and configure the Web server as well as PHP for Nextcloud (e.g. permissions or file upload size - limits) and make sure the PHP version matches ownCloud supported + limits) and make sure the PHP version matches Nextcloud supported configuration and all relevant PHP extensions are installed. Also set up the database and make sure it is an Nextcloud supported configuration. If your original machine was installed recently just copying that base diff --git a/admin_manual/maintenance/package_upgrade.rst b/admin_manual/maintenance/package_upgrade.rst index 290c92ffd20..2088b2ca25f 100644 --- a/admin_manual/maintenance/package_upgrade.rst +++ b/admin_manual/maintenance/package_upgrade.rst @@ -65,12 +65,12 @@ For example: sudo snap refresh nextcloud Your Snap package manager only upgrades the current Nextcloud Snap. Then -your ownCloud server is immediately put into maintenance mode. You may not see +your Nextcloud server is immediately put into maintenance mode. You may not see this until you refresh your Nextcloud page. .. figure:: images/upgrade-1.png :scale: 75% - :alt: ownCloud status screen informing users that it is in maintenance mode. + :alt: Nextcloud status screen informing users that it is in maintenance mode. Then use ``occ`` to complete the upgrade. You must run ``occ`` as your HTTP user. This example is for Debian/Ubuntu:: @@ -117,7 +117,7 @@ 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: +If you did **not** install via a Snap package: #. Upgrade your current version to the latest point release #. Upgrade your current version to the next major release diff --git a/admin_manual/maintenance/restore.rst b/admin_manual/maintenance/restore.rst index 6a6b31fb262..2b0fbc5078c 100644 --- a/admin_manual/maintenance/restore.rst +++ b/admin_manual/maintenance/restore.rst @@ -2,7 +2,7 @@ Restoring Nextcloud =================== -To restore a Nextcloud installation there are four main things you need to +To restore a Nextcloud installation there are four main things you need to restore: #. The configuration directory @@ -10,19 +10,19 @@ restore: #. The database #. The theme directory -.. note:: You must have both the database and data directory. You cannot +.. note:: You must have both the database and data directory. You cannot complete restoration unless you have both of these. -When you have completed your restoration, see the ``Setting Strong Directory +When you have completed your restoration, see the ``Setting Strong Directory Permissions`` section of :doc:`../installation/installation_wizard`. Restore Folders --------------- -.. note:: This guide assumes that your previous backup is called - "owncloud-dirbkp" +.. note:: This guide assumes that your previous backup is called + "nextcloud-dirbkp" -Simply copy your configuration and data folder (or even your whole Nextcloud +Simply copy your configuration and data folder (or even your whole Nextcloud install and data folder) to your Nextcloud environment. You could use this command:: rsync -Aax nextcloud-dirbkp/ nextcloud/ @@ -30,7 +30,7 @@ install and data folder) to your Nextcloud environment. You could use this comma Restore Database ---------------- -.. note:: This guide assumes that your previous backup is called +.. note:: This guide assumes that your previous backup is called "nextcloud-sqlbkp.bak" MySQL @@ -51,5 +51,5 @@ PostgreSQL ^^^^^^^^^^ :: - PGPASSWORD="password" pg_restore -c -d nextcloud -h [server] -U [username] + PGPASSWORD="password" pg_restore -c -d nextcloud -h [server] -U [username] nextcloud-sqlbkp.bak diff --git a/admin_manual/maintenance/update.rst b/admin_manual/maintenance/update.rst index 7ebffe55199..31ea4b58a08 100644 --- a/admin_manual/maintenance/update.rst +++ b/admin_manual/maintenance/update.rst @@ -64,7 +64,7 @@ steps: .. figure:: images/upgrade-2.png :scale: 75% - :alt: ownCloud upgrade wizard screen. + :alt: Nextcloud upgrade wizard screen. .. note:: If you have a large Nextcloud installation and have shell access, you should use the ``occ upgrade`` command, running it as your HTTP user, @@ -157,7 +157,7 @@ You can display a help summary:: When you run it without options it runs a system check:: sudo -u www-data php nextcloud/updater/application.php - Nextcloud updater 1.0 - CLI based ownCloud server upgrades + Nextcloud updater 1.0 - CLI based Nextcloud server upgrades Checking system health. - file permissions are ok. Current version is 9.0.0.12 diff --git a/admin_manual/maintenance/upgrade.rst b/admin_manual/maintenance/upgrade.rst index e771da4a283..2315859b60a 100644 --- a/admin_manual/maintenance/upgrade.rst +++ b/admin_manual/maintenance/upgrade.rst @@ -1,83 +1,74 @@ -=================================== -How to Upgrade Your ownCloud Server -=================================== +==================================== +How to Upgrade Your Nextcloud Server +==================================== -There are three ways to upgrade your ownCloud server: +There are three ways to upgrade your Nextcloud server: -* Using your :doc:`Linux package manager ` with our official - ownCloud repositories. This is the recommended method. -* With the :doc:`Updater App ` (Server Edition only). Recommended for - shared hosters, and for users who want an easy way to track different - release channels. (It is not available and not supported on the Enterprise +* Using your :doc:`Linux package manager ` with our official + Nextcloud repositories. This is the recommended method. +* With the :doc:`Updater App ` (Server Edition only). Recommended for + shared hosters, and for users who want an easy way to track different + release channels. (It is not available and not supported on the Enterprise edition.) -* :doc:`Manually upgrading ` with the ownCloud ``.tar`` archive - from `owncloud.org/install/`_. -* Manually upgrading is also an option for users on shared hosting; download - and unpack the ownCloud tarball to your PC. Delete your existing ownCloud - files, except ``data/`` and ``config/`` files, on your hosting account. Then - transfer the new ownCloud files to your hosting account, again +* :doc:`Manually upgrading ` with the Nextcloud ``.tar`` archive + from `https://nextcloud.com/install/`_. +* Manually upgrading is also an option for users on shared hosting; download + and unpack the Nextcloud tarball to your PC. Delete your existing Nextcloud + files, except ``data/`` and ``config/`` files, on your hosting account. Then + transfer the new Nextcloud files to your hosting account, again preserving your existing ``data/`` and ``config/`` files. - -When an update is available for your ownCloud server, you will see a -notification at the top of your ownCloud Web interface. When you click the + +When an update is available for your Nextcloud server, you will see a +notification at the top of your Nextcloud Web interface. When you click the notification it brings you here, to this page. -**It is best to keep your ownCloud server upgraded regularly**, and to install +**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 ownCloud server will be put into maintenance -mode, so your users will be locked out until the upgrade is completed. Large +**Upgrading is disruptive**. Your Nextcloud server will be put into maintenance +mode, so your users will be locked out until the upgrade is completed. Large installations may take several hours to complete the upgrade. -.. warning:: **Downgrading is not supported** and risks corrupting your data! If - you want to revert to an older ownCloud version, make a new, fresh - installation and then restore your data from backup. Before doing this, - file a support ticket (if you have paid support) or ask for help in the - ownCloud forums to see if your issue can be resolved without downgrading. +.. warning:: **Downgrading is not supported** and risks corrupting your data! If + you want to revert to an older Nextcloud version, make a new, fresh + installation and then restore your data from backup. Before doing this, + file a support ticket (if you have paid support) or ask for help in the + Nextcloud forums to see if your issue can be resolved without downgrading. .. not sure about notifications .. Update Notifier and Updater App Are Not the Same .. ------------------------------------------------ -.. ownCloud has two update tools: the ownCloud core update notifier, and the -.. Updater app. Figure 1 shows what you see when the Updater app is enabled: -.. both -.. the core notifier and the Updater app control panel are visible on your -.. admin +.. Nextcloud has two update tools: the Nextcloud core update notifier, and the +.. Updater app. Figure 1 shows what you see when the Updater app is enabled: +.. both +.. the core notifier and the Updater app control panel are visible on your +.. admin .. page. .. .. figure:: images/2-updates.png .. :alt: Both update mechanisms displayed on Admin page. - -.. *Figure 1: The top yellow banner is the update notifier, and the Updates + +.. *Figure 1: The top yellow banner is the update notifier, and the Updates .. section is the Updater app.* - -.. The core update notifier has only one function, and that is to display a -.. notification when a new ownCloud release is available. Then you decide which -.. upgrade method to use. When you maintain your ownCloud server via your Linux + +.. The core update notifier has only one function, and that is to display a +.. notification when a new Nextcloud release is available. Then you decide which +.. upgrade method to use. When you maintain your Nextcloud server via your Linux .. package manager you should ensure that the Updater app is disabled. - + Prerequisites ------------- -You should always maintain :doc:`regular backups ` and make a fresh +You should always maintain :doc:`regular backups ` and make a fresh backup before every upgrade. -Then review third-party apps, if you have any, for compatibility with the new -ownCloud release. Any apps that are not developed by ownCloud 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 +Then review third-party apps, if you have any, for compatibility with the new +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. - -Debian Migration to Official ownCloud Packages ----------------------------------------------- - -As of March 2016 Debian will not include ownCloud packages. Debian users can -migrate to the official ownCloud packages by following this guide, -`Upgrading ownCloud on Debian Stable to official packages -`_. diff --git a/admin_manual/operations/considerations_on_monitoring.rst b/admin_manual/operations/considerations_on_monitoring.rst index 3e7a089be79..8f4eb96b787 100644 --- a/admin_manual/operations/considerations_on_monitoring.rst +++ b/admin_manual/operations/considerations_on_monitoring.rst @@ -6,43 +6,43 @@ Considerations on Monitoring :maxdepth: 2 :hidden: -Large scale ownCloud deployments are typically installed as load balanced +Large scale Nextcloud deployments are typically installed as load balanced n-tier web applications. Successfully managing such an installation requires active monitoring of the application and supporting infrastructure components. -The purpose of this section is to outline the components of ownCloud that need -to be monitored, and provide guidance on what to look for in ownCloud in an +The purpose of this section is to outline the components of Nextcloud that need +to be monitored, and provide guidance on what to look for in Nextcloud in an enterprise installation. -ownCloud Deployment Architecture -================================ +Nextcloud Deployment Architecture +================================= -Before discussing how to monitor ownCloud, it is important to understand the architecture of a -typical ownCloud deployment. These monitoring best practices are developed based on the use of load +Before discussing how to monitor Nextcloud, it is important to understand the architecture of a +typical Nextcloud deployment. These monitoring best practices are developed based on the use of load balanced Web servers, a clustered database running a distributed database storage engine, such as MySQL NDB, and a clustered filesystem, such as Red Hat Storage. It is assumed that specific enterprise tools (monitoring, log management, etc) to monitor -operations are available, and that ownCloud is simply a new target for these tools. +operations are available, and that Nextcloud is simply a new target for these tools. -The Important Components of ownCloud -==================================== +The Important Components of Nextcloud +===================================== -ownCloud is a PHP application that depends on a filesystem for file storage, and a database for storing +Nextcloud is a PHP application that depends on a filesystem for file storage, and a database for storing user and file meta data, as well as some application specific information. While the loss of an app server or a node in the database or storage clusters should not bring the system down, knowing that this happened and resolving it is essential to keeping the service running -efficiently. Therefore it is important to monitor the ownCloud servers, the Load Balancer, the Storage -Cluster and the Database. This documentation starts with the ownCloud application and works out from +efficiently. Therefore it is important to monitor the Nextcloud servers, the Load Balancer, the Storage +Cluster and the Database. This documentation starts with the Nextcloud application and works out from there through the layers of infrastructure. Status.php ---------- -ownCloud provides a very simple mechanism for determining if an application server is up and functioning – -call the status.php file on each ownCloud server. This file can be found in the root ownCloud directory on -the server, which by default is /owncloud/status.php. If the server is functioning normally, the response +Nextcloud provides a very simple mechanism for determining if an application server is up and functioning – +call the status.php file on each Nextcloud server. This file can be found in the root Nextcloud directory on +the server, which by default is /status.php. If the server is functioning normally, the response looks something like this: :: @@ -50,21 +50,21 @@ looks something like this: {"installed":"true","version":"6.0.0.16","versionstring":"6.0.1","edition":""} -We recommend monitoring this file on each ownCloud application server to provide a basic check that the +We recommend monitoring this file on each Nextcloud application server to provide a basic check that the server is operating properly. -ownCloud.log ------------- +Nextcloud.log +------------- -ownCloud also provides a built in logging function. If the ownCloud Enterprise Edition logging applications -are enabled, this file will track user logins and shared file activity. If these logging applications are -not enabled, this log file still tracks basic ownCloud health. Given the potential for this file to get +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. -Logfile entries that start with the keyword “Error” should be logged and reported to ownCloud support. +Logfile entries that start with the keyword “Error” should be logged and reported to Nextcloud support. Apache ^^^^^^ @@ -83,7 +83,7 @@ All mysql vendors provide tools to monitor this. Clustered Filesystem -------------------- -The available space of the filesystem should be monitored to prevent a full ownCloud. This functionality is +The available space of the filesystem should be monitored to prevent a full Nextcloud. This functionality is provided by the operating-system and/or the cluster filesystem vendor. Load Balancer @@ -92,9 +92,3 @@ Load Balancer The load balancer is monitoring the health of the application servers and is distributing the traffic in the optimal way. The application-servers should also be monitored to detect long lasting OS or hardware problems. Monitoring solutions like Nagios provide built in functionality to do this. - - - - - - diff --git a/admin_manual/operations/index.rst b/admin_manual/operations/index.rst index 0894427ea6f..bafaf6c76f1 100644 --- a/admin_manual/operations/index.rst +++ b/admin_manual/operations/index.rst @@ -3,7 +3,7 @@ Operations ========== Advanced operation including monitoring, scaling across multiple machines, and -creating a custom theme for your ownCloud server. +creating a custom theme for your Nextcloud server. .. toctree:: :maxdepth: 2 diff --git a/admin_manual/operations/scaling_multiple_machines.rst b/admin_manual/operations/scaling_multiple_machines.rst index 106a82b1948..b4f9c696954 100644 --- a/admin_manual/operations/scaling_multiple_machines.rst +++ b/admin_manual/operations/scaling_multiple_machines.rst @@ -6,9 +6,9 @@ Scaling Across Multiple Machines :maxdepth: 2 :hidden: -This document will cover the reference architecture for the ownCloud Scale Out +This document will cover the reference architecture for the Nextcloud Scale Out model for a single datacenter implementation. The document will focus on the -three main elements of an ownCloud deployment: +three main elements of an Nextcloud deployment: * Application layer * Database Layer @@ -21,10 +21,10 @@ Application Layer ================= For the application layer of this reference architecture we used Oracle -Enterprise Linux as the front end servers to host the ownCloud code. In this +Enterprise Linux as the front end servers to host the Nextcloud code. In this instance we made ``httpd`` a permissive domain, allowing it to operate within the SELinux environment. In this example we also used the standard directory -structure placing the ownCloud code in the Apache root directory. The +structure placing the Nextcloud code in the Apache root directory. The following components were installed on each application server: * Apache @@ -38,7 +38,7 @@ Also required is the PHP smbclient module or smbclient (see :doc:`../configuration_files/external_storage/smb`). It is also worth mentioning that the appropriate exceptions where made in the -firewall to allow the ownCloud traffic (for the purpose of testing we +firewall to allow the Nextcloud traffic (for the purpose of testing we enable both encrypted SSL via port 443 and unencrypted via port 80). The next step was to generate and import the needed SSL certificates following @@ -65,7 +65,7 @@ the IP address should one fail. .. Session Management (this section is a WIP pending testing based on customer feedback). .. The load balancer is to be configured to spread the workload across the various -.. ownCloud application servers, with details to be filled in around session +.. Nextcloud application servers, with details to be filled in around session .. management upon further testing. Database Layer @@ -84,7 +84,7 @@ looking like this: Taking a closer look at the database architecture, we have created redundant MySQL NDB Management nodes for redundancy and we have configured 3 NDB SQL/Storage nodes across which we are able to spread the database traffic. All -of the clients (ownCloud Application Servers) will connect to the database via +of the clients (Nextcloud Application Servers) will connect to the database via the My SQL Proxy. It is worth noting that MySQL proxy is still in beta and that using another load balancing method like HAProxy or F5 is supported, in that you will be distributing traffic among the various SQL/Storage nodes. Here, we simply diff --git a/admin_manual/operations/theming.rst b/admin_manual/operations/theming.rst index c7957806c4e..4ea74638d27 100644 --- a/admin_manual/operations/theming.rst +++ b/admin_manual/operations/theming.rst @@ -1,6 +1,6 @@ -================ -Theming ownCloud -================ +================= +Theming Nextcloud +================= .. toctree:: :maxdepth: 2 diff --git a/admin_manual/release_notes.rst b/admin_manual/release_notes.rst index 56aa1ff8be4..2b2e626527c 100644 --- a/admin_manual/release_notes.rst +++ b/admin_manual/release_notes.rst @@ -1,464 +1,9 @@ -================================ -ownCloud |version| Release Notes -================================ +================================= +Nextcloud |version| Release Notes +================================= -Changes in 9.0 --------------- +Changes in 10 +------------- -9.0 requires .ico files for favicons. This will change in 9.1, which will -use .svg files. See `Changing favicon -`_ in the Developer Manual. - -Home folder rule is enforced in the user_ldap application in new ownCloud installations; see -:doc:`configuration_user/user_auth_ldap`. This affects ownCloud 8.0.10, 8.1.5 and 8.2.0 and up. - -The Calendar and Contacts apps have been rewritten and the CalDAV and CardDAV backends of these -apps were merged into ownCloud core. During the upgrade existing Calendars and Addressbooks -are automatically migrated. As a fallback for failed upgrades or an option to test a migration -``dav:migrate-calendars`` and/or ``dav:migrate-addressbooks`` scripts are available via the -``occ`` command. See :doc:`configuration_server/occ_command`. - -Updates on systems with large datasets will take longer, due to the addition of checksums to the -oC database. See ``_. - -Linux packages are available from our `official download repository `_ . -New in 9.0: split packages. ``owncloud`` installs ownCloud plus dependencies, including Apache -and PHP. ``owncloud-files`` installs only ownCloud. This is useful for custom LAMP stacks, and -allows you to install your own LAMP apps and versions without packaging conflicts with ownCloud. -See :doc:`installation/linux_installation`. - -New option for the ownCloud admin to enable or disable sharing on individual external mountpoints -(see :ref:`external_storage_mount_options_label`). Sharing on such mountpoints is disabled by default. - -Enterprise 9.0 --------------- - -owncloud-enterprise packages are no longer available for CentOS6, RHEL6, -Debian7, or any version of Fedora. A new package, owncloud-enterprise-files, is available for all supported platforms, including the above. This new package comes without dependencies, and is installable on a larger number of platforms. System administrators must install their own LAMP stacks and databases. See https://owncloud.org/blog/time-to-upgrade-to-owncloud-9-0/ - -Changes in 8.2 --------------- - -New location for Linux package repositories; ownCloud admins must manually -change to the new repos. See :doc:`maintenance/upgrade` - -PHP 5.6.11+ breaks the LDAP wizard with a 'Could not connect to LDAP' error. See https://github.com/owncloud/core/issues/20020. - -``filesystem_check_changes`` in ``config.php`` is set to 0 by default. This -prevents unnecessary update checks and improves performance. If you are using -external storage mounts such as NFS on a remote storage server, set this to 1 -so that ownCloud will detect remote file changes. - -XSendFile support has been removed, so there is no longer support for `serving -static files -`_ from your ownCloud server. - -LDAP issue: 8.2 uses the ``memberof`` attribute by default. If this is not -activated on your LDAP server your user groups will not be detected, and you -will see this message in your ownCloud log: ``Error PHP Array to string -conversion at /var/www/html/owncloud/lib/private/template/functions.php#36``. -Fix this by disabling the ``memberof`` attribute on your ownCloud server with -the ``occ`` command, like this example on Ubuntu Linux:: - - sudo -u www-data php occ ldap:set-config "s01" useMemberOfToDetectMembership 0 - -Run ``sudo -u www-data php occ ldap:show-config`` to find the correct ``sNN`` -value; if there is not one then use empty quotes, ``""``. (See -:doc:`configuration_server/occ_command`.) - -Users of the Linux Package need to update their repository setup as described -in this `blogpost `_. - -Changes in 8.1 --------------- - -Use APCu only if available in version 4.0.6 and higher. If you install an older version, -you will see a ``APCu below version 4.0.6 is installed, for stability and performance -reasons we recommend to update to a newer APCu version`` warning on your ownCloud admin page. - -SMB external storage now based on ``php5-libsmbclient``, which must be downloaded -from the ownCloud software repositories (`installation instructions -`_). - -"Download from link" feature has been removed. - -The ``.htaccess`` and ``index.html`` files in the ``data/`` directory are now -updated after every update. If you make any modifications to these files they -will be lost after updates. - -The SabreDAV browser at ``/remote.php/webdav`` has been removed. - -Using ownCloud without a ``trusted_domain`` configuration will not work anymore. - -The logging format for failed logins has changed and considers now the proxy -configuration in ``config.php``. - -A default set of security and privacy HTTP headers have been added to the -ownCloud ``.htaccess`` file, and ownCloud administrators may now customize which -headers are sent. - -More strict SSL certificate checking improves security but can result in -"cURL error 60: SSL certificate problem: unable to get local issuer certificate" -errors with certain broken PHP versions. Please verify your SSL setup, update your -PHP or contact your vendor if you receive these errors. - -The persistent file-based cache (e.g. used by LDAP integration) has been dropped and -replaced with a memory-only cache, which must be explicitly configured. See -:doc:`configuration_user/user_auth_ldap`. Memory cache configuration for the -ownCloud server is no longer automatic, requiring installation of -your desired cache backend and configuration in -``config.php`` (see :doc:`configuration_server/caching_configuration`.) - -The OC_User_HTTP backend has been removed. Administrators are encouraged to use -the ``user_webdavauth`` application instead. - -ownCloud ships now with its own root certificate bundle derived from Mozilla's -root certificates file. The system root certificate bundle will not be used -anymore for most requests. - -When you upgrade from ownCloud 8.0, with encryption enabled, to 8.1, you must -enable the new encryption backend and migrate your encryption keys. See -:ref:`upgrading_encryption_label`. - -Encryption can no longer be disabled in ownCloud 8.1. It is planned to re-add -this feature to the command line client for a future release. - -It is not recommended to upgrade encryption-enabled systems from ownCloud Server 8.0 -to version 8.1.0 as there is a chance the migration will break. We recommend -migrating to the first bugfix release, ownCloud Server 8.1.1. - -Due to various technical issues, by default desktop sync clients older than -1.7 are not allowed to connect and sync with the ownCloud server. This is -configurable via the ``minimum.supported.desktop.version`` switch in -``config.php``. - -Previews are now generated at a maximum size of 2048 x 2048 pixels. This is configurable -via the ``preview_max_x`` and ``preview_max_y`` switches in ``config.php``. - -The ownCloud 8 server is not supported on any version of Windows. - -The 8.1.0 release has a minor bug which makes app updates fail at first try. Reload the -apps page and try again, and the update will succeed. - -The ``forcessl`` option within the ``config.php`` and the ``Enforce SSL`` option -within the Admin-Backend was removed. This now needs to be configured like -described in :ref:`use_https_label`. - -WebDAV file locking was removed in oC 8.1 which causes Finder on Mac OS X to mount WebDAV read-only. - -Enterprise 8.1 Only -------------------- - -The SharePoint Drive app does not verify the SSL certificate of the SharePoint -server or the ownCloud server, as it is expected that both devices are in the -same trusted environment. - -ownCloud 8.0 ------------- - -Manual LDAP Port Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When you are configuring the LDAP user and group backend application, ownCloud -may not auto-detect the LDAP server's port number, so you will need to enter it -manually. - -.. https://github.com/owncloud/core/pull/16748 - -No Preview Icon on Text Files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -There is no preview icon displayed for text files when the file contains fewer than six characters. - -.. https://github.com/owncloud/core/issues/16556#event-316503097 - -Remote Federated Cloud Share Cannot be Reshared With Local Users -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When you mount a Federated Cloud share from a remote ownCloud server, you cannot re-share it with -your local ownCloud users. (See :doc:`configuration_files/federated_cloud_sharing_configuration` -to learn more about federated cloud sharing) - -Manually Migrate Encryption Keys after Upgrade -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you are using the Encryption app and upgrading from older versions of -ownCloud to ownCloud 8.0, you must manually migrate your encryption keys. -See :ref:`upgrading_encryption_label`. - -Windows Server Not Supported -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Windows Server is not supported in ownCloud 8. - -PHP 5.3 Support Dropped -^^^^^^^^^^^^^^^^^^^^^^^ - -PHP 5.3 is not supported in ownCloud 8, and PHP 5.4 or better is required. - -Disable Apache Multiviews -^^^^^^^^^^^^^^^^^^^^^^^^^ - -If Multiviews are enabled in your Apache configuration, this may cause problems -with content negotiation, so disable Multiviews by removing it from your Apache -configuration. Look for lines like this:: - - - Options Indexes FollowSymLinks Multiviews - -Delete ``Multiviews`` and restart Apache. - -.. https://github.com/owncloud/core/issues/9039 - -ownCloud Does Not Follow Symlinks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -ownCloud's file scanner does not follow symlinks, which could lead to -infinite loops. To avoid this do not use soft or hard links in your ownCloud -data directory. - -.. https://github.com/owncloud/core/issues/8976 - -No Commas in Group Names -^^^^^^^^^^^^^^^^^^^^^^^^ - -Creating an ownCloud group with a comma in the group name causes ownCloud to -treat the group as two groups. - -.. https://github.com/owncloud/core/issues/10983 - -Hebrew File Names Too Large on Windows -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -On Windows servers Hebrew file names grow to five times their original size -after being translated to Unicode. - -.. https://github.com/owncloud/core/issues/8938 - -Google Drive Large Files Fail with 500 Error -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Google Drive tries to download the entire file into memory, then write it to a -temp file, and then stream it to the client, so very large file downloads from -Google Drive may fail with a 500 internal server error. - -.. https://github.com/owncloud/core/issues/8810 - -Encrypting Large Numbers of Files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When you activate the Encryption app on a running server that has large numbers -of files, it is possible that you will experience timeouts. It is best to -activate encryption at installation, before accumulating large numbers of files -on your ownCloud server. - -.. https://github.com/owncloud/core/issues/10657 - - -Enterprise 8.0 Only -------------------- - -Sharepoint Drive SSL Not Verified -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The SharePoint Drive app does not verify the SSL certificate of the SharePoint -server or the ownCloud server, as it is expected that both devices are in the -same trusted environment. - -No Federated Cloud Sharing with Shibboleth -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Federated Cloud Sharing (formerly Server-to-Server file sharing)does not work -with Shibboleth . - -.. https://github.com/owncloud/user_shibboleth/issues/28 - -Direct Uploads to SWIFT do not Appear in ownCloud -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When files are uploaded directly to a SWIFT share mounted as external storage -in ownCloud, the files do not appear in ownCloud. However, files uploaded to -the SWIFT mount through ownCloud are listed correctly in both locations. - -.. https://github.com/owncloud/core/issues/8633 - -SWIFT Objectstore Incompatible with Encryption App -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The current SWIFT implementation is incompatible with any app that uses direct -file I/O and circumvents the ownCloud virtual filesystem. Using the Encryption -app on a SWIFT object store incurs twice as many HTTP requests and increases -latency significantly. - -.. https://github.com/owncloud/core/issues/10900 - -App Store is Back -^^^^^^^^^^^^^^^^^ - -The ownCloud App Store has been re-enabled in oC 8. Note that third-party apps -are not supported. - -ownCloud 7 Release Notes ------------------------- - -Manual LDAP Port Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When you are configuring the LDAP user and group backend application, ownCloud -may not auto-detect the LDAP server's port number, so you will need to enter it -manually. - -.. https://github.com/owncloud/core/pull/16748 - -LDAP Search Performance Improved -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Prior to 7.0.4, LDAP searches were substring-based and would match search -attributes if the substring occurred anywhere in the attribute value. Rather, -searches are performed on beginning attributes. With 7.0.4, searches will match -at the beginning of the attribute value only. This provides better performance -and a better user experience. - -Substring searches can still be performed by prepending the search term with -"*".For example, a search for ``te`` will find Terri, but not Nate:: - - occ ldap:search "te" - -If you want to broaden the search to include -Nate, then search for ``*te``:: - - occ ldap:search "*te" - -Refine searches by adjusting the ``User Search Attributes`` field of the -Advanced tab in your LDAP configuration on the Admin page. For example, if your -search attributes are ``givenName`` and ``sn`` you can find users by first name -+ last name very quickly. For example, you'll find Terri Hanson by searching for -``te ha``. Trailing whitespaces are ignored. - -.. https://github.com/owncloud/core/issues/12647 - -Protecting ownCloud on IIS from Data Loss -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Under certain circumstances, running your ownCloud server on IIS could be at -risk of data loss. To prevent this, follow these steps. - -In your ownCloud server configuration file, ``owncloud\config\config.php``, set -``config_is_read_only`` to true. - -Set the ``config.php`` file to read-only. - -When you make server updates ``config.php`` must be made writeable. When your -updates are completed re-set it to read-only. - -Antivirus App Modes -^^^^^^^^^^^^^^^^^^^ - -The Antivirus App offers three modes for running the ClamAV anti-virus scanner: -as a daemon on the ownCloud server, a daemon on a remote server, or an -executable mode that calls ``clamscan`` on the local server. We recommend using -one of the daemon modes, as they are the most reliable. - -"Enable Only for Specific Groups" Fails -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Some ownCloud applications have the option to be enabled only for certain -groups. However, when you select specific groups they do not get access to the -app. - -Changes to File Previews -^^^^^^^^^^^^^^^^^^^^^^^^ - -For security and performance reasons, file previews are available only for -image files, covers of MP3 files, and text files, and have been disabled for -all other filetypes. Files without previews are represented by generic icons -according to their file types. - -4GB Limit on SFTP Transfers -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Because of limitations in ``phpseclib``, you cannot upload files larger than -4GB over SFTP. - -"Not Enough Space Available" on File Upload -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Setting user quotas to ``unlimited`` on an ownCloud installation that has -unreliable free disk space reporting-- for example, on a shared hosting -provider-- may cause file uploads to fail with a "Not Enough Space Available" -error. A workaround is to set file quotas for all users instead of -``unlimited``. - -No More Expiration Date On Local Shares -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In older versions of ownCloud, you could set an expiration date on both local -and public shares. Now you can set an expiration date only on public shares, -and -local shares do not expire when public shares expire. - -Zero Quota Not Read-Only -^^^^^^^^^^^^^^^^^^^^^^^^ - -Setting a user's storage quota should be the equivalent of read-only, however, -users can -still create empty files. - -Enterprise 7 Only ------------------ - -No Federated Cloud Sharing with Shibboleth -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Federated Cloud Sharing (formerly Server-to-Server file sharing) does not work -with Shibboleth . - -Windows Network Drive -^^^^^^^^^^^^^^^^^^^^^ -Windows Network Drive runs only on Linux servers because it requires the Samba -client, which is included in all Linux distributions. - -``php5-libsmbclient`` is also required, and there may be issues with older -versions of ``libsmbclient``; see Using External Storage > Installing and -Configuring the Windows Network Drive App in the Enterprise Admin manual for -more information. - -By default CentOS has activated SELinux, and the ``httpd`` process can not make -outgoing network connections. This will cause problems with curl, ldap and samba -libraries. Again, see Using External Storage > Installing and Configuring the -Windows Network Drive App in the Enterprise Admin manual for instructions. - -Sharepoint Drive SSL -^^^^^^^^^^^^^^^^^^^^ - -The SharePoint Drive app does not verify the SSL certificate of the SharePoint -server or the ownCloud server, as it is expected that both devices are in the -same trusted environment. - -Shibboleth and WebDAV Incompatible -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Shibboleth and standard WebDAV are incompatible, and cannot be used together in -ownCloud. If Shibboleth is enabled, the ownCloud client uses an extended WebDAV -protocol - -No SQLite -^^^^^^^^^ - -SQLite is no longer an installation option for ownCloud Enterprise Edition, as -it not suitable for multiple-user installations or managing large numbers of -files. - -No App Store -^^^^^^^^^^^^ - -The App Store is disabled for the Enterprise Edition. - -LDAP Home Connector Linux Only -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The LDAP Home Connector application requires Linux (with MySQL, MariaDB, -or PostgreSQL) to operate correctly. +tbd diff --git a/admin_manual/whats_new_admin.rst b/admin_manual/whats_new_admin.rst index c3dd89d3edd..fac61c1e980 100644 --- a/admin_manual/whats_new_admin.rst +++ b/admin_manual/whats_new_admin.rst @@ -1,26 +1,7 @@ -=========================================== -What's New for Admins in ownCloud |version| -=========================================== +============================================ +What's New for Admins in Nextcloud |version| +============================================ -See the `ownCloud 9.1 Features page -`_ on Github for a +See the `Nextcloud 10 Features page +`_ on Github for a comprehensive list of new features and updates. - -ownCloud has many improvements. Some of our new features are: - -* New ``occ`` option, ``--unscanned``, to scan only previously unscanned - files (``_) -* New ``occ`` command to disable/enable users -* New ``occ`` command to disable/enable two-factor auth for specific users -* New group tags for system file tags - (``_) -* Cleaner internal file URLs - (``_) -* Google Drive/Dropbox configuration dropdown; easier configuration for shared - hosters (``_) -* - - -Enterprise Only ---------------- - diff --git a/developer_manual/android_library/examples.rst b/developer_manual/android_library/examples.rst index 416a8d1f6e4..c1f4a477b52 100644 --- a/developer_manual/android_library/examples.rst +++ b/developer_manual/android_library/examples.rst @@ -55,15 +55,15 @@ Code example ... // Set basic credentials client.setCredentials( - OwnCloudCredentialsFactory.newBasicCredentials(username, password) + NextcloudCredentialsFactory.newBasicCredentials(username, password) ); // Set bearer access token client.setCredentials( - OwnCloudCredentialsFactory.newBearerCredentials(accessToken) + NextcloudCredentialsFactory.newBearerCredentials(accessToken) ); // Set SAML2 session token client.setCredentials( - OwnCloudCredentialsFactory.newSamlSsoCredentials(cookie) + NextcloudCredentialsFactory.newSamlSsoCredentials(cookie) ); } @@ -75,12 +75,12 @@ of the new folder. Code example ~~~~~~~~~~~~ -   +   .. code-block:: java private void startFolderCreation(String newFolderPath) { - CreateRemoteFolderOperation createOperation = new CreateRemoteFolderOperation(newFolderPath, false); - createOperation.execute( mClient , this , mHandler); + CreateRemoteFolderOperation createOperation = new CreateRemoteFolderOperation(newFolderPath, false); + createOperation.execute( mClient , this , mHandler); } @Override @@ -114,10 +114,10 @@ Code example @Override - public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) { + public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof ReadRemoteFolderOperation) { if (result.isSuccess()) { - List< RemoteFile > files = result.getData(); + List< RemoteFile > files = result.getData(); // do your stuff here } } @@ -143,7 +143,7 @@ Code example @Override public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof ReadRemoteFileOperation) { - if (result.isSuccess()) { + if (result.isSuccess()) { RemoteFile file = result.getData()[0]; // do your stuff here } @@ -162,7 +162,7 @@ Code example .. code-block:: java - private void startRemoveFile(String filePath) { + private void startRemoveFile(String filePath) { RemoveRemoteFileOperation removeOperation = new RemoveRemoteFileOperation(remotePath); removeOperation.execute( mClient , this , mHandler); } @@ -170,8 +170,8 @@ Code example @Override public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof RemoveRemoteFileOperation) { - if (result.isSuccess()) { - // do your stuff here + if (result.isSuccess()) { + // do your stuff here } } … @@ -192,7 +192,7 @@ Code example private void startDownload(String filePath, File targetDirectory) { DownloadRemoteFileOperation downloadOperation = new DownloadRemoteFileOperation(filePath, targetDirectory.getAbsolutePath()); - downloadOperation.addDatatransferProgressListener(this); + downloadOperation.addDatatransferProgressListener(this); downloadOperation.execute( mClient, this, mHandler); } @@ -209,7 +209,7 @@ Code example public void onTransferProgress( long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) { mHandler.post( new Runnable() { @Override - public void run() { + public void run() { // do your UI updates about progress here } }); @@ -227,22 +227,22 @@ Code example .. code-block:: java - private void startUpload (File fileToUpload, String remotePath, String mimeType) { + private void startUpload (File fileToUpload, String remotePath, String mimeType) { UploadRemoteFileOperation uploadOperation = new UploadRemoteFileOperation( fileToUpload.getAbsolutePath(), remotePath, mimeType); - uploadOperation.addDatatransferProgressListener(this); - uploadOperation.execute(mClient, this, mHandler); + uploadOperation.addDatatransferProgressListener(this); + uploadOperation.execute(mClient, this, mHandler); } @Override public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof UploadRemoteFileOperation) { if (result.isSuccess()) { - // do your stuff here + // do your stuff here } } } - @Override + @Override public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) { mHandler.post( new Runnable() { @Override @@ -256,7 +256,7 @@ Move a file or folder --------------------- Move an exisintg file or folder to a different location in the Nextcloud server. Parameters needed are the path -to the file or folder to move, and the new path desired for it. The parent folder of the new path must exist in +to the file or folder to move, and the new path desired for it. The parent folder of the new path must exist in the server. When the parameter 'overwrite' is set to 'true', the file or folder is moved even if the new path is already @@ -264,12 +264,12 @@ used by a different file or folder. This one will be replaced by the former. Code example ~~~~~~~~~~~~ -   +   .. code-block:: java private void startFileMove(String filePath, String newFilePath, boolean overwrite) { - MoveRemoteFileOperation moveOperation = new MoveRemoteFileOperation(filePath, newFilePath, overwrite); - moveOperation.execute( mClient , this , mHandler); + MoveRemoteFileOperation moveOperation = new MoveRemoteFileOperation(filePath, newFilePath, overwrite); + moveOperation.execute( mClient , this , mHandler); } @Override @@ -295,14 +295,14 @@ Code example private void startAllSharesRetrieval() { GetRemoteSharesOperation getSharesOp = new GetRemoteSharesOperation(); - getSharesOp.execute( mClient , this , mHandler); + getSharesOp.execute( mClient , this , mHandler); } @Override public void onRemoteOperationFinish( RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof GetRemoteSharesOperation) { - if (result.isSuccess()) { - ArrayList< OCShare > shares = new ArrayList< OCShare >(); + if (result.isSuccess()) { + ArrayList< OCShare > shares = new ArrayList< OCShare >(); for (Object obj: result.getData()) { shares.add(( OCShare) obj); } @@ -327,21 +327,21 @@ Code example private void startSharesRetrievalForFileOrFolder(String filePath, boolean getReshares) { GeteRemoteSharesForFileOperation operation = new GetRemoteSharesForFileOperation(filePath, getReshares, false); - operation.execute( mClient, this, mHandler); + operation.execute( mClient, this, mHandler); } private void startSharesRetrievalForFilesInFolder(String folderPath, boolean getReshares) { GetRemoteSharesForFileOperation operation = new GetRemoteSharesForFileOperation(folderPath, getReshares, true); - operation.execute( mClient, this, mHandler); + operation.execute( mClient, this, mHandler); } @Override public void onRemoteOperationFinish( RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof GetRemoteSharesForFileOperation) { if (result.isSuccess()) { - ArrayList< OCShare > shares = new ArrayList< OCShare >(); + ArrayList< OCShare > shares = new ArrayList< OCShare >(); for (Object obj: result.getData()) { - shares.add(( OCShare) obj); + shares.add(( OCShare) obj); } // do your stuff here } @@ -371,8 +371,8 @@ Code example } private void startCreationOfGroupShareForFile(String filePath, String groupId) { - CreateRemoteShareOperation operation = new CreateRemoteShareOperation(filePath, ShareType.GROUP, groupId, false , "", 31); - operation.execute(mClient, this, mHandler); + CreateRemoteShareOperation operation = new CreateRemoteShareOperation(filePath, ShareType.GROUP, groupId, false , "", 31); + operation.execute(mClient, this, mHandler); } private void startCreationOfUserShareForFile(String filePath, String userId) { @@ -383,7 +383,7 @@ Code example @Override public void onRemoteOperationFinish( RemoteOperation operation, RemoteOperationResult result) { if (operation instanceof CreateRemoteShareOperation) { - if (result.isSuccess()) { + if (result.isSuccess()) { OCShare share = (OCShare) result.getData ().get(0); // do your stuff here } diff --git a/developer_manual/android_library/index.rst b/developer_manual/android_library/index.rst index 19bf622c99a..dc96e425056 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 @@ -22,7 +22,7 @@ You might want to start with doing one or two `starter issue `_ diff --git a/developer_manual/app/backgroundjobs.rst b/developer_manual/app/backgroundjobs.rst index 15c2f7ab90c..032a2429663 100644 --- a/developer_manual/app/backgroundjobs.rst +++ b/developer_manual/app/backgroundjobs.rst @@ -36,4 +36,4 @@ Don't forget to configure the cron service on the server by executing:: where **http** is your Web server user, and add:: - */15 * * * * php -f /srv/http/owncloud/cron.php + */15 * * * * php -f /srv/http/nextcloud/cron.php diff --git a/developer_manual/app/changelog.rst b/developer_manual/app/changelog.rst index d69123111c9..2ce16aaef63 100644 --- a/developer_manual/app/changelog.rst +++ b/developer_manual/app/changelog.rst @@ -4,46 +4,17 @@ Changelog .. sectionauthor:: Bernhard Posselt -The following changes went into ownCloud 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. +This is a deprecation roadmap which lists all current deprecation targets and will be updated from release to release. This lists the year when a specific method or class will be removed. .. note:: Deprecations on interfaces also affect the implementing classes! -11.1 +2018 ---- * **OCP\\App::setActiveNavigationEntry** has been deprecated in favour of **\\OCP\\INavigationManager** * **OCP\\BackgroundJob::registerJob** has been deprecated in favour of **OCP\\BackgroundJob\\IJobList** -* **OCP\\Contacts** functions has been deprecated in favour of **\\OCP\\Contacts\\IManager** +* **OCP\\Contacts** functions has been deprecated in favour of **\\OCP\\Contacts\\IManager** * **OCP\\DB** functions have been deprecated in favour of the ones in **\\OCP\\IDBConnection** * **OCP\\Files::tmpFile** has been deprecated in favour of **\\OCP\\ITempManager::getTemporaryFile** * **OCP\\Files::tmpFolder** has been deprecated in favour of **\\OCP\\ITempManager::getTemporaryFolder** @@ -54,7 +25,7 @@ This is a deprecation roadmap which lists all current deprecation targets and wi * **\\OCP\\JSON** has been completely deprecated in favour of the AppFramework. Developers shall use the AppFramework instead of using the legacy **OCP\\JSON** code. This allows testable controllers and is highly encouraged. * **\\OCP\\Response** has been completely deprecated in favour of the AppFramework. Developers shall use the AppFramework instead of using the legacy **OCP\\JSON** code. This allows testable controllers and is highly encouraged. -* Diverse **OCP\\Users** function got deprecated in favour of **OCP\\IUserManager**: +* Diverse **OCP\\Users** function got deprecated in favour of **OCP\\IUserManager**: * **OCP\\Users::getUsers** has been deprecated in favour of **OCP\\IUserManager::search** * **OCP\\Users::getDisplayName** has been deprecated in favour of **OCP\\IUserManager::getDisplayName** @@ -65,9 +36,13 @@ This is a deprecation roadmap which lists all current deprecation targets and wi * **OCP\\Util::linkToRoute** has been deprecated in favour of **\\OCP\\IURLGenerator::linkToRoute** * **OCP\\Util::linkTo** has been deprecated in favour of **\\OCP\\IURLGenerator::linkTo** * **OCP\\Util::imagePath** has been deprecated in favour of **\\OCP\\IURLGenerator::imagePath** - * **OCP\\Util::isValidPath** has been deprecated in favour of **\\OCP\\IURLGenerator::imagePath** + * **OCP\\Util::isValidPath** has been deprecated in favour of **\\OCP\\IURLGenerator::imagePath** + +* `OCP\\AppFramework\\IAppContainer `_: methods **getCoreApi** and **log** +* `OCP\\AppFramework\\IApi `_: full class + -10.0 +2017 ---- * **OCP\\IDb**: This interface and the implementing classes will be removed in favor of **OCP\\IDbConnection**. Various layers in between have also been removed to be consistent with the PDO classes. This leads to the following changes: @@ -76,8 +51,8 @@ This is a deprecation roadmap which lists all current deprecation targets and wi * The **__construct** method of **OCP\\AppFramework\\Db\\Mapper** no longer requires an instance of **OCP\\IDb** but an instance of **OCP\\IDbConnection** * The **execute** method on **OCP\\AppFramework\\Db\\Mapper** no longer returns an instance of **OC_DB_StatementWrapper** but an instance of **PDOStatement** -9.0 ---- +2016 +---- * The following methods have been moved into the **OCP\\Template::** class instead of being namespaced directly: * **OCP\\image_path** @@ -91,13 +66,8 @@ This is a deprecation roadmap which lists all current deprecation targets and wi * **OCP\\simple_file_size** has been deprecated in favour of **OCP\\Template::human_file_size** * The **OCP\\PERMISSION_** and **OCP\\FILENAME_INVALID_CHARS** have been moved to **OCP\\Constants::** * The **OC_GROUP_BACKEND_** and **OC_USER_BACKEND_** have been moved to **OC_Group_Backend::** and **OC_User_Backend::** respectively +* `OCP\\AppFramework\\Controller `_: methods **params**, **getParams**, **method**, **getUploadedFile**, **env**, **cookie**, **render** -8.3 ---- -* `OCP\\AppFramework\\IApi `_: full class -* `OCP\\AppFramework\\IAppContainer `_: methods **getCoreApi** and **log** -* `OCP\\AppFramework\\Controller `_: methods **params**, **getParams**, **method**, **getUploadedFile**, **env**, **cookie**, **render** - -8.1 ---- -* `\\OC\\Preferences `_ and `\\OC_Preferences `_ +2015 +---- +* `\\OC\\Preferences `_ and `\\OC_Preferences `_ diff --git a/developer_manual/app/classloader.rst b/developer_manual/app/classloader.rst index 07d941481b4..ce4e9f112c6 100644 --- a/developer_manual/app/classloader.rst +++ b/developer_manual/app/classloader.rst @@ -4,14 +4,14 @@ Classloader .. sectionauthor:: Bernhard Posselt -The classloader is provided by ownCloud and loads all your classes automatically. The only thing left to include by yourself are 3rdparty libraries. Those should be loaded in :file:`lib/AppInfo/Application.php`. +The classloader is provided by Nextcloud and loads all your classes automatically. The only thing left to include by yourself are 3rdparty libraries. Those should be loaded in :file:`lib/AppInfo/Application.php`. -.. versionadded:: 9.1 +.. versionadded:: 10 PSR-4 Autoloading ----------------- -Since ownCloud 9.1 there is a PSR-4 autoloader in place. The namespace **\\OCA\\MyApp** +Since Nextcloud 10 there is a PSR-4 autoloader in place. The namespace **\\OCA\\MyApp** is mapped to :file:`/apps/myapp/lib/`. Afterwards normal PSR-4 rules apply, so a folder is a namespace section in the same casing and the class name matches the file name. @@ -37,7 +37,7 @@ thereby mapped to :file:`/apps/myapp/tests/`. Legacy Autoloading ------------------ -The legacy classloader, deprecated since 9.1, is still in place and works like this: +The legacy classloader, deprecated since 10, is still in place and works like this: * Take the full qualifier of a class:: diff --git a/developer_manual/app/code_signing.rst b/developer_manual/app/code_signing.rst index 4481638ab86..3d97ea8ad9d 100644 --- a/developer_manual/app/code_signing.rst +++ b/developer_manual/app/code_signing.rst @@ -2,77 +2,77 @@ Code Signing ============ -.. sectionauthor:: Lukas Reschke +.. sectionauthor:: Lukas Reschke -ownCloud supports code signing for the core releases, and for ownCloud -applications. Code signing gives our users an additional layer of security by +Nextcloud supports code signing for the core releases, and for Nextcloud +applications. Code signing gives our users an additional layer of security by ensuring that nobody other than authorized persons can push updates. -It also ensures that all upgrades have been executed properly, so that no files -are left behind, and all old files are properly replaced. In the past, invalid -updates were a significant source of errors when updating ownCloud. +It also ensures that all upgrades have been executed properly, so that no files +are left behind, and all old files are properly replaced. In the past, invalid +updates were a significant source of errors when updating Nextcloud. FAQ --- -Why Did ownCloud Add Code Signing? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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 +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 ownCloud? -^^^^^^^^^^^^^^^^^^^^^^^^^ +Do We Lock Down Nextcloud? +^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ownCloud project is open source and always will be. We do not want to make -it more difficult for our users to run ownCloud. Any code signing errors on -upgrades will not prevent ownCloud from running, but will display a warning on -the Admin page. For applications that are not tagged "Official" the code signing +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 +upgrades will not prevent Nextcloud from running, but will display a warning on +the Admin page. For applications that are not tagged "Official" the code signing process is optional. Not Open Source Anymore? ^^^^^^^^^^^^^^^^^^^^^^^^ -The ownCloud project is open source and always will be. The code signing -process is optional, though highly recommended. The code check for the -core parts of ownCloud is enabled when the ownCloud release version branch has +The Nextcloud project is open source and always will be. The code signing +process is optional, though highly recommended. The code check for the +core parts of Nextcloud is enabled when the Nextcloud release version branch has been set to stable. -For custom distributions of ownCloud it is recommended to change the release +For custom distributions of Nextcloud it is recommended to change the release version branch in version.php to something else than "stable". Is Code Signing Mandatory For Apps? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Code signing is optional for all third-party applications. Applications +Code signing is optional for all third-party applications. Applications with a tag of "Official" on apps.owncloud.com require code signing. Technical details ----------------- -ownCloud uses a X.509 based approach to handle authentication of code. Each -ownCloud release contains the certificate of a shipped ownCloud Code Signing -Root Authority. The private key of this certificate is only accessible to the -project leader, who may grant trusted project members with a copy of this +Nextcloud uses a X.509 based approach to handle authentication of code. Each +Nextcloud release contains the certificate of a shipped Nextcloud Code Signing +Root Authority. The private key of this certificate is only accessible to the +project leader, who may grant trusted project members with a copy of this private key. -This Root Authority is only used for signing certificate signing requests (CSRs) -for additional certificates. Certificates issued by the Root Authority must -always to be limited to a specific scope, usually the application identifier. +This Root Authority is only used for signing certificate signing requests (CSRs) +for additional certificates. Certificates issued by the Root Authority must +always to be limited to a specific scope, usually the application identifier. This enforcement is done using the ``CN`` attribute of the certificate. -Code signing is then done by creating a ``signature.json`` file with the +Code signing is then done by creating a ``signature.json`` file with the following content: .. code-block:: json { "hashes": { - "/filename.php": + "/filename.php": "2401fed2eea6f2c1027c482a633e8e25cd46701f811e2d2c10dc213fd95fa60e350b ccbbebdccc73a042b1a2799f673fbabadc783284cc288e4f1a1eacb74e3d", - "/lib/base.php": + "/lib/base.php": "55548cc16b457cd74241990cc9d3b72b6335f2e5f45eee95171da024087d114fcbc2 effc3d5818a6d5d55f2ae960ab39fd0414d0c542b72a3b9e08eb21206dd9" }, @@ -82,92 +82,92 @@ following content: nNDEzMTcxMFoXDTE2MTAxNDEzMTcxMFowEzERMA8GA1UEAwwIY29udGFjdHMwgZ8w\ nDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANoQesGdCW0L2L+a2xITYipixkScrIpB\ nkX5Snu3fs45MscDb61xByjBSlFgR4QI6McoCipPw4SUr28EaExVvgPSvqUjYLGps\ - nfiv0Cvgquzbx/X3mUcdk9LcFo1uWGtrTfkuXSKX41PnJGTr6RQWGIBd1V52q1qbC\ - nJKkfzyeMeuQfAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAvF/KIhRMQ3tYTmgHWsiM\ - nwDMgIDb7iaHF0fS+/Nvo4PzoTO/trev6tMyjLbJ7hgdCpz/1sNzE11Cibf6V6dsz\ + nfiv0Cvgquzbx/X3mUcdk9LcFo1uWGtrTfkuXSKX41PnJGTr6RQWGIBd1V52q1qbC\ + nJKkfzyeMeuQfAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAvF/KIhRMQ3tYTmgHWsiM\ + nwDMgIDb7iaHF0fS+/Nvo4PzoTO/trev6tMyjLbJ7hgdCpz/1sNzE11Cibf6V6dsz\ njCE9invP368Xv0bTRObRqeSNsGogGl5ceAvR0c9BG+NRIKHcly3At3gLkS2791bC\ niG+UxI/MNcWV0uJg9S63LF8=\n -----END CERTIFICATE-----", "signature": "U29tZVNpZ25lZERhdGFFeGFtcGxl" } -``hashes`` is an array of all files in the folder with their corresponding -SHA-512 hashes. ``certificate`` is the certificate used for signing. It has to -be issued by the ownCloud Root Authority, and its CN needs to be permitted to -perform the required action. The ``signature`` is then a signature of the hashes +``hashes`` is an array of all files in the folder with their corresponding +SHA-512 hashes. ``certificate`` is the certificate used for signing. It has to +be issued by the Nextcloud Root Authority, and its CN needs to be permitted to +perform the required action. The ``signature`` is then a signature of the hashes which can be verified using the certificate. -Having the certificate bundled within the ``signature.json`` file has the -advantage that even if a developer loses their certificate, future updates can +Having the certificate bundled within the ``signature.json`` file has the +advantage that even if a developer loses their certificate, future updates can 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 - ownCloud 9.0. Unsigned ``official`` apps won't be installable anymore. -- Apps which have been signed in a previous release **MUST** be code-signed in +- 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. How to Get Your App Signed -------------------------- -The following commands require that you have OpenSSL installed on your machine. -Ensure that you keep all generated files to sign your application. The following -examples will assume that you are trying to sign an application named +The following commands require that you have OpenSSL installed on your machine. +Ensure that you keep all generated files to sign your application. The following +examples will assume that you are trying to sign an application named "contacts". 1. Generate a private key and CSR: ``openssl req -nodes -newkey rsa:2048 -keyout contacts.key -out contacts.csr -subj "/CN=contacts"``. Replace "contacts" with your application identifier. -2. Post the CSR at https://github.com/owncloud/appstore-issues, and configure - your GitHub account to show your mail address in your profile. ownCloud - might ask you for further information to verify that you're the legitimate +2. Post the CSR at https://github.com/owncloud/appstore-issues, and configure + your GitHub account to show your mail address in your profile. Nextcloud + might ask you for further information to verify that you're the legitimate owner of the application. Make sure to keep the private key file (``contacts.key``) secret and not disclose it to any third-parties. -3. ownCloud will provide you with the signed certificate. -4. Run ``./occ integrity:sign-app`` to sign your application, and specify - your private and the public key as well as the path to the application. - A valid example looks like: ``./occ integrity:sign-app --privateKey=/Users/lukasreschke/contacts.key +3. Nextcloud will provide you with the signed certificate. +4. Run ``./occ integrity:sign-app`` to sign your application, and specify + your private and the public key as well as the path to the application. + A valid example looks like: ``./occ integrity:sign-app --privateKey=/Users/lukasreschke/contacts.key --certificate=/Users/lukasreschke/CA/contacts.crt --path=/Users/lukasreschke/Programming/contacts`` -The occ tool will store a ``signature.json`` file within the ``appinfo`` folder -of your application. Then compress the application folder and upload it to -apps.owncloud.com. Be aware that doing any changes to the application after it -has been signed requires another signing. So if you do not want to have some +The occ tool will store a ``signature.json`` file within the ``appinfo`` folder +of your application. Then compress the application folder and upload it to +apps.owncloud.com. Be aware that doing any changes to the application after it +has been signed requires another signing. So if you do not want to have some files shipped remove them before running the signing command. -In case you lose your certificate please submit a new CSR as described above and -mention that you have lost the previous one. ownCloud will revoke the old +In case you lose your certificate please submit a new CSR as described above and +mention that you have lost the previous one. Nextcloud will revoke the old certificate. If you maintain an app together with multiple people it is recommended to designate a release manager responsible for the signing process as well -as the uploading to apps.owncloud.com. If there are cases where this is not -feasible and multiple certificates are required ownCloud can create them on a +as the uploading to apps.owncloud.com. If there are cases where this is not +feasible and multiple certificates are required Nextcloud can create them on a case by case basis. We do not recommend developers to share their private key. Errors ------ -The following errors can be encountered when trying to verify a code signature. -For information about how to get access to those results please refer to the -Issues section of the ownCloud Server Administration +The following errors can be encountered when trying to verify a code signature. +For information about how to get access to those results please refer to the +Issues section of the Nextcloud Server Administration manual. - ``INVALID_HASH`` - The file has a different hash than specified within ``signature.json``. This - usually happens when the file has been modified after writing the signature + usually happens when the file has been modified after writing the signature data. - ``MISSING_FILE`` - - The file cannot be found but has been specified within ``signature.json``. - Either a required file has been left out, or ``signature.json`` needs to be + - The file cannot be found but has been specified within ``signature.json``. + Either a required file has been left out, or ``signature.json`` needs to be edited. - ``EXTRA_FILE`` - - The file does not exist in ``signature.json``. This usually happens when a + - The file does not exist in ``signature.json``. This usually happens when a file has been removed and ``signature.json`` has not been updated. - ``EXCEPTION`` @@ -177,22 +177,21 @@ manual. - ``Signature data not found.``` - - The app has mandatory code signing enforced but no ``signature.json`` + - The app has mandatory code signing enforced but no ``signature.json`` file has been found in its ``appinfo`` folder. - ``Certificate is not valid.`` - - The certificate has not been issued by the official ownCloud Code + - The certificate has not been issued by the official Nextcloud Code Signing Root Authority. - - ``Certificate is not valid for required scope. (Requested: %s, current: + - ``Certificate is not valid for required scope. (Requested: %s, current: %s)`` - - The certificate is not valid for the defined application. Certificates - are only valid for the defined app identifier and cannot be used for + - The certificate is not valid for the defined application. Certificates + are only valid for the defined app identifier and cannot be used for others. - ``Signature could not get verified.`` - There was a problem with verifying the signature of ``signature.json``. - diff --git a/developer_manual/app/container.rst b/developer_manual/app/container.rst index 93bcb8568c0..2ea068a2db3 100644 --- a/developer_manual/app/container.rst +++ b/developer_manual/app/container.rst @@ -153,9 +153,8 @@ So basically the container is used as a giant factory to build all the classes t Use automatic dependency assembly (recommended) =============================================== -.. versionadded:: 8 -Since ownCloud 8 it is possible to omit the **lib/AppInfo/Application.php** and use automatic dependency assembly instead. +In Nextcloud it is possible to omit the **lib/AppInfo/Application.php** and use automatic dependency assembly instead. How does automatic assembly work -------------------------------- @@ -280,7 +279,7 @@ The following parameter names and type hints can be used to inject core services Parameters: * **AppName**: The app id -* **WebRoot**: The path to the ownCloud installation +* **WebRoot**: The path to the Nextcloud installation * **UserId**: The id of the current user Types: diff --git a/developer_manual/app/controllers.rst b/developer_manual/app/controllers.rst index afb371267d7..3872ca1ac8b 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 @@ -462,7 +460,7 @@ A :doc:`template ` can be rendered by returning a TemplateResponse. A $_['key'] -* **renderAs**: defaults to *user*, tells ownCloud if it should include it in the web interface, or in case *blank* is passed solely render the template +* **renderAs**: defaults to *user*, tells Nextcloud if it should include it in the web interface, or in case *blank* is passed solely render the template .. 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,9 +599,8 @@ If you want to use a custom, lazily rendered response simply implement the inter Modifying the Content Security Policy ------------------------------------- -.. versionadded:: 8.1 -By default ownCloud 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. +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. .. note:: Double check your content and edge cases before you relax the policy! Also read the `documentation provided by MDN `_ @@ -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/css.rst b/developer_manual/app/css.rst index ab262b6c236..998a3e16e00 100644 --- a/developer_manual/app/css.rst +++ b/developer_manual/app/css.rst @@ -51,7 +51,7 @@ For built in mobile support your content has to be wrapped inside another div wi Navigation ========== -ownCloud provides a default CSS navigation layout. If list entries should have 16x16 px icons, the **with-icon** class can be added to the base **ul**. The maximum supported indention level is two, further indentions are not recommended. +Nextcloud provides a default CSS navigation layout. If list entries should have 16x16 px icons, the **with-icon** class can be added to the base **ul**. The maximum supported indention level is two, further indentions are not recommended. .. code-block:: html diff --git a/developer_manual/app/filesystem.rst b/developer_manual/app/filesystem.rst index 0b4c9e23c15..cec2c6138f7 100644 --- a/developer_manual/app/filesystem.rst +++ b/developer_manual/app/filesystem.rst @@ -42,7 +42,7 @@ Filesystem classes can be injected from the ServerContainer by calling the metho Writing to a file ================= -All methods return a Folder object on which files and folders can be accessed, or filesystem operations can be performed relatively to their root. For instance for writing to file:`owncloud/data/myfile.txt` you should get the root folder and use: +All methods return a Folder object on which files and folders can be accessed, or filesystem operations can be performed relatively to their root. For instance for writing to file:`nextcloud/data/myfile.txt` you should get the root folder and use: .. code-block:: php @@ -67,9 +67,9 @@ All methods return a Folder object on which files and folders can be accessed, o $file = $this->storage->get('/myfile.txt'); } - // the id can be accessed by $file->getId(); + // the id can be accessed by $file->getId(); $file->putContent($content); - + } catch(\OCP\Files\NotPermittedException $e) { // you have to create this exception by yourself ;) throw new StorageException('Cant write to file'); diff --git a/developer_manual/app/index.rst b/developer_manual/app/index.rst index 92af52765c0..b7cad020c23 100644 --- a/developer_manual/app/index.rst +++ b/developer_manual/app/index.rst @@ -23,6 +23,7 @@ js css l10n + theming schema database configuration @@ -44,7 +45,7 @@ App Development Intro ===== -Before you start, please check if there already is a similar app in the `App Store `_, or an official `ownCloud app `_ (see Apps Repo and Other app repos) that you could contribute to. Also, feel free to communicate your idea and plans to the `user mailing list `_ or `developer mailing list `_ so other contributors might join in. +Before you start, please check if there already is a similar app in the `App Store `_ or the `GitHub organisation `_ that you could contribute to. Also, feel free to communicate your idea and plans in the `forum `_ so other contributors might join in. Then, please make sure you have set up a development environment: @@ -101,6 +102,7 @@ The app's presentation layer: * :doc:`js` * :doc:`css` * :doc:`l10n` +* :doc:`theming` Storage ------- @@ -135,7 +137,7 @@ Periodically run code in the background: Logging ------- -Log to the :file:`data/owncloud.log`: +Log to the :file:`data/nextcloud.log`: * :doc:`logging` @@ -147,6 +149,6 @@ Write automated tests to ensure stability and ease maintenance: PHPDoc Class Documentation -------------------------- -ownCloud class and function documentation: +Nextcloud class and function documentation: -* `ownCloud App API `_ +* `Nextcloud App API `_ diff --git a/developer_manual/app/info.rst b/developer_manual/app/info.rst index f41e2255cad..3769c4f3fdd 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 @@ -25,18 +24,18 @@ The :file:`appinfo/info.xml` contains metadata about the app: - https://doc.owncloud.org - https://doc.owncloud.org - https://doc.owncloud.org + https://docs.nextcloud.org + https://docs.nextcloud.org + https://docs.nextcloud.org tool - https://owncloud.org + https://example.org - https://github.com/owncloud/theapp/issues + https://github.com/nextcloud/theapp/issues - https://github.com/owncloud/theapp.git + https://github.com/nextcloud/theapp.git 1234 @@ -54,6 +53,7 @@ The :file:`appinfo/info.xml` contains metadata about the app: + 5 appinfo/caldav.php @@ -71,7 +71,7 @@ The :file:`appinfo/info.xml` contains metadata about the app: id -- -**Required**: This field contains the internal app name, and has to be the same as the folder name of the app. This id needs to be unique in ownCloud, meaning no other app should have this id. +**Required**: This field contains the internal app name, and has to be the same as the folder name of the app. This id needs to be unique in Nextcloud, meaning no other app should have this id. name ---- @@ -92,23 +92,17 @@ licence * AGPL 3 (recommended) * MIT -If a proprietary/non AGPL compatible licence should be used, the `ownCloud Enterprise Edition `_ must be used. - author ------ **Required**: The name of the app author or authors. -requiremin ----------- -Required if not added in the **** tag. The minimal version of ownCloud. - 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** types ----- -ownCloud allows to specify four kind of ``types``. Currently supported ``types``: +Nextcloud allows to specify four kind of ``types``. Currently supported ``types``: * **prelogin**: apps which need to load on the login page @@ -119,7 +113,6 @@ ownCloud 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 ownCloud 9.0, can also be used in earlier versions, but the functionality is ignored. .. note:: @@ -177,7 +170,7 @@ specified. Valid values for the 'os' attribute are as returned by the php functi lib === Defines a required php extension with required minimum and/or maximum version. The names for the libraries have to match the result as returned by the php function `get_loaded_extensions `_. -The explicit version of an extension is read from `phpversion `_ - with some exception as to be read up in the `code base `_ +The explicit version of an extension is read from `phpversion `_ - with some exception as to be read up in the `code base `_ os == @@ -185,7 +178,14 @@ Defines the required target operating system the app can run on. Valid values ar owncloud ======== -Defines minimum and maximum versions of the ownCloud 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`_. + +.. note:: Currently this tag is also used to check for the nextcloud version number. + Thereby the following "translation" is made: + + * ownCloud 9.0 matches Nextcloud 9 + * ownCloud 9.1 matches Nextcloud 10 + * ownCloud 9.2 matches Nextcloud 11 Deprecated @@ -193,22 +193,23 @@ Deprecated The following sections are just listed for reference and should not be used because -* **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 **/owncloud/index.php/public**. Example with id set to 'calendar':: +Used to provide a public interface (requires no login) for the app. The id is appended to the URL **/index.php/public**. Example with id set to 'calendar':: - /owncloud/index.php/public/calendar + /index.php/public/calendar Also take a look at :doc:`../core/externalapi`. remote ====== -Same as public but requires login. The id is appended to the URL **/owncloud/index.php/remote**. Example with id set to 'calendar':: +Same as public but requires login. The id is appended to the URL **/index.php/remote**. Example with id set to 'calendar':: - /owncloud/index.php/remote/calendar + /index.php/remote/calendar Also take a look at :doc:`../core/externalapi`. @@ -219,10 +220,10 @@ Can be set to true to indicate that this app is a webapp. This can be used to te default_enable ============== -**Core apps only**: Used to tell ownCloud to enable them after the installation. +**Core apps only**: Used to tell Nextcloud to enable them after the installation. shipped ======= -**Core apps only**: Used to tell ownCloud that the app is in the standard release. +**Core apps only**: Used to tell Nextcloud that the app is in the standard release. Please note that if this attribute is set to *FALSE* or not set at all, every time you disable the application, all the files of the application itself will be *REMOVED* from the server! diff --git a/developer_manual/app/init.rst b/developer_manual/app/init.rst index 5aa544d6ff5..e414aab5e3a 100644 --- a/developer_manual/app/init.rst +++ b/developer_manual/app/init.rst @@ -4,7 +4,7 @@ Navigation and Pre-App configuration .. sectionauthor:: Bernhard Posselt -The :file:`appinfo/app.php` is the first file that is loaded and executed in ownCloud. Depending on the purpose of the app it usually just contains the navigation setup, and maybe :doc:`backgroundjobs` and :doc:`hooks` registrations. This is how an example :file:`appinfo/app.php` could look like: +The :file:`appinfo/app.php` is the first file that is loaded and executed in Nextcloud. Depending on the purpose of the app it usually just contains the navigation setup, and maybe :doc:`backgroundjobs` and :doc:`hooks` registrations. This is how an example :file:`appinfo/app.php` could look like: .. code-block:: php @@ -13,7 +13,7 @@ The :file:`appinfo/app.php` is the first file that is loaded and executed in own \OC::$server->getNavigationManager()->add(function () { $urlGenerator = \OC::$server->getURLGenerator(); return [ - // the string under which your app will be referenced in owncloud + // the string under which your app will be referenced in nextcloud 'id' => 'myapp', // sorting weight for the navigation. The higher the number, the higher @@ -43,7 +43,7 @@ The :file:`appinfo/app.php` is the first file that is loaded and executed in own Although it is also possible to include :doc:`js` or :doc:`css` for other apps by placing the **addScript** or **addStyle** functions inside this file, it is strongly discouraged, because the file is loaded on each request (also such requests that do not return HTML, but e.g. json or webdav). .. code-block:: php - + -ownCloud's translation system is powered by `Transifex `_. To start translating sign up and enter a group. If your community app should be added to Transifex contact one of the `core developers `_ to set it up for you. +Nextcloud's translation system is powered by `Transifex `_. To start translating sign up and enter a group. If your community app should be added to Transifex contact one of the translation team `in the forums `_ to set it up for you. PHP === @@ -115,7 +115,7 @@ In case some translation strings may be translated wrongly because they have mul
  • t('Add new file')); + p($l->t('Add new file')); ?>
    • @@ -128,7 +128,7 @@ generate the gettext strings by yourself by creating an :file:`l10n/` directory in the app folder and executing:: - cd /srv/http/owncloud/apps/myapp/l10n + cd /srv/http/nextcloud/apps/myapp/l10n perl l10n.pl read myapp The translation script requires **Locale::PO** and **gettext**, installable via:: diff --git a/developer_manual/app/publishing.rst b/developer_manual/app/publishing.rst index b368c2897e6..dd9b29154b5 100644 --- a/developer_manual/app/publishing.rst +++ b/developer_manual/app/publishing.rst @@ -4,9 +4,9 @@ App store publishing .. sectionauthor:: Jos Poortvliet -The ownCloud App Store ----------------------- -The ownCloud app store is build into ownCloud 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: +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 * transparent @@ -24,16 +24,16 @@ With each level come requirements and a position in the store. Official ^^^^^^^^ -Official apps are developed by and within the ownCloud community and its `Github `_ repository and offer functionality central to ownCloud. They are ready for serious use and can be considered a part of ownCloud. +Official apps are developed by and within the Nextcloud community and its `Github `_ repository and offer functionality central to Nextcloud. They are ready for serious use and can be considered a part of Nextcloud. Requirements: -* developed in ownCloud github repo +* developed in Nextcloud github repo * minimum of 2 active maintainers and contributions from others * security audited and design reviewed * app is at least 6 months old and has seen regular releases * follows app guidelines -* supports the same platforms and technologies mentioned in the release notes of the ownCloud version this app is made for +* supports the same platforms and technologies mentioned in the release notes of the Nextcloud version this app is made for .. * app is signed, identity verified @@ -41,8 +41,8 @@ App store: * available in Apps page in separate category * sorted first in all overviews, 'Official' tag -* shown as featured, on owncloud.org etc -* major releases optionally featured on owncloud.org and sent to owncloud-announce list +* shown as featured, on nextcloud.com etc +* major releases optionally featured on nextcloud.com * new versions/updates approved by at least one other person note: @@ -97,9 +97,9 @@ App store: Getting an app approved ----------------------- -If you want your app to be approved, make sure you fulfill all the requirements and then create an issue in the `app approval github repository `_ using `this template `_. A team of ownCloud contributors will review your application. Updates to an app require re-review but, of course, an initial review takes more effort and time than the checking of an update. +If you want your app to be approved, make sure you fulfill all the requirements and then create an issue in the `app approval github repository `_ using `this template `_. A team of Nextcloud contributors will review your application. Updates to an app require re-review but, of course, an initial review takes more effort and time than the checking of an update. -You are encouraged to help review other contributors' apps as well! Every app requires at least two independent reviews so your review of at least 2 (more is better!) other apps will ensure the process continues smoothly. Thank you for participating in this process and being a great ownCloud Community member! +You are encouraged to help review other contributors' apps as well! Every app requires at least two independent reviews so your review of at least 2 (more is better!) other apps will ensure the process continues smoothly. Thank you for participating in this process and being a great Nextcloud Community member! Using the code checker ^^^^^^^^^^^^^^^^^^^^^^ @@ -124,22 +124,22 @@ These are the app guidelines an app has to comply with to have a chance to be ap Legal and security ^^^^^^^^^^^^^^^^^^ -* Apps can not use 'ownCloud' in their name +* Apps can not use 'Nextcloud' in their name * Irregular and unannounced security audits of all apps can and will take place. -* If any indication of malicious intent or bad faith is found the developer(s) in question can count on a minimum 2 year ban from any ownCloud infrastructure. - * Malicious intent includes deliberate spying on users by leaking user data to a third party system or adding a back door (like a hard-coded user account) to ownCloud. An unintentional security bug that gets fixed in time won't be considered bad faith. +* If any indication of malicious intent or bad faith is found the developer(s) in question can count on a minimum 2 year ban from any Nextcloud infrastructure. + * Malicious intent includes deliberate spying on users by leaking user data to a third party system or adding a back door (like a hard-coded user account) to Nextcloud. An unintentional security bug that gets fixed in time won't be considered bad faith. * Apps do not violate any laws; it has to comply with copyright- and trademark law. -* App authors have to respond timely to security concerns and not make ownCloud more vulnerable to attack. +* App authors have to respond timely to security concerns and not make Nextcloud more vulnerable to attack. -.. note:: distributing malicious or illegal applications can have legal consequences including, but not limited to ownCloud or affected users taking legal action. +.. note:: distributing malicious or illegal applications can have legal consequences including, but not limited to Nextcloud or affected users taking legal action. Be technically sound ^^^^^^^^^^^^^^^^^^^^ -* Apps can only use the public ownCloud API -* At time of the release of an app it can only be configured to be compatible with the latest ownCloud release +1 -* Apps should not cause ownCloud to break, consume excessive memory or slow ownCloud down -* Apps should not hamper functionality of ownCloud unless that is explicitly the goal of the app +* Apps can only use the public Nextcloud API +* At time of the release of an app it can only be configured to be compatible with the latest Nextcloud release +1 +* Apps should not cause Nextcloud to break, consume excessive memory or slow Nextcloud down +* Apps should not hamper functionality of Nextcloud unless that is explicitly the goal of the app Respect the users ^^^^^^^^^^^^^^^^^ diff --git a/developer_manual/app/request.rst b/developer_manual/app/request.rst index 142dcf7306e..445f3932e0e 100644 --- a/developer_manual/app/request.rst +++ b/developer_manual/app/request.rst @@ -11,11 +11,11 @@ A typical HTTP request consists of the following: * **A Method**: e.g. GET * **Request headers**: e.g. Accept: application/json -The following sections will present an overview over how that request is being processed to provide an in depth view over how ownCloud works. If you are not interested in the internals or don't want to execute anything before and after your controller, feel free to skip this section and continue directly with defining :doc:`your app's routes `. +The following sections will present an overview over how that request is being processed to provide an in depth view over how Nextcloud works. If you are not interested in the internals or don't want to execute anything before and after your controller, feel free to skip this section and continue directly with defining :doc:`your app's routes `. Front controller ================ -In the beginning, all requests are sent to ownCloud's :file:`index.php` which in turn executes :file:`lib/base.php`. This file inspects the HTTP headers and abstracts away differences between different Web servers and initializes the basic classes. Afterwards the basic apps are being loaded in the following order: +In the beginning, all requests are sent to Nextcloud's :file:`index.php` which in turn executes :file:`lib/base.php`. This file inspects the HTTP headers and abstracts away differences between different Web servers and initializes the basic classes. Afterwards the basic apps are being loaded in the following order: * Authentication backends * Filesystem diff --git a/developer_manual/app/schema.rst b/developer_manual/app/schema.rst index f6147061453..09b97d6dce0 100644 --- a/developer_manual/app/schema.rst +++ b/developer_manual/app/schema.rst @@ -4,7 +4,7 @@ Database Schema .. sectionauthor:: Bernhard Posselt -ownCloud uses a database abstraction layer on top of either PDO, depending on the availability of PDO on the server. +Nextcloud uses a database abstraction layer on top of either PDO, depending on the availability of PDO on the server. The database schema is inside :file:`appinfo/database.xml` in MDB2's `XML scheme notation `_ where the placeholders \*dbprefix* (\*PREFIX* in your SQL) and \*dbname* can be used for the configured database table prefix and database name. diff --git a/developer_manual/app/startapp.rst b/developer_manual/app/startapp.rst index 35b56ed0cc4..0f36a7009ba 100644 --- a/developer_manual/app/startapp.rst +++ b/developer_manual/app/startapp.rst @@ -4,21 +4,21 @@ Create an app .. sectionauthor:: Bernhard Posselt -After :doc:`you've set up the development environment and installed the dev tool <../general/devenv>` change into the ownCloud apps directory:: +After :doc:`you've set up the development environment and installed the dev tool <../general/devenv>` change into the Nextcloud apps directory:: - cd /var/www/owncloud/apps + cd /var/www/nextcloud/apps Then run:: - ocdev startapp MyApp --email mail@example.com --author "Your Name" --description "My first app" --owncloud 8 + ncdev startapp MyApp --email mail@example.com --author "Your Name" --description "My first app" --owncloud 8 -This will create all the needed files in the current directory. For more information on how to customize the generated app, see the `Project's GitHub page `_ or run:: +This will create all the needed files in the current directory. For more information on how to customize the generated app, see the `Project's GitHub page `_ or run:: - ocdev startapp -h + ncdev startapp -h Enable the app -------------- -The app can now be enabled on the ownCloud apps page +The app can now be enabled on the Nextcloud apps page App architecture ---------------- @@ -31,4 +31,3 @@ The following directories have now been created: * **lib/**: Contains the other class files of your app * **templates/**: Contains the templates * **tests/**: Contains the tests - diff --git a/developer_manual/app/templates.rst b/developer_manual/app/templates.rst index e1f6466d623..2e14b08686c 100644 --- a/developer_manual/app/templates.rst +++ b/developer_manual/app/templates.rst @@ -4,7 +4,7 @@ Templates .. sectionauthor:: Bernhard Posselt -ownCloud provides its own templating system which is basically plain PHP with some additional functions and preset variables. All the parameters which have been passed from the :doc:`controller ` are available in an array called **$_[]**, e.g.:: +Nextcloud provides its own templating system which is basically plain PHP with some additional functions and preset variables. All the parameters which have been passed from the :doc:`controller ` are available in an array called **$_[]**, e.g.:: array('key' => 'something') diff --git a/developer_manual/app/testing.rst b/developer_manual/app/testing.rst index a3f77dbbcae..40a0b57dad9 100644 --- a/developer_manual/app/testing.rst +++ b/developer_manual/app/testing.rst @@ -10,11 +10,11 @@ All PHP classes can be tested with `PHPUnit `_, JavaScript c PHP === -The PHP tests go into the **tests/** directory. Unfortunately the classloader in core requires a running server (as in fully configured and setup up with a database connection). This is unfortunately too complicated and slow so a separate classloader has to be provided. If the app has been generated with the **ocdev startapp** command, the classloader is already present in the the **tests/** directory and PHPUnit can be run with:: +The PHP tests go into the **tests/** directory. Unfortunately the classloader in core requires a running server (as in fully configured and setup up with a database connection). This is unfortunately too complicated and slow so a separate classloader has to be provided. If the app has been generated with the **ncdev startapp** command, the classloader is already present in the the **tests/** directory and PHPUnit can be run with:: phpunit tests/ -When writing your own tests, please ensure that PHPUnit bootstraps from :file:`tests/bootstrap.php`, to set up various environment variables and autoloader registration correctly. Without this, you will see errors as the ownCloud autoloader security policy prevents access to the tests/ subdirectory. This can be configured in your :file:`phpunit.xml` file as follows: +When writing your own tests, please ensure that PHPUnit bootstraps from :file:`tests/bootstrap.php`, to set up various environment variables and autoloader registration correctly. Without this, you will see errors as the Nextcloud autoloader security policy prevents access to the tests/ subdirectory. This can be configured in your :file:`phpunit.xml` file as follows: .. code-block:: xml diff --git a/developer_manual/app/theming.rst b/developer_manual/app/theming.rst new file mode 100644 index 00000000000..575a7ccbc6e --- /dev/null +++ b/developer_manual/app/theming.rst @@ -0,0 +1,35 @@ +=============== +Theming support +=============== + +.. sectionauthor:: Julius Härtl + +The Nextcloud theming app offers some tools for app developers to ensure that apps also match the themed look. + +CSS classes +=========== + +* **.nc-theming-main-background** Background in theming color +* **.nc-theming-main-text** Text in theming color +* **.nc-theming-contrast** Text in white/black color to be shown in front of the theming color + + +JavaScript +========== + +When the theming app is enabled, it provides the **OCA.Theming** object. It can +be used to handle themed instances differently. + +.. code-block:: javascript + if(OCA.Theming) { + $('.myapp-element').animate({backgroundColor:OCA.Theming.color}); + } + +The following information is available: + +* **OCA.Theming.color** Main color +* **OCA.Theming.inverted** Will be true on bright theming colors to get contrast with text +* **OCA.Theming.name** Instance name +* **OCA.Theming.slogan** Instance slogan +* **OCA.Theming.url** Instance web address + diff --git a/developer_manual/app/tutorial.rst b/developer_manual/app/tutorial.rst index 760cff9bf9f..7eeda14a931 100644 --- a/developer_manual/app/tutorial.rst +++ b/developer_manual/app/tutorial.rst @@ -9,13 +9,13 @@ This tutorial will outline how to create a very simple notes app. The finished a Setup ===== -After the `development tool `_ has been installed the :doc:`development environment needs to be set up <../general/devenv>`. This can be done by either `downloading the zip from the website `_ or cloning it directly from GitHub:: +After the `development tool `_ has been installed the :doc:`development environment needs to be set up <../general/devenv>`. This can be done by either `downloading the zip from the website `_ or cloning it directly from GitHub:: - ocdev setup core --dir owncloud --branch $BRANCH + ncdev setup core --dir nextcloud --branch $BRANCH -.. note:: $BRANCH is the desired ownCloud branch (e.g. stable7 for ownCloud 7, stable8 for ownCloud 8, etc) +.. note:: $BRANCH is the desired Nextcloud branch (e.g. stable9 for Nextcloud 9, stable10 for Nextcloud 10, etc) -First you want to enable debug mode to get proper error messages. To do that set ``debug`` to ``true`` in the **owncloud/config/config.php** file:: +First you want to enable debug mode to get proper error messages. To do that set ``debug`` to ``true`` in the **nextcloud/config/config.php** file:: `_ and enable the OwnNotes application on the `apps page `_. +This creates a new folder called **ownnotes**. Now access and set up Nextcloud through the webinterface at `http://localhost:8080 `_ and enable the OwnNotes application on the `apps page `_. The first basic app is now available at `http://localhost:8080/index.php/apps/ownnotes/ `_ @@ -261,7 +261,7 @@ To create the tables in the database, the :doc:`version tag ` in **ownnote ownnotes Own Notes - My first ownCloud app + My first Nextcloud app AGPL Your Name 0.0.2 @@ -339,7 +339,7 @@ Connect Database & Controllers ============================== The mapper which provides the database access is finished and can be passed into the controller. -You can pass in the mapper by adding it as a type hinted parameter. ownCloud will figure out how to :doc:`assemble them by itself `. Additionally we want to know the userId of the currently logged in user. Simply add a **$UserId** parameter to the constructor (case sensitive!). To do that open **ownnotes/lib/Controller/NoteController.php** and change it to the following: +You can pass in the mapper by adding it as a type hinted parameter. Nextcloud will figure out how to :doc:`assemble them by itself `. Additionally we want to know the userId of the currently logged in user. Simply add a **$UserId** parameter to the constructor (case sensitive!). To do that open **ownnotes/lib/Controller/NoteController.php** and change it to the following: .. code-block:: php @@ -665,13 +665,13 @@ Great! Now the only reason that the controller needs to be changed is when reque Writing a test for the controller (recommended) =============================================== -Tests are essential for having happy users and a carefree life. No one wants their users to rant about your app breaking their ownCloud or being buggy. To do that you need to test your app. Since this amounts to a ton of repetitive tasks, we need to automate the tests. +Tests are essential for having happy users and a carefree life. No one wants their users to rant about your app breaking their Nextcloud or being buggy. To do that you need to test your app. Since this amounts to a ton of repetitive tasks, we need to automate the tests. Unit Tests ---------- A unit test is a test that tests a class in isolation. It is very fast and catches most of the bugs, so we want many unit tests. -Because ownCloud uses :doc:`Dependency Injection ` to assemble your app, it is very easy to write unit tests by passing mocks into the constructor. A simple test for the update method can be added by adding this to **ownnotes/tests/Unit/Controller/NoteControllerTest.php**: +Because Nextcloud uses :doc:`Dependency Injection ` to assemble your app, it is very easy to write unit tests by passing mocks into the constructor. A simple test for the update method can be added by adding this to **ownnotes/tests/Unit/Controller/NoteControllerTest.php**: .. code-block:: php @@ -884,7 +884,7 @@ To run the integration tests change into the **ownnotes** directory and run:: Adding a RESTful API (optional) =============================== -A :doc:`RESTful API ` allows other apps such as Android or iPhone apps to access and change your notes. Since syncing is a big core component of ownCloud it is a good idea to add (and document!) your own RESTful API. +A :doc:`RESTful API ` allows other apps such as Android or iPhone apps to access and change your notes. Since syncing is a big core component of Nextcloud it is a good idea to add (and document!) your own RESTful API. Because we put our logic into the **NoteService** class it is very easy to reuse it. The only pieces that need to be changed are the annotations which disable the CSRF check (not needed for a REST call usually) and add support for `CORS `_ so your API can be accessed from other webapps. @@ -1035,7 +1035,7 @@ To create a modern webapp you need to write :doc:`JavaScript`. You can use a Creating a navigation ===================== -The template file **ownnotes/templates/part.navigation.php** contains the navigation. ownCloud defines many handy :doc:`CSS styles ` which we are going to reuse to style the navigation. Adjust the file to contain only the following code: +The template file **ownnotes/templates/part.navigation.php** contains the navigation. Nextcloud defines many handy :doc:`CSS styles ` which we are going to reuse to style the navigation. Adjust the file to contain only the following code: .. note:: **$l->t()** is used to make your strings :doc:`translatable ` and **p()** is used :doc:`to print escaped HTML ` @@ -1336,4 +1336,4 @@ Now the only thing left is to style the textarea in a nicer fashion. To do that height: 44px; } -Congratulations! You've written your first ownCloud app. You can now either try to further improve the tutorial notes app or start writing your own app. +Congratulations! You've written your first Nextcloud app. You can now either try to further improve the tutorial notes app or start writing your own app. diff --git a/developer_manual/app/two-factor-provider.rst b/developer_manual/app/two-factor-provider.rst index 30add534483..a9ebc4f7506 100644 --- a/developer_manual/app/two-factor-provider.rst +++ b/developer_manual/app/two-factor-provider.rst @@ -4,7 +4,7 @@ Two-factor Providers .. sectionauthor:: Christoph Wurst -Two-factor auth providers apps are used to plug custom second factors into the ownCloud core. The following +Two-factor auth providers apps are used to plug custom second factors into the Nextcloud core. The following code was taken from the `two-factor test app`_. .. _`two-factor test app`: https://github.com/ChristophWurst/twofactor_test @@ -95,7 +95,7 @@ example below shows a minimalistic example of such a provider. Registering a two-factor auth provider ====================================== -You need to inform the ownCloud core that the app provides two-factor auth functionality. Two-factor +You need to inform the Nextcloud core that the app provides two-factor auth functionality. Two-factor providers are registered via ``info.xml``. .. code-block:: XML diff --git a/developer_manual/bugtracker/codereviews.rst b/developer_manual/bugtracker/codereviews.rst index 8301d949089..5df3d68d6eb 100644 --- a/developer_manual/bugtracker/codereviews.rst +++ b/developer_manual/bugtracker/codereviews.rst @@ -8,7 +8,7 @@ Code Reviews on GitHub Introduction ------------ -In order to increase the code quality within ownCloud, developers are requested +In order to increase the code quality within Nextcloud, developers are requested to perform code reviews. As we are now heavily using the GitHub platform these code review shall take place on GitHub as well. @@ -42,7 +42,7 @@ How will it work? Examples -------- Read our `coding guidelines`_ for information on what a good pull request and -good ownCloud code looks like. +good Nextcloud code looks like. These are two examples that are considered to be good examples of how pull requests should be handled @@ -53,10 +53,9 @@ requests should be handled Questions? ---------- -Feel free to drop a line on the `mailing list`_ or join us on `IRC`_. +Feel free to drop a line on the `forums`_ or join us on `IRC`_. -.. _core repository: https://GitHub.com/owncloud/core -.. _continuous integration server: https://ci.owncloud.org/ -.. _mailing list: https://mailman.owncloud.org/mailman/listinfo/devel -.. _IRC: http://webchat.freenode.net/?channels=owncloud-dev +.. _continuous integration server: https://drone.weasel.rocks/ +.. _forums: https://help.nextcloud.com/ +.. _IRC: http://webchat.freenode.net/?channels=nextcloud-dev .. _coding guidelines: ../general/codingguidelines diff --git a/developer_manual/bugtracker/index.rst b/developer_manual/bugtracker/index.rst index 38bb81c02cf..7ea173a42f6 100644 --- a/developer_manual/bugtracker/index.rst +++ b/developer_manual/bugtracker/index.rst @@ -10,23 +10,17 @@ Bugtracker kanban triaging -Thank you for helping ownCloud by reporting bugs. Before submitting an issue, please read +Thank you for helping Nextcloud by reporting bugs. Before submitting an issue, please read `Issue submission guidelines`_ first. -* If the issue is with the ownCloud server, report it to the `Core repository`_ -* If the issue is with the ownCloud client, report it to the `Client repository`_ -* If the issue with with an ownCloud app, report it to where that app is developed -* If the app is listed in our `main github repository`_ report it to the correct sub +* If the issue is with the Nextcloud server, report it to the `Server repository`_ +* If the issue is with the Nextcloud client, report it to the `Client repository`_ +* If the issue with with an Nextcloud app, report it to where that app is developed +* If the app is listed in our `main GitHub organization`_ report it to the correct sub repository -* If the app is listed in the `apps repository`_ report it there -Please note that the mailing list should not be used for bug reports, as it is hard to track them there. - - - -.. _Issue submission guidelines: https://github.com/owncloud/core/blob/master/CONTRIBUTING.md#submitting-issues -.. _Core repository: https://github.com/owncloud/core/issues -.. _Client repository: https://github.com/owncloud/client/issues -.. _main github repository: https://github.com/owncloud -.. _apps repository: https://github.com/owncloud/apps/issues +.. _Issue submission guidelines: https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md#submitting-issues +.. _Server repository: https://github.com/nextcloud/server/issues +.. _Client repository: https://github.com/nextcloud/client/issues +.. _main GitHub organization: https://github.com/nextcloud diff --git a/developer_manual/bugtracker/kanban.rst b/developer_manual/bugtracker/kanban.rst index bf6402f814d..b9041a5b0fb 100644 --- a/developer_manual/bugtracker/kanban.rst +++ b/developer_manual/bugtracker/kanban.rst @@ -1,26 +1,11 @@ -Kanban Board -============ +Development process +=================== This chapter contains a lot of information about the development process the -ownCloud community tries to follow, so please take your time to digest all the +Nextcloud community tries to follow, so please take your time to digest all the information. In any case remember this page as the documentation on how it should be done. Nothing here is set in stone, so if you think something should -be changed please discuss it on the `mailing list`_. - -Kanban Board = github issues + huboard --------------------------------------- - -We are using http://huboard.com to visualize ownCloud github issues as a `kanban -board`_ (see: `core`_, `apps`_, `client`_): - -.. figure:: ../images/kanbanexample.png - :scale: 70 - -As you may have noticed, the columns of the kanban board represent the -life-cycle of an issue (be it a Bug or an Enhancement). An issue flows from the -1 - Backlog on the left to the 7 - To release column on the right and is not -closed until it has been released. Instead we pull an issue to the next column -by changing the label. +be changed please discuss it on the `forums`_. The Labels ---------- @@ -140,7 +125,7 @@ Why do we have it? What does a developer think? "I’ll check the Scenario described earlier works as expected. If necessary - I’ll update the related Gherkin Scenarios. `Jenkins`_ will test the scenario + I’ll update the related Gherkin Scenarios. `Drone`_ will test the scenario on all kinds of platforms, Web server and database combinations with `cucumber`_." @@ -158,14 +143,14 @@ Reviewing Why do we have it? With the Gherkin Scenario from the Concept Phase reviewers have a checklist to test if a Bug has been solved and if an Enhancement works as expected. **The - most eager reviewer we have is Jenkins**. When it comes to testing he soldiers + most eager reviewer we have is Drone**. When it comes to testing he soldiers on going through the different combinations of platform, Web server and database. What does a developer think? "Damn! If I had written the Gherkin Scenarios and Cucumber Step Definitions I could leave the task of testing this on the different combinations of platform, - Web server and database to Jenkins. I’ll miss something when doing this + Web server and database to Drone. I’ll miss something when doing this manually.* When can I pull? @@ -187,7 +172,7 @@ Why do we have it? What does a developer think? "Look at all the shiny things we will release with the next version of - ownCloud!" + Nextcloud!" When can I pull? This is the last step of the Kanban board. When the Release finally happens @@ -208,8 +193,8 @@ Reviewing considered impossible? How can you possibly review an issue when it requires you to test various combinations of browsers, platforms, databases and maybe even app combinations? Well, you can’t. But you can write a gherkin scenario that can be used to write -an automated test that is executed by Jenkins on every commit to the main -repositories. If for some reason Jenkins cannot be used for the review you will +an automated test that is executed by Drone on every commit to the main +repositories. If for some reason Drone cannot be used for the review you will find yourself in the very uncomfortable situation where you release half tested code that will hopefully not eat user data. Seriously! Write gherkin scenarios! @@ -221,7 +206,7 @@ Priority Labels * Panic should be used with caution. It is reserved for Bugs that would result in the loss of files or other user data. An Enhancement marked as Panic is - expected by ownCloud users for the next release. In either case an open Panic + expected by Nextcloud users for the next release. In either case an open Panic issue will prevent a release. * Attention is not as hard as Panic. But we really want this in the next release @@ -257,7 +242,7 @@ Misc Labels * Needs info – Either from a developer or the bug reporter. This is nearly as severe as Panic, because no further action can be taken * L18n – A translation issue go see our `transifex`_ -* Junior Job – The issue is considered a good starting point to get involved in ownCloud development +* Junior Job – The issue is considered a good starting point to get involved in Nextcloud development Milestones equal Releases ------------------------- @@ -271,15 +256,12 @@ the Kanban board by Milestone, making it especially easy to focus on the current Release. .. _kanban board: http://en.wikipedia.org/wiki/Kanban_board -.. _mailing list: mailto:owncloud@kde.org -.. _core: http://huboard.com/owncloud/core/board/# -.. _apps: http://huboard.com/owncloud/apps/board/# -.. _client: http://huboard.com/owncloud/client/board/# +.. _forums: https://help.nextcloud.org .. _Gherkin: https://github.com/cucumber/cucumber/wiki/Gherkin -.. _existing ones: https://ci.tmit.eu/job/acceptance-test/cucumber-html-reports/? +.. _existing ones: https://github.com/nextcloud/server/tree/master/build/integration/features .. _“Given … when … then …“: https://github.com/cucumber/cucumber/wiki/Given-When-Then -.. _unit tests: https://github.com/owncloud/core/tree/master/tests -.. _Code Review Documentation: https://owncloud.org/dev/code-reviews-on-github/ -.. _Jenkins: https://ci.tmit.eu/ +.. _unit tests: https://github.com/nextcloud/server/tree/master/tests +.. _Code Review Documentation: codereviews +.. _Drone: https://drone.weasel.rocks .. _cucumber: http://cukes.info/ -.. _transifex: https://www.transifex.com/projects/p/owncloud/ +.. _transifex: https://www.transifex.com/nextcloud/ diff --git a/developer_manual/bugtracker/triaging.rst b/developer_manual/bugtracker/triaging.rst index 0d7dcf40cbe..b3654f3a158 100644 --- a/developer_manual/bugtracker/triaging.rst +++ b/developer_manual/bugtracker/triaging.rst @@ -1,18 +1,18 @@ -===================== -ownCloud Bug Triaging -===================== +====================== +Nextcloud Bug Triaging +====================== .. toctree:: :maxdepth: 2 :hidden: -Bug Triaging is the process of checking bug reports to see if they are still valid (the problem might be solved since the bug was reported), reproducing them when possible (to make sure it really is an ownCloud issue and not a configuration problem) and in general making sure the bug is useful for a developer who wants to fix it. If the bug is not useful and can't be augmented by the original reporter or the triaging contributor, it has to be closed. +Bug Triaging is the process of checking bug reports to see if they are still valid (the problem might be solved since the bug was reported), reproducing them when possible (to make sure it really is an Nextcloud issue and not a configuration problem) and in general making sure the bug is useful for a developer who wants to fix it. If the bug is not useful and can't be augmented by the original reporter or the triaging contributor, it has to be closed. Why do you want to join ======================= -Helping to bring the number of issues down makes it easier for developers to spend their time productively and bug triagers thus **contribute greatly to ownCloud development**! Triaging a bug doesn’t take long so the work comes in small chunks and you don’t need many skills, just some patience and sometimes perseverance. +Helping to bring the number of issues down makes it easier for developers to spend their time productively and bug triagers thus **contribute greatly to Nextcloud development**! Triaging a bug doesn’t take long so the work comes in small chunks and you don’t need many skills, just some patience and sometimes perseverance. -Bug triagers who contribute significantly should ask to be listed as an active contributor on the `owncloud.org `_ page! +Bug triagers who contribute significantly should ask to be listed as an active contributor on the `nextcloud.com `_ page! How do you triage bugs ====================== @@ -35,10 +35,10 @@ General considerations ====================== * You need a `github account `_ to contribute to bug triaging. -* If you are not familiar with the github issue tracker interface (which is used by ownCloud to handle bug reports), you `may find this guide useful `_. +* If you are not familiar with the github issue tracker interface (which is used by Nextcloud to handle bug reports), you `may find this guide useful `_. * You will initially only be able to comment on issues. The ability to close issues or assign labels will be given liberally to those who have shown to be willing and able to contribute. Just ask on IRC! -* Read `our bug reporting guidelines `_ so you know what a good report should look like and where things belong. The `issue template `_ asks specifically for some information developers need to solve issues. -* It might even be fixed, sometimes! It can also be fruitful to contact the `developers on irc `_. Tell them you're triaging bugs and share what problem you bumped into. Or just ask on the test-pilots mailing list. +* Read `our bug reporting guidelines `_ so you know what a good report should look like and where things belong. The `issue template `_ asks specifically for some information developers need to solve issues. +* It might even be fixed, sometimes! It can also be fruitful to contact the `developers on irc `_. Tell them you're triaging bugs and share what problem you bumped into. Or just ask on the test-pilots mailing list. * To ensure no two people are working on the same issue, we ask you to simply add a comment like "I am triaging this" in the issue you want to work on, and when done, before or after executing the triaging actions, note similarly that you're done. To be able to tag and close issues, you need to have access to the repository. For the core and sync app repositories this also means having signed the contributor agreement. However, this isn't really needed for triaging as you can comment after you're done triaging and somebody else can execute those actions. @@ -48,11 +48,11 @@ Finding bugs to triage Github offers several search queries which can be useful to find a list of bugs which deserve a closer look: -* `The bugs least recently commented on `_ -* `Least commented issues `_ -* `Bugs which need info `_ +* `The bugs least recently commented on `_ +* `Least commented issues `_ +* `Bugs which need info `_ -But there are more methods. For example, if you are a user of ownCloud 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. +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. Once you have picked an issue, add a comment that you've started triaging: @@ -72,7 +72,7 @@ Let's go over each step. Finding duplicates ------------------ -To find duplicates, the search tool in github is your first stop. In `this screen `_ you can easily search for a few keywords from the bug report. If you find other bugs with the same content, decide what the best bug report is (often the oldest or the one where one or more developers have already started to engage and discuss the problem). That is the 'master' bug report, you can now close the other one (or comment that it can be closed as duplicate). +To find duplicates, the search tool in github is your first stop. In `this screen `_ you can easily search for a few keywords from the bug report. If you find other bugs with the same content, decide what the best bug report is (often the oldest or the one where one or more developers have already started to engage and discuss the problem). That is the 'master' bug report, you can now close the other one (or comment that it can be closed as duplicate). If the bug report you were reviewing contains additional information, you can add that information to the 'master' bug report in a comment. Mention this bug report (using #) so a developer can look up the original, closed, report and perhaps ask the initial reporter there for additional information. @@ -86,17 +86,17 @@ When the issue is a feature request, you can be helpful in the same way: merge r Determining relevance of issue ------------------------------ -Not all issues are relevant for ownCloud. Bugs can be due to a specific configuration or unsupported platforms. Raspberry Pi's suffer from SQLite time-outs, nginx has problems Apache doesn't and Microsoft Server with IIS is not well supported. While external issues are not always a reason to close a report, be sure that they are clear: does the user use the 'standard' platform? Ask for information if this is missing. +Not all issues are relevant for Nextcloud. Bugs can be due to a specific configuration or unsupported platforms. Raspberry Pi's suffer from SQLite time-outs, nginx has problems Apache doesn't and Microsoft Server with IIS is not well supported. While external issues are not always a reason to close a report, be sure that they are clear: does the user use the 'standard' platform? Ask for information if this is missing. -Last but not least, the problem might be due to the user doing something that simply does not work. Your general ownCloud knowledge might be helpful here - if this is the case, you can often swiftly close the issue with a comment about what went wrong. +Last but not least, the problem might be due to the user doing something that simply does not work. Your general Nextcloud knowledge might be helpful here - if this is the case, you can often swiftly close the issue with a comment about what went wrong. -.. note:: You might have to say no to some requests, for example when a problem has been solved in a new release but won't become available for the release the reporter is using; or when a solution has been chosen which the reporter is unhappy about. Be considerate. People feel surprisingly strong about ownCloud, and you should take care to explain that we don't aim to ignore them; on the contrary. But sometimes, decisions which benefit the majority of users don't help an individual. The extensibility and open availability of the code of ownCloud is here to relieve the pain of such decisions. +.. note:: You might have to say no to some requests, for example when a problem has been solved in a new release but won't become available for the release the reporter is using; or when a solution has been chosen which the reporter is unhappy about. Be considerate. People feel surprisingly strong about Nextcloud, and you should take care to explain that we don't aim to ignore them; on the contrary. But sometimes, decisions which benefit the majority of users don't help an individual. The extensibility and open availability of the code of Nextcloud is here to relieve the pain of such decisions. Determining if the report is complete ------------------------------------- Now that you know that the bug report is unique, and that is not an external issue, you need to check all the needed information is there. -Check `our bug reporting guidelines `_ and make sure bug reports comply with it! The information asked in the `issue template `_ is needed for developers to solve issues. +Check `our bug reporting guidelines `_ and make sure bug reports comply with it! The information asked in the `issue template `_ is needed for developers to solve issues. Once you added a request for more information, add a #needinfo tag. @@ -110,30 +110,18 @@ This is needed in order to differentiate random/race condition bugs of reproduci To reproduce an issue, please refer to our testing documents: :doc:`../testing/index` -If you can't reproduce an issue in a newer version of ownCloud, it is most likely fixed and can be closed. Comment that you failed to reproduce the problem, and if the reporter can confirm (or doesn't respond for a long time), you can close the issue. Also, be sure to add what exactly you tested with - the ownCloud Master or a branch (and if so, when), or did you use a release, and if so - what version? +If you can't reproduce an issue in a newer version of Nextcloud, it is most likely fixed and can be closed. Comment that you failed to reproduce the problem, and if the reporter can confirm (or doesn't respond for a long time), you can close the issue. Also, be sure to add what exactly you tested with - the Nextcloud Master or a branch (and if so, when), or did you use a release, and if so - what version? 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 `_. - -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 ownCloud get the same amount of attention and contribution, so this can occasionally take a long time. - - -Collaboration -============= -You can just get started with bug triaging. But if you want, you can register on the `testpilot mailing list `_ and perhaps introduce yourself to `testpilots@owncloud.org `_. On this list we announce and discuss testing and bug triaging related subjects. - -You can also join the **#owncloud-testing** channel on **irc.freenode.net** (`link for IRC clients `_ and `link to webchat `_) to ask questions but keep in mind that people aren't active 24/7 and it can occasionally take a while to get a response. Last but not least, ownCloud contributor `Jan Borchardt has a great guide for developers and triagers `_ about dealing with issues, including some 'stock answers' and thoughts on how to deal with pull requests. - -For further questions or help you can also send a mail to: +* 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 -* X (IRC: Y) +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. -We are looking forward to working with you! **Credit:** this document is in debt to the extensive `KDE guide to bug triaging `_. diff --git a/developer_manual/commun/index.rst b/developer_manual/commun/index.rst index fc6a10b5bb6..52f6ace7d99 100644 --- a/developer_manual/commun/index.rst +++ b/developer_manual/commun/index.rst @@ -15,7 +15,7 @@ Chat with us on `IRC `_. All channels are on **irc.free * Setup: **#nextcloud** * Development: **#nextcloud-dev** -* Design: **#owncloud-design** +* Design: **#nextcloud-design** * Mobile: **#nextcloud-mobile** diff --git a/developer_manual/conf.py b/developer_manual/conf.py index 05e8fb616a3..391d2228c72 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -40,17 +40,17 @@ master_doc = 'index' # General information about the project. -project = u'ownCloud Developer Manual' -copyright = u'2012-2015, The ownCloud developers' +project = u'Nextcloud Developer Manual' +copyright = u'2012-2016, The Nextcloud developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '9.1' +version = '10' # The full version, including alpha/beta/rc tags. -release = '9.1' +release = '10' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -166,7 +166,7 @@ #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'owncloudDeveloperManual' +htmlhelp_basename = 'nextcloudDeveloperManual' # -- Options for LaTeX output -------------------------------------------------- @@ -185,8 +185,8 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'ownCloudDeveloperManual.tex', u'ownCloud Developer Manual', - u'The ownCloud developers', 'manual'), + ('index', 'NextcloudDeveloperManual.tex', u'Nextcloud Developer Manual', + u'The Nextcloud developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -211,16 +211,16 @@ # -- Options for pdf page output ----------------------------------------------- -pdf_documents = [('index', u'owncloudDeveloperManual', u'ownCloud Developer Manual', - u'The ownCloud developers'),] +pdf_documents = [('index', u'nextcloudDeveloperManual', u'Nextcloud Developer Manual', + u'The Nextcloud developers'),] # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'owncloudDeveloperManual', u'ownCloud Developer Manual', - [u'The ownCloud developers'], 1) + ('index', 'nextcloudDeveloperManual', u'Nextcloud Developer Manual', + [u'The Nextcloud developers'], 1) ] # If true, show URL addresses after external links. @@ -233,8 +233,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'ownCloudDeveloperManual', u'ownCloud Developer Manual', - u'The ownCloud developers', 'ownCloud', 'The ownCloud Developer Manual.', + ('index', 'NextcloudDeveloperManual', u'Nextcloud Developer Manual', + u'The Nextcloud developers', 'Nextcloud', 'The Nextcloud Developer Manual.', 'Miscellaneous'), ] @@ -251,10 +251,10 @@ # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = u'ownCloud Developer Manual' -epub_author = u'The ownCloud developers' -epub_publisher = u'The ownCloud developers' -epub_copyright = u'2012-2015, The ownCloud developers' +epub_title = u'Nextcloud Developer Manual' +epub_author = u'The Nextcloud developers' +epub_publisher = u'The Nextcloud developers' +epub_copyright = u'2012-2016, The Nextcloud developers' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/developer_manual/core/configfile.rst b/developer_manual/core/configfile.rst index db203424709..fefa80a74ed 100644 --- a/developer_manual/core/configfile.rst +++ b/developer_manual/core/configfile.rst @@ -6,25 +6,25 @@ App config false, /* Type of database, can be sqlite, mysql or pgsql */ "dbtype" => "sqlite", - /* Name of the ownCloud database */ - "dbname" => "owncloud", + /* Name of the Nextcloud database */ + "dbname" => "nextcloud", - /* User to access the ownCloud database */ + /* User to access the Nextcloud database */ "dbuser" => "", - /* Password to access the ownCloud database */ + /* Password to access the Nextcloud database */ "dbpassword" => "", - /* Host running the ownCloud database */ + /* Host running the Nextcloud database */ "dbhost" => "", - /* Prefix for the ownCloud tables in the database */ + /* Prefix for the Nextcloud tables in the database */ "dbtableprefix" => "", /* Define the salt used to hash the user passwords. All your user passwords are lost if you lose this string. */ @@ -33,7 +33,7 @@ App config /* Force use of HTTPS connection (true = use HTTPS) */ "forcessl" => false, - /* Theme to use for ownCloud */ + /* Theme to use for Nextcloud */ "theme" => "", /* Path to the 3rdparty directory */ @@ -74,13 +74,13 @@ App config /* Check 3rdparty apps for malicious code fragments */ "appcodechecker" => "", - /* Check if ownCloud is up to date */ + /* Check if Nextcloud is up to date */ "updatechecker" => true, /* Place to log to, can be owncloud and syslog (owncloud is log menu item in admin menu) */ "log_type" => "owncloud", - /* File for the owncloud logger to log to, (default is ownloud.log in the data dir */ + /* File for the owncloud logger to log to, (default is nextcloud.log in the data dir */ "logfile" => "", /* Loglevel to start logging at. 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR (default is WARN) */ @@ -102,7 +102,7 @@ App config You must have at least 1 app folder writable or you must set the parameter : appstoreenabled to false */ array( - 'path'=> '/var/www/owncloud/apps', + 'path'=> '/var/www/nextcloud/apps', 'url' => '/apps', 'writable' => true, ), @@ -113,7 +113,7 @@ App config Using alternative app directories --------------------------------- -ownCloud can be set to use a custom app directory in /config/config.php. Customise the following code and add it to your config file: +Nextcloud can be set to use a custom app directory in /config/config.php. Customise the following code and add it to your config file: .. code-block:: php @@ -133,4 +133,4 @@ ownCloud can be set to use a custom app directory in /config/config.php. Customi ), ), -ownCloud will use the first app directory which it finds in the array with 'writable' set to true. +Nextcloud will use the first app directory which it finds in the array with 'writable' set to true. diff --git a/developer_manual/core/externalapi.rst b/developer_manual/core/externalapi.rst index a61225d68d6..1b630066191 100644 --- a/developer_manual/core/externalapi.rst +++ b/developer_manual/core/externalapi.rst @@ -5,8 +5,8 @@ External API Introduction ------------ -The external API inside ownCloud allows third party developers to access data -provided by ownCloud apps. ownCloud follows the `OCS v1.7 +The external API inside Nextcloud allows third party developers to access data +provided by Nextcloud apps. Nextcloud follows the `OCS v1.7 specification `_ (draft). Usage @@ -21,12 +21,12 @@ Methods are registered inside the :file:`appinfo/routes.php` using :php:class:`O /ocs/v1.php/apps/files_sharing/api/v1* +The base URL for all calls to the share API is: */ocs/v1.php/apps/files_sharing/api/v1* Local Shares ============ @@ -136,13 +136,14 @@ Federated Cloud Shares ====================== Both the sending and the receiving instance need to have federated cloud sharing -enabled and configured. See `Configuring Federated Cloud Sharing `_. +enabled and configured. See `Configuring Federated Cloud Sharing `_. +.. TODO ON RELEASE: Update version number above on release Create a new Federated Cloud Share ---------------------------------- Creating a federated cloud share can be done via the local share endpoint, using -(int) 6 as a shareType and the `Federated Cloud ID `_ +(int) 6 as a shareType and the `Federated Cloud ID `_ of the share recipient as shareWith. See `Create a new Share`_ for more information. diff --git a/developer_manual/core/theming.rst b/developer_manual/core/theming.rst index 475c2e3230c..8f4cde11108 100644 --- a/developer_manual/core/theming.rst +++ b/developer_manual/core/theming.rst @@ -1,10 +1,10 @@ -Theming ownCloud -================ -Themes can be used to customize the look and feel of ownCloud. -Themes can relate to the following topics of owncloud: +Theming Nextcloud +================= +Themes can be used to customize the look and feel of Nextcloud. +Themes can relate to the following topics of Nextcloud: * Theming the web-frontend -* Theming the owncloud Desktop client +* Theming the desktop client This documentation contains only the Web-frontend adaptations so far. @@ -22,7 +22,7 @@ With this facts you can easily determine, where the following object-related att The next thing you should do, before starting any changes is: Make a backup of your current theme(s) e.g.: -* cd …/owncloud/themes +* cd …/nextcloud/themes * cp -r example mytheme @@ -41,11 +41,11 @@ Depending on how you created your new theme it will be necessary to Structure ========= -The folder structure of a theme is exactly the same as the main ownCloud +The folder structure of a theme is exactly the same as the main Nextcloud structure. You can override js files, images, translations and templates with own versions. CSS files are loaded additionally to the default files so you can override CSS properties. CSS files and the standard pictures that are used reside -for example in /owncloud/core/ and /owncloud/settings/ in these sub folders: +for example in /nextcloud/core/ and /nextcloud/settings/ in these sub folders: * css = style sheets * js = JavaScripts @@ -58,21 +58,21 @@ for example in /owncloud/core/ and /owncloud/settings/ in these sub folders: Notes for Updates ================= -It is not recommended to the user to perform adaptations inside the +It is not recommended to the user to perform adaptations inside the folder ``/themes/example`` because files inside this folder might get -replaced during the next ownCloud update process. +replaced during the next Nextcloud update process. -During an update, files might get changed within the core and settings -folders. This could result in problems because your template files will +During an update, files might get changed within the core and settings +folders. This could result in problems because your template files will not 'know' about these changes and therefore must be manually merged with the updated core file or simply be deleted (or renamed for a test). For example if ``/settings/templates/apps.php`` gets updated by a new -ownCloud version, and you have a ``/themes/MyTheme/settings/templates/apps.php`` +Nextcloud version, and you have a ``/themes/MyTheme/settings/templates/apps.php`` in your template, you must merge the changes that where made within the update with the ones you did in your template. -But this is unlikely and will be mentioned in the ownCloud release notes if it occurs. +But this is unlikely and will be mentioned in the Nextcloud release notes if it occurs. How to change images and the logo @@ -91,10 +91,10 @@ If you want to do a quick exchange like (1) it's important to know the size of t * You can look up sizing in most cases via the file properties inside your file-manager * Create an own picture/logo with the same size then -The (main) pictures, that can be found inside ownCloud standard theming are the following: +The (main) pictures, that can be found inside Nextcloud standard theming are the following: -* The logo at the login-page above the credentials-box: …/owncloud/themes/default/core/img/logo.svg -* The logo, that's always in the left upper corner after login: …/owncloud/themes/default/core/img/logo-wide.svg +* The logo at the login-page above the credentials-box: …/nextcloud/themes/default/core/img/logo.svg +* The logo, that's always in the left upper corner after login: …/nextcloud/themes/default/core/img/logo-wide.svg Inserting your new logo ----------------------- @@ -102,17 +102,17 @@ Inserting a new logo into an existing theme is as simple as replacing the old lo You can use: scalable vector graphics (.svg) or common graphics formats for the internet such as portable network graphics (.png) or .jepg Just insert the new created picture by using the unchanged name of the old picture. -The app icons can also be overwritten in a theme. To change for example the app icon of the activity app you need to overwrite it by saving the new image to …/owncloud/themes/default/apps/activity/img/activity.svg +The app icons can also be overwritten in a theme. To change for example the app icon of the activity app you need to overwrite it by saving the new image to …/nextcloud/themes/default/apps/activity/img/activity.svg Changing favicon ---------------- -For compatibility with older browsers, favicon (the image that appears in your browser tab) uses .../owncloud/core/img/favicon.ico. +For compatibility with older browsers, favicon (the image that appears in your browser tab) uses .../nextcloud/core/img/favicon.ico. To customize favicon for MyTheme: * Create a version of your logo in .ico format -* Store your custom favicon as .../owncloud/themes/MyTheme/core/img/favicon.ico -* Include .../owncloud/themes/MyTheme/core/img/favicon.svg and favicon.png to cover any future updates to favicon handling. +* Store your custom favicon as .../nextcloud/themes/MyTheme/core/img/favicon.ico +* Include .../nextcloud/themes/MyTheme/core/img/favicon.svg and favicon.png to cover any future updates to favicon handling. Changing the default colours ---------------------------- @@ -144,7 +144,7 @@ As usual: * third pair gives the blue value. Save your CSS-file and refresh to see the new login screen. -The other major color scheme is the blue header bar on the main navigation page once you log in to ownCloud. +The other major color scheme is the blue header bar on the main navigation page once you log in to Nextcloud. This color we will change with the above as well. Save the file and refresh the browser for the changes to take effect. @@ -193,7 +193,7 @@ terms in there. How to change names, slogans and URLs ===================================== -The ownCloud theming allows a lot of the names that are shown on the web interface to be changed. It's also possible to change the URLs to the documentation or the Android/iOS apps. +The Nextcloud theming allows a lot of the names that are shown on the web interface to be changed. It's also possible to change the URLs to the documentation or the Android/iOS apps. This can be done with a file named ``defaults.php`` within the root of the theme. You can find it in the example theme (*/themes/example/defaults.php*). In there you need to specify a class named ``OC_Theme`` and need to implement the methods you want to overwrite: @@ -201,11 +201,11 @@ This can be done with a file named ``defaults.php`` within the root of the theme class OC_Theme { public function getAndroidClientUrl() { - return 'https://play.google.com/store/apps/details?id=com.owncloud.android'; + return 'https://play.google.com/store/apps/details?id=com.nextcloud.client'; } public function getName() { - return 'ownCloud'; + return 'Nextcloud'; } } diff --git a/developer_manual/core/translation.rst b/developer_manual/core/translation.rst index ac1dc6c8c6b..29e196d8799 100644 --- a/developer_manual/core/translation.rst +++ b/developer_manual/core/translation.rst @@ -95,8 +95,8 @@ Configure transifex for resource in calendar contacts core files media gallery settings do - tx set --auto-local -r owncloud.$resource "/$resource.po" --source-language=en \ + tx set --auto-local -r nextcloud.$resource "/$resource.po" --source-language=en \ --source-file "templates/$resource.pot" --execute done -.. _Transifex: https://www.transifex.net/projects/p/owncloud/ +.. _Transifex: https://www.transifex.com/nextcloud/ diff --git a/developer_manual/core/unit-testing.rst b/developer_manual/core/unit-testing.rst index d7f3980ec0c..b20334b9983 100644 --- a/developer_manual/core/unit-testing.rst +++ b/developer_manual/core/unit-testing.rst @@ -7,7 +7,7 @@ PHP unit testing Getting PHPUnit ~~~~~~~~~~~~~~~ -ownCloud uses PHPUnit >= 3.7 for unit testing. +Nextcloud uses PHPUnit >= 4.8 for unit testing. To install it, either get it via your packagemanager:: @@ -22,7 +22,7 @@ or install it manually:: After the installation the ''phpunit'' command is available:: phpunit --version - + And you can update it using:: phpunit --self-update @@ -38,13 +38,13 @@ To get started, do the following: Then you can simply run the created test with phpunit. -.. note:: If you use ownCloud functions in your class under test (i.e: OC::getUser()) you'll need to bootstrap ownCloud or use dependency injection. +.. note:: If you use Nextcloud functions in your class under test (i.e: OC::getUser()) you'll need to bootstrap Nextcloud or use dependency injection. .. note:: You'll most likely run your tests under a different user than the Web server. This might cause problems with your PHP settings (i.e: open_basedir) and requires you to adjust your configuration. An example for a simple test would be: -:file:`/srv/http/owncloud/apps/myapp/tests/testaddtwo.php` +:file:`/srv/http/nextcloud/apps/myapp/tests/testaddtwo.php` .. code-block:: php @@ -66,7 +66,7 @@ An example for a simple test would be: } -:file:`/srv/http/owncloud/apps/myapp/lib/testme.php` +:file:`/srv/http/nextcloud/apps/myapp/lib/testme.php` .. code-block:: php @@ -79,7 +79,7 @@ An example for a simple test would be: } } -In :file:`/srv/http/owncloud/apps/myapp/` you run the test with:: +In :file:`/srv/http/nextcloud/apps/myapp/` you run the test with:: phpunit tests/testaddtwo.php @@ -91,13 +91,13 @@ so the next test can run without side effects, like remaining files and entries For more resources on PHPUnit visit: http://www.phpunit.de/manual/current/en/writing-tests-for-phpunit.html -Bootstrapping ownCloud -~~~~~~~~~~~~~~~~~~~~~~ -If you use ownCloud functions or classes in your code, you'll need to make them available to your test by bootstrapping ownCloud. +Bootstrapping Nextcloud +~~~~~~~~~~~~~~~~~~~~~~~ +If you use Nextcloud functions or classes in your code, you'll need to make them available to your test by bootstrapping Nextcloud. To do this, you'll need to provide the ``--bootstrap`` argument when running PHPUnit -:file:`/srv/http/owncloud`:: +:file:`/srv/http/nextcloud`:: phpunit --bootstrap tests/bootstrap.php apps/myapp/tests/testsuite.php @@ -108,14 +108,14 @@ adjust your php.ini and file rights. open_basedir = none -:file:`/srv/http/owncloud`:: +:file:`/srv/http/nextcloud`:: su -c "chmod a+r config/config.php" su -c "chmod a+rx data/" - su -c "chmod a+w data/owncloud.log" + su -c "chmod a+w data/nextcloud.log" -Running unit tests for the ownCloud core project -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Running unit tests for the Nextcloud core project +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The core project provides a script that runs all the core unit tests using different database backends like sqlite, mysql, pgsql, oci (for Oracle):: ./autotest.sh @@ -186,7 +186,6 @@ Documentation Here are some useful links about how to write unit tests with Jasmine and Sinon: -- Karma test runner: http://karma-runner.github.io +- Karma test runner: http://karma-runner.github.io - Jasmine: http://pivotal.github.io/jasmine -- Sinon (for mocking and stubbing): http://sinonjs.org/ - +- Sinon (for mocking and stubbing): http://sinonjs.org/ diff --git a/developer_manual/general/backporting.rst b/developer_manual/general/backporting.rst index 27e5142d403..66ef207a52f 100644 --- a/developer_manual/general/backporting.rst +++ b/developer_manual/general/backporting.rst @@ -14,7 +14,7 @@ Process We mostly consider bug fixes for back porting. Occasionally, important changes to the API can be backported to make it easier for developers to keep their apps working between major releases. If you think a pull request (PR) is relevant for the stable release, go through these steps: 1. Make sure the PR is merged to master -2. Ask Frank (**@karlitschek**) and Thomas (**@deepdiver1975**) if the code should be backported and add the label `backport-request `_ to the PR +2. Ask Frank (**@karlitschek**) and Thomas (**@deepdiver1975**) if the code should be backported and add the label `backport-request `_ to the PR 3. If Frank or Thomas say yes then create a new branch based on the respective stable branch (stable7 for the 7.0.x series), cherry-pick the needed commits to that branch and create a PR on GitHub. 4. Specify the corresponding milestone for that series (7.0.x-next-maintenance for the 7.0.x series) to this PR and reference the original PR in there. This enables the QA team to find the backported items for testing and having the original PR with detailed description linked. diff --git a/developer_manual/general/code-of-conduct.rst b/developer_manual/general/code-of-conduct.rst index e3b2a213061..27a5a6acff7 100644 --- a/developer_manual/general/code-of-conduct.rst +++ b/developer_manual/general/code-of-conduct.rst @@ -4,11 +4,11 @@ Community Code of Conduct Preamble: --------- -In the ownCloud community, participants from all over the world come together to create Free Software for a free internet. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use ownCloud software. +In the Nextcloud community, participants from all over the world come together to create Free Software for a free internet. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use Nextcloud software. -This document offers some guidance to ensure ownCloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. +This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. -This Code of Conduct is shared by all contributors and users who engage with the ownCloud team and its community services. +This Code of Conduct is shared by all contributors and users who engage with the Nextcloud team and its community services. Overview -------- @@ -24,10 +24,10 @@ This Code of Conduct presents a summary of the shared values and “common sense Our community is made up of several groups of individuals and organizations which can roughly be divided into two groups: -* Contributors, or those who add value to the project through improving ownCloud software and its services -* Users, or those who add value to the project through their support as consumers of ownCloud software +* Contributors, or those who add value to the project through improving Nextcloud software and its services +* Users, or those who add value to the project through their support as consumers of Nextcloud software -This Code of Conduct reflects the agreed standards of behavior for members of the ownCloud community, in any forum, mailing list, wiki, web site, IRC channel, public meeting or private correspondence within the context of the ownCloud team and its services. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of mailing lists, IRC channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct. +This Code of Conduct reflects the agreed standards of behavior for members of the Nextcloud community, in any forum, mailing list, wiki, web site, IRC channel, public meeting or private correspondence within the context of the Nextcloud team and its services. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of mailing lists, IRC channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct. Be considerate -------------- @@ -36,23 +36,23 @@ Your actions and work will affect and be used by other people and you in turn wi As a contributor, ensure that you give full credit for the work of others and bear in mind how your changes affect others. It is also expected that you try to follow the development schedule and guidelines. -As a user, remember that contributors work hard on their part of ownCloud and take great pride in it. If you are frustrated your problems are more likely to be resolved if you can give accurate and well-mannered information to all concerned. +As a user, remember that contributors work hard on their part of Nextcloud and take great pride in it. If you are frustrated your problems are more likely to be resolved if you can give accurate and well-mannered information to all concerned. Be respectful ------------- -In order for the ownCloud community to stay healthy its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance assume that people mean well. +In order for the Nextcloud community to stay healthy its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance assume that people mean well. We do not tolerate personal attacks, racism, sexism or any other form of discrimination. Disagreement is inevitable, from time to time, but respect for the views of others will go a long way to winning respect for your own view. Respecting other people, their work, their contributions and assuming well-meaning motivation will make community members feel comfortable and safe and will result in motivation and productivity. -We expect members of our community to be respectful when dealing with other contributors, users and communities. Remember that ownCloud is an international project and that you may be unaware of important aspects of other cultures. +We expect members of our community to be respectful when dealing with other contributors, users and communities. Remember that Nextcloud is an international project and that you may be unaware of important aspects of other cultures. Be collaborative ---------------- The Free Software Movement depends on collaboration: it helps limit duplication of effort while improving the quality of the software produced. In order to avoid misunderstanding, try to be clear and concise when requesting help or giving it. Remember it is easy to misunderstand emails (especially when they are not written in your mother tongue). Ask for clarifications if unsure how something is meant; remember the first rule – assume in the first instance that people mean well. -As a contributor, you should aim to collaborate with other community members, as well as with other communities that are interested in or depend on the work you do. Your work should be transparent and be fed back into the community when available, not just when ownCloud releases. If you wish to work on something new in existing projects, keep those projects informed of your ideas and progress. +As a contributor, you should aim to collaborate with other community members, as well as with other communities that are interested in or depend on the work you do. Your work should be transparent and be fed back into the community when available, not just when Nextcloud releases. If you wish to work on something new in existing projects, keep those projects informed of your ideas and progress. It may not always be possible to reach consensus on the implementation of an idea, so don’t feel obliged to achieve this before you begin. However, always ensure that you keep the outside world informed of your work, and publish it in a way that allows outsiders to test, discuss and contribute to your efforts. @@ -63,7 +63,7 @@ As a user, your feedback is important, as is its form. Poorly thought out commen Be pragmatic ------------ -ownCloud is a pragmatic community. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps getting things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help getting the job done. Let decisions be taken by those who do the work. +Nextcloud is a pragmatic community. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps getting things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help getting the job done. Let decisions be taken by those who do the work. Support others in the community ------------------------------- @@ -83,4 +83,4 @@ Think deeply before turning a disagreement into a public dispute. If necessary r This document is licensed under the Creative Commons Attribution – Share Alike 3.0 License. -The authors of this document would like to thank the ownCloud community and those who have worked to create such a dynamic environment to share in and who offered their thoughts and wisdom in the authoring of this document. We would also like to thank other vibrant communities that have helped shape this document with their own examples, especially KDE. +The authors of this document would like to thank the Nextcloud community and those who have worked to create such a dynamic environment to share in and who offered their thoughts and wisdom in the authoring of this document. We would also like to thank other vibrant communities that have helped shape this document with their own examples, especially KDE. diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/general/codingguidelines.rst index 79645ec19ca..1a04d7fcf85 100644 --- a/developer_manual/general/codingguidelines.rst +++ b/developer_manual/general/codingguidelines.rst @@ -6,55 +6,37 @@ Coding Style & General Guidelines General ------- -* Ideally, discuss your plans on the `mailing list `_ to see if others want to work with you on it -* We use `Github `_, please get an account there and clone the repositories you want to work on +* Ideally, discuss your plans on the `forums `_ to see if others want to work with you on it +* We use `Github `_, please get an account there and clone the repositories you want to work on * Fixes go directly to master, nevertheless they need to be tested thoroughly. * New features are always developed in a branch and only merged to master once they are fully done. * Software should work. We only put features into master when they are complete. It's better to not have a feature instead of having one that works poorly. * It is best to start working based on an issue - create one if there is none. You describe what you want to do, ask feedback on the direction you take it and take it from there. * When you are finished, use the merge request function on Github to create a pull request. The other developers will look at it and give you feedback. You can signify that your PR is ready for review by adding the label "5 - ready for review" to it. You can also post your merge request to the mailing list to let people know. See `the code review page for more information <../bugtracker/codereviews.html>`_ * It is key to keep changes separate and small. The bigger and more hairy a PR grows, the harder it is to get it in. So split things up where you can in smaller changes - if you need a small improvement like a API addition for a big feature addition, get it in first rather than adding it to the big piece of work! -* Decisions are made by consensus. We strive for making the best technical decisions and as nobody can know everything, we collaborate. That means a first negative comment might not be the final word, neither is positive feedback an immediate GO. ownCloud is built out of modular pieces (apps) and maintainers have a strong influence. In case of disagreement we consult other seasoned contributors. -* We need a signed contributor agreement from you to commit into the core repository (apps don't need that). All the information is in our `Contributor agreement FAQ `_. +* Decisions are made by consensus. We strive for making the best technical decisions and as nobody can know everything, we collaborate. That means a first negative comment might not be the final word, neither is positive feedback an immediate GO. Nextcloud is built out of modular pieces (apps) and maintainers have a strong influence. In case of disagreement we consult other seasoned contributors. Labels ------ -We assign labels to issues and pull requests to make it easy to find them and to signal what needs to be done. Some of these are assigned by the developers, others by QA, bug triagers, project lead or maintainers and so on. It is not desired that users/reporters of bugs assign labels themselves, unless they are developers/contributors to ownCloud. +We assign labels to issues and pull requests to make it easy to find them and to signal what needs to be done. Some of these are assigned by the developers, others by QA, bug triagers, project lead or maintainers and so on. It is not desired that users/reporters of bugs assign labels themselves, unless they are developers/contributors to Nextcloud. 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 ownCloud +* #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 ownCloud -* Tags showing the state of the issue or PR, numbered 1-6: +* #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 -* 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 ownCloud 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...) +* 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. @@ -115,7 +97,7 @@ User interface PHP --- -The ownCloud coding style guide is based on `PEAR Coding Standards `_. +The Nextcloud coding style guide is based on `PEAR Coding Standards `_. Always use:: diff --git a/developer_manual/general/debugging.rst b/developer_manual/general/debugging.rst index bc0e22e2aa6..83f376b4fa9 100644 --- a/developer_manual/general/debugging.rst +++ b/developer_manual/general/debugging.rst @@ -4,7 +4,7 @@ Debugging Debug mode ---------- -When debug mode is enabled in ownCloud, a variety of debugging features are enabled - see debugging documentation. Set ``debug`` to ``true`` in :file:`/config/config.php` to enable it: +When debug mode is enabled in Nextcloud, a variety of debugging features are enabled - see debugging documentation. Set ``debug`` to ``true`` in :file:`/config/config.php` to enable it: .. code-block:: php @@ -18,7 +18,7 @@ When debug mode is enabled in ownCloud, a variety of debugging features are enab Identifying errors ------------------ -ownCloud 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 ownCloud'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 @@ -30,7 +30,7 @@ e.g.: .. code-block:: php - + not: @@ -38,7 +38,7 @@ not: -To disable custom error handling in ownCloud (and have PHP and your Web server handle errors instead), see Debug mode. +To disable custom error handling in Nextcloud (and have PHP and your Web server handle errors instead), see Debug mode. Using a PHP debugger (XDebug) @@ -62,7 +62,7 @@ XDebug will now (when activated) try to connect to localhost on port 9000, and w For further reading, see the XDebug documentation: http://xdebug.org/docs/remote -Once you are familiar with how your debugging client works, you can start debugging with XDebug. To test ownCloud through the web interface or other HTTP requests, set the ``XDEBUG_SESSION_START`` cookie or POST parameter. Alternatively, there are browser extensions to make this easy: +Once you are familiar with how your debugging client works, you can start debugging with XDebug. To test Nextcloud through the web interface or other HTTP requests, set the ``XDEBUG_SESSION_START`` cookie or POST parameter. Alternatively, there are browser extensions to make this easy: - The Easiest XDebug (Firefox): https://addons.mozilla.org/en-US/firefox/addon/the-easiest-xdebug/ - XDebug Helper (Chrome): https://chrome.google.com/extensions/detail/eadndfjplgieldjbigjakmdgkmoaaaoc @@ -73,13 +73,13 @@ For debugging scripts on the command line, like ``occ`` or unit tests, set the ` Debugging Javascript -------------------- -By default all Javascript files in ownCloud are minified (compressed) into a single file without whitespace. To prevent this, see Debug mode. +By default all Javascript files in Nextcloud are minified (compressed) into a single file without whitespace. To prevent this, see Debug mode. Debugging HTML and templates ---------------------------- -By default ownCloud caches HTML generated by templates. This may prevent changes to app templates, for example, from being applied on page refresh. To disable caching, see Debug mode. +By default Nextcloud caches HTML generated by templates. This may prevent changes to app templates, for example, from being applied on page refresh. To disable caching, see Debug mode. Using alternative app directories diff --git a/developer_manual/general/devenv.rst b/developer_manual/general/devenv.rst index fab24436580..9853d232a7c 100644 --- a/developer_manual/general/devenv.rst +++ b/developer_manual/general/devenv.rst @@ -11,16 +11,16 @@ Please follow the steps on this page to set up your development environment. Set up Web server and database ============================== -First `set up your Web server and database `_ (**Section**: Manual Installation - Prerequisites). +First `set up your Web server and database `_ (**Section**: Manual Installation - Prerequisites). .. TODO ON RELEASE: Update version number above on release Get the source ============== -There are two ways to obtain ownCloud sources: +There are two ways to obtain Nextcloud sources: -* Using the `stable version `_ +* Using the `stable version `_ .. TODO ON RELEASE: Update version number above on release * Using the development version from `GitHub`_ which will be explained below. @@ -32,14 +32,14 @@ Gather information about server setup To get started the basic git repositories need to cloned into the Web server's directory. Depending on the distribution this will either be * **/var/www** -* **/var/www/html** -* **/srv/http** +* **/var/www/html** +* **/srv/http** Then identify the user and group the Web server is running as and the Apache user and group for the **chown** command will either be * **http** -* **www-data** +* **www-data** * **apache** * **wwwrun** @@ -53,7 +53,7 @@ Install the `development tool `_ After the development tool installation make the directory writable:: sudo chmod o+rw /var/www - + Then install Nextcloud from git:: ncdev setup --dir /var/www/ server @@ -108,6 +108,5 @@ or to prune all merged branches, you would execute this:: It is even easier if you create alias from these commands in case you want to avoid retyping those each time you need them. -.. _GitHub: https://github.com/owncloud +.. _GitHub: https://github.com/nextcloud .. _GitHub Help Page: https://help.github.com/ - diff --git a/developer_manual/general/performance.rst b/developer_manual/general/performance.rst index b6adbed3c52..07acda7a6b2 100644 --- a/developer_manual/general/performance.rst +++ b/developer_manual/general/performance.rst @@ -1,19 +1,19 @@ Performance Considerations ========================== -.. sectionauthor:: Frank Karlitschek +.. sectionauthor:: Frank Karlitschek -This document introduces some common considerations and tips on improving performance of ownCloud. Speed of ownCloud 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 ownCloud and consider reviewing your app to make it faster. +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. .. note::**Tips welcome**: More tips and ideas on performance are very welcome! Database performance -------------------- -The database plays an important role in ownCloud performance. The general rule is: database queries are very bad and should be avoided if possible. The reasons for that are: +The database plays an important role in Nextcloud performance. The general rule is: database queries are very bad and should be avoided if possible. The reasons for that are: -* Roundtrips: Bigger ownCloud installations have the database not installed on the application server but on a remote dedicated database server. The problem is that database queries then go over the network. These roundtrips can add up significantly if you have a lot of queries. +* Roundtrips: Bigger Nextcloud installations have the database not installed on the application server but on a remote dedicated database server. The problem is that database queries then go over the network. These roundtrips can add up significantly if you have a lot of queries. * Speed. A lot of people think that databases are fast. This is not always true if you compare it with handling data internally in PHP or in the filesystem or even using key/value based storages. So every developer should always double check if the database is really the best place for the data. -* Scalability. If you have a big ownCloud cluster setup you usually have several ownCloud/Web servers in parallel and a central database and a central storage. This means that everything that happens on the ownCloud/PHP side can parallelize and can be scaled. Stuff that is happening in the database and in the storage is critical because it only exists once and can't be scaled so easily. +* Scalability. If you have a big Nextcloud cluster setup you usually have several Nextcloud/Web servers in parallel and a central database and a central storage. This means that everything that happens on the Nextcloud/PHP side can parallelize and can be scaled. Stuff that is happening in the database and in the storage is critical because it only exists once and can't be scaled so easily. We can reduce the load on the database by: @@ -29,11 +29,11 @@ With MySQL it is very easy with just a bit of configuration: If you put this into your my.cnf file, every query that takes longer than one second is logged to a logfile:: - log_slow_queries = 1 - log_slow_queries = /var/log/mysql/mysql-slow.log - long_query_time=1 + log_slow_queries = 1 + log_slow_queries = /var/log/mysql/mysql-slow.log + long_query_time=1 -If a query takes more than a second we have a serious problem of course. You can watch it with `tail -f /var/log/mysql/mysql-slow.log` while using ownCloud. +If a query takes more than a second we have a serious problem of course. You can watch it with `tail -f /var/log/mysql/mysql-slow.log` while using Nextcloud. 2. log all queries. @@ -61,4 +61,4 @@ The recommendation is to automatically do 10000 PROPFINDs or file uploads, measu Getting help ------------ -If you need help with performance or other issues please ask on our `mailing list `_ or on our IRC channel **#owncloud-dev** on **irc.freenode.net**. +If you need help with performance or other issues please ask on our `forums `_ or on our IRC channel **#nextcloud-dev** on **irc.freenode.net**. diff --git a/developer_manual/general/security.rst b/developer_manual/general/security.rst index 8fc0eb085d3..e2147043e86 100644 --- a/developer_manual/general/security.rst +++ b/developer_manual/general/security.rst @@ -38,7 +38,7 @@ Cross site scripting `Cross site scripting `_ happens when user input is passed directly to templates. A potential attacker might be able to inject HTML/JavaScript into the page to steal the users session, log keyboard entries, even perform DDOS attacks on other websites or other malicious actions. -Despite the fact that ownCloud uses Content-Security-Policy to prevent the execution of inline JavaScript code developers are still required to prevent XSS. CSP is just another layer of defense that is not implemented in all web browsers. +Despite the fact that Nextcloud uses Content-Security-Policy to prevent the execution of inline JavaScript code developers are still required to prevent XSS. CSP is just another layer of defense that is not implemented in all web browsers. To prevent XSS in your app you have to sanitize the templates and all JavaScripts which performs a DOM manipulation. @@ -103,9 +103,9 @@ Clickjacking `Clickjacking `_ tricks the user to click into an invisible iframe to perform an arbitrary action (e.g. delete an user account) -To prevent such attacks ownCloud sends the `X-Frame-Options` header to all template responses. Don't remove this header if you don't really need it! +To prevent such attacks Nextcloud sends the `X-Frame-Options` header to all template responses. Don't remove this header if you don't really need it! -This is already built into ownCloud if :php:class:`OC_Template`. +This is already built into Nextcloud if :php:class:`OC_Template`. Code executions / File inclusions --------------------------------- @@ -194,7 +194,7 @@ Auth bypass / Privilege escalations Auth bypass/privilege escalations happen when a user is able to perform unauthorized actions. -ownCloud offers three simple checks: +Nextcloud offers three simple checks: * **OCP\\JSON::checkLoggedIn()**: Checks if the logged in user is logged in * **OCP\\JSON::checkAdminUser()**: Checks if the logged in user has admin privileges @@ -207,7 +207,7 @@ Additionally always check if the user has the right to perform that action. (e.g Sensitive data exposure ----------------------- -Always store user data or configuration files in safe locations, e.g. **owncloud/data/** and not in the webroot where they can be accessed by anyone using a web browser. +Always store user data or configuration files in safe locations, e.g. **nextcloud/data/** and not in the webroot where they can be accessed by anyone using a web browser. Cross site request forgery -------------------------- @@ -246,4 +246,4 @@ Always validate the URL before redirecting if the requested URL is on the same d Getting help ------------ -If you need help to ensure that a function is secure please ask on our `mailing list `_ or on our IRC channel **#owncloud-dev** on **irc.freenode.net**. +If you need help to ensure that a function is secure please ask on our `mailing list `_ or on our IRC channel **#nextcloud-dev** on **irc.freenode.net**. diff --git a/developer_manual/index.rst b/developer_manual/index.rst index 6f4055a5736..f6472625a3c 100644 --- a/developer_manual/index.rst +++ b/developer_manual/index.rst @@ -1,31 +1,12 @@ .. _contents: -================================ -ownCloud Developer Documentation -================================ +================================= +Nextcloud Developer Documentation +================================= -If you want to contribute please read the `Contributor agreement -`_ - -+-------------------------+-------------------------+-----------------------------+ -|:doc:`app/index` |:doc:`core/index` |`Documentation`_ | -| Develop apps for | Develop on the ownCloud | Create and enhance | -| ownCloud and publish on | internals | documentation | -| the `ownCloud appstore`_| | | -+-------------------------+-------------------------+-----------------------------+ -|:doc:`testing/index` |:doc:`bugtracker/index` |`Translation`_ | -| Help us to test | Report, triage or fix | Translate ownCloud into | -| ownCloud by joining the | bugs to improve quality | your language | -| testing team | | | -+-------------------------+-------------------------+-----------------------------+ -|:doc:`commun/index` | :doc:`ios_library/index`|:doc:`android_library/index` | -| Help on IRC, the | Integration with iOS | Integrating with Android | -| mailinglist and forum | | | -+-------------------------+-------------------------+-----------------------------+ - -.. _ownCloud appstore: https://apps.owncloud.com/ -.. _Translation: https://www.transifex.com/projects/p/owncloud/ -.. _Documentation: https://github.com/owncloud/documentation#owncloud-documentation +.. _ownCloud Appstore: https://apps.owncloud.com/ +.. _Translation: https://www.transifex.com/nextcloud/ +.. _Documentation: https://github.com/nextcloud/documentation#nextcloud-documentation Table of Contents ================= @@ -36,10 +17,6 @@ Table of Contents general/index app/index android_library/index - ios_library/index core/index - testing/index bugtracker/index commun/index - -.. test diff --git a/developer_manual/ios_library/examples.rst b/developer_manual/ios_library/examples.rst deleted file mode 100644 index 8a9a6e4aebb..00000000000 --- a/developer_manual/ios_library/examples.rst +++ /dev/null @@ -1,819 +0,0 @@ -Examples -======== - -Init the library ----------------- - -Start using the library, it is needed to init the object OCCommunication. - -We recommend using the singleton method in the AppDelegate class in order to -use the ownCloud iOS library. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - #import "OCCommunication.h" - - + (OCCommunication *)sharedOCCommunication - { - static OCCommunication* sharedOCCommunication = nil; - - if (sharedOCCommunication == nil) - { - sharedOCCommunication = [ [ OCCommunicationalloc] init ]; - } - - return sharedOCCommunication; - } - -Also could happen that you need to overwrite the class AFURLSessionManager to manage SSL Certificates - -.. code-block:: objective-c - - #import "OCCommunication.h" - - + (OCCommunication*)sharedOCCommunication - { - static OCCommunication* sharedOCCommunication = nil; - if (sharedOCCommunication == nil) - { - //Network Upload queue for NSURLSession (iOS 7) - NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration backgroundSessionConfiguration:k_session_name]; - configuration.HTTPMaximumConnectionsPerHost = 1; - configuration.requestCachePolicy = NSURLRequestReloadIgnoringLocalCacheData; - OCURLSessionManager *uploadSessionManager = [[OCURLSessionManager alloc] initWithSessionConfiguration:configuration]; - [uploadSessionManager.operationQueue setMaxConcurrentOperationCount:1]; - [uploadSessionManager setSessionDidReceiveAuthenticationChallengeBlock:^NSURLSessionAuthChallengeDisposition (NSURLSession *session, NSURLAuthenticationChallenge *challenge, NSURLCredential * __autoreleasing *credential) { - return NSURLSessionAuthChallengePerformDefaultHandling; - }]; - - sharedOCCommunication = [[OCCommunication alloc] initWithUploadSessionManager:uploadSessionManager]; - - } - return sharedOCCommunication; - } - -Set credentials ---------------- - -Authentication on the app is possible by 3 different methods: - -* Basic authentication, user name and password -* Cookie -* Token (oAuth) - - -Code example -~~~~~~~~~~~~ - - -.. code-block:: objective-c - - #Basic authentication, user name and password - [[ AppDelegate sharedOCCommunication ] setCredentialsWithUser : userName andPassword : password ]; - - #Authentication with cookie - [[ AppDelegate sharedOCCommunication ] setCredentialsWithCookie : cookie ]; - - #Authentication with token - [[ AppDelegate sharedOCCommunication ] setCredentialsOauthWithToken : token ]; - - -Create a folder ---------------- - -Create a new folder on the cloud server, the info needed to be sent is the path -of the new folder. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] createFolder :path onCommunication : [ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer) { - //Folder Created - } - - failureRequest :^( NSHTTPURLResponse *response, NSError *error) { - - //Failure - - switch (response.statusCode) { - - case kOCErrorServerUnauthorized : - //Bad credentials - break; - case kOCErrorServerForbidden : - //Forbidden - break; - case kOCErrorServerPathNotFound : - //Not Found - break; - case kOCErrorServerTimeout : - //timeout - break; - default: - //default - break; - } - - } - errorBeforeRequest :^( NSError *error) { - //Error before request - - if (error.code == OCErrorForbidenCharacters) { - //Forbidden characters - } - else - { - //Other error - } - - }]; -   -Read folder ------------ - -Get the content of an existing folder on the cloud server, the info needed to -be sent is the path of the folder. As answer of this method, it will be -received an array with all the files and folders stored in the selected folder. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication] readFolder:path onCommunication:[ AppDelegate sharedOCCommunication] - - successRequest:^( NSHTTPURLResponse *response, NSArray *items, NSString *redirectedServer) { - //Success - for ( OCFileDto * ocFileDto in items) { - NSLog( @"item path: %@%@" , ocFileDto.filePath, ocFileDto.fileName); - } - } - - failureRequest:^( NSHTTPURLResponse *response, NSError *error) { - - //Failure - switch (response.statusCode) { - case kOCErrorServerPathNotFound : - //Path not found - break; - case kOCErrorServerUnauthorized : - //Bad credentials - break; - case kOCErrorServerForbidden : - //Forbidden - break; - case kOCErrorServerTimeout : - //Timeout - break ; - default : - break; - } - - }]; - -Read file ---------- - -Get information related to a certain file or folder. Although, more information -can be obtained, the library only gets the eTag. - -Other properties of the file or folder may be obtained: filePath, filename, -isDirectory, size and date - -Code example -~~~~~~~~~~~~ - - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] readFile :path onCommunication :[ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, NSArray *items, NSString *redirectedServer) { - - OCFileDto *ocFileDto = [items objectAtIndex : 0 ]; - NSLog ( @"item etag: %lld" , ocFileDto. etag); } - failureRequest :^( NSHTTPURLResponse *response, NSError *error) { - switch (response.statusCode) { - case kOCErrorServerPathNotFound: - //Path not found - break; - case kOCErrorServerUnauthorized: - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorServerTimeout: - //Timeout - break; - default: - break; - } - }]; - -Move file or folder -------------------- - - -Move a file or folder from their current path to a new one on the cloud server. -The info needed is the origin path and the destiny path. - - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] moveFileOrFolder :sourcePath toDestiny :destinyPath onCommunication :[ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer) { - //File/Folder moved or renamed - } - failureRequest :^( NSHTTPURLResponse *response, NSError *error) { - //Failure - switch (response.statusCode) { - case kOCErrorServerPathNotFound: - //Path not found - break; - case kOCErrorServerUnauthorized: - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorServerTimeout: - //Timeout - break; - default: - break; - } - - } - errorBeforeRequest :^( NSError *error) { - if (error.code == OCErrorMovingTheDestinyAndOriginAreTheSame) { - //The destiny and the origin are the same - } - else if (error.code == OCErrorMovingFolderInsideHimself) { - //Moving folder inside himself - } - else if (error.code == OCErrorMovingDestinyNameHaveForbiddenCharacters) { - //Forbidden Characters - } - else - { - //Default - } - - }]; - - -Delete file or folder ---------------------- - -Delete a file or folder on the cloud server. The info needed is the path to -delete. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c -   - [[ AppDelegate sharedOCCommunication ] deleteFileOrFolder :path onCommunication :[ AppDelegate - - sharedOCCommunication ] successRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer) { - //File or Folder deleted - } - failureRequest :^( NSHTTPURLResponse *response, NSError *error) { - - switch (response.statusCode) { - case kOCErrorServerPathNotFound: - //Path not found - break; - case kOCErrorServerUnauthorized: - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorServerTimeout: - //Timeout - break; - default: - break; - } - - }]; - - -Download a file ---------------- - -Download an existing file on the cloud server. The info needed is the server -URL, path of the file on the server and localPath, path where the file will be -stored on the device and a boolean to indicate if is necessary to use LIFO queue or FIFO. - -Code example -~~~~~~~~~~~~ - - -.. code-block:: objective-c - - NSOperation *op = nil; - op = [[ AppDelegate sharedOCCommunication ] downloadFile :remotePath toDestiny :localPath withLIFOSystem:isLIFO onCommunication :[ AppDelegate sharedOCCommunication ] - - progressDownload :^( NSUInteger bytesRead, long long totalBytesRead, long long totalBytesExpectedToRead) { - - //Calculate percent - float percent = ( float)totalBytesRead / totalBytesExpectedToRead; - NSLog ( @"Percent of download: %f" , percent); } - successRequest :^(NSHTTPURLResponse *response, NSString *redirectedServer) { - //Download complete - } - failureRequest :^(NSHTTPURLResponse *response, NSError *error) { - switch (response. statusCode) { - case kOCErrorServerUnauthorized: - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorProxyAuth: - //Proxy access required - break; - case kOCErrorServerPathNotFound: - //Path not found - break; - default: - //Default - break; - } - } - shouldExecuteAsBackgroundTaskWithExpirationHandler :^{ - [op cancel ]; - }]; - - - - - -Download a file with background session ---------------------------------------- - -Download an existing file storaged on the cloud server using background session, only supported by iOS 7 and higher. - -The info needed is, the server URL: path where the file is stored on the server; localPath: path where the file will be stored on the device; and NSProgress: object where get the callbacks of the upload progress. - -To get the callbacks of the progress is needed use a KVO in the progress object. We add the code in this example of the call to set the KVO and the method where catch the notifications. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - NSURLSessionDownloadTask *downloadTask = nil; - - NSProgress *progress = nil; - - downloadTask = [_sharedOCCommunication downloadFileSession:serverUrl toDestiny:localPath defaultPriority:YES onCommunication:_sharedOCCommunication withProgress:&progress successRequest:^(NSURLResponse *response, NSURL *filePath) { - //Upload complete - } failureRequest:^(NSURLResponse *response, NSError *error) { - - switch (error.code) { - case kCFURLErrorUserCancelledAuthentication: - //Authentication cancelled - break; - - default: - switch (response.statusCode) { - case kOCErrorServerUnauthorized : - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorProxyAuth: - //Proxy access required - break; - case kOCErrorServerPathNotFound: - //Path not found - break; - default: - //Default - break; - } - break; - } - }]; - - // Observe fractionCompleted using KVO - [progress addObserver:self forKeyPath:@"fractionCompleted" options:NSKeyValueObservingOptionNew context:NULL]; - - - //Method to catch the progress notifications with callbacks - - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context - { - if ([keyPath isEqualToString:@"fractionCompleted"] && [object isKindOfClass:[NSProgress class]]) { - NSProgress *progress = (NSProgress *)object; - - float percent = roundf (progress.fractionCompleted * 100); - - //We make it on the main thread because we came from a delegate - dispatch_async(dispatch_get_main_queue(), ^{ - NSLog(@"Progress is %f", percent); - }); - } - } - - -Set callback when background download task finishes ---------------------------------------------------- - -Method to set callbacks of the pending download transfers when the app starts. It's used when there are pendings download background transfers. The block is executed when a pending background task finishes. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] setDownloadTaskComleteBlock:^NSURL *(NSURLSession *session, NSURLSessionDownloadTask *downloadTask, NSURL *location) { - - - }]; - -Set progress callback with pending background download tasks ------------------------------------------------------------- - -Method to set progress callbacks of the pending download transfers. It's used when there are pendings background download transfers. The block is executed when a pending task get a input porgress. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] setDownloadTaskDidGetBodyDataBlock:^(NSURLSession *session, NSURLSessionDownloadTask *downloadTask, int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite) { - - - }]; - - - - - -Upload a file -------------- - -Upload a new file to the cloud server. The info needed is localPath, path where -the file is stored on the device and server URL, path where the file will be -stored on the server. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - NSOperation *op = nil; - op = [[ AppDelegate sharedOCCommunication ] uploadFile :localPath toDestiny : remotePath onCommunication :[ AppDelegate sharedOCCommunication ] - - progressUpload :^( NSUInteger bytesWrote, long long totalBytesWrote, long long totalBytesExpectedToWrite) { - //Calculate upload percent - if ( totalBytesExpectedToRead/1024 != 0) { - if ( bytesWrote > 0) { - float percent = totalBytesWrote* 100 / totalBytesExpectedToRead; - NSLog ( @"Percent: %f" , percent); - } - } - } - successRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer) { - //Upload complete - } - failureRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer, NSError *error) { - switch (response. statusCode) { - case kOCErrorServerUnauthorized : - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorProxyAuth: - //Proxy access required - break; - case kOCErrorServerPathNotFound: - //Path not found - break; - default: - //Default - break; - } - } - failureBeforeRequest :^( NSError *error) { - switch (error.code) { - case OCErrorFileToUploadDoesNotExist: - //File does not exist - break; - default: - //Default - break; - } - } - shouldExecuteAsBackgroundTaskWithExpirationHandler :^{ - [op cancel]; - }]; - - -Upload a file with background session -------------------------------------- - -Upload a new file to the cloud server using background session, only supported by iOS 7 and higher. - -The info needed is localPath, path where the file is stored on the device and server URL, path where the file will be stored on the server and NSProgress object where get the callbacks of the upload progress. - -To get the callbacks of the progress is needed use a KVO in the progress object. We add the code in this example of the call to set the KVO and the method where catch the notifications. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - NSURLSessionUploadTask *uploadTask = nil; - - NSProgress *progress = nil; - - uploadTask = [[AppDelegate sharedOCCommunication] uploadFileSession:localPath toDestiny:remotePath onCommunication:[ AppDelegate sharedOCCommunication ] withProgress:&progress successRequest:^(NSURLResponse *response, NSString *redirectedServer) { - //Upload complete - } failureRequest:^(NSURLResponse *response, NSString *redirectedServer, NSError *error) { - switch (response.statusCode) { - case kOCErrorServerUnauthorized : - //Bad credentials - break; - case kOCErrorServerForbidden: - //Forbidden - break; - case kOCErrorProxyAuth: - //Proxy access required - break; - case kOCErrorServerPathNotFound: - //Path not found - break; - default: - //Default - break; - } - - }]; - - // Observe fractionCompleted using KVO - [progress addObserver:self forKeyPath:@"fractionCompleted" options:NSKeyValueObservingOptionNew context:NULL]; - - - - //Method to catch the progress notifications with callbacks - - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context - { - if ([keyPath isEqualToString:@"fractionCompleted"] && [object isKindOfClass:[NSProgress class]]) { - NSProgress *progress = (NSProgress *)object; - - float percent = roundf (progress.fractionCompleted * 100); - - //We make it on the main thread because we came from a delegate - dispatch_async(dispatch_get_main_queue(), ^{ - NSLog(@"Progress is %f", percent); - }); - - } - } - -Set callback when background task finish ------------------------------------------ - -Method to set callbacks of the pending transfers when the app starts. It's used when there are pendings background transfers. The block is executed when a pending background task finished. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] setTaskDidCompleteBlock:^(NSURLSession *session, NSURLSessionTask *task, NSError *error) { - - - }]; - -Set progress callback with pending background tasks ---------------------------------------------------- - -Method to set progress callbacks of the pending transfers. It's used when there are pendings background transfers. The block is executed when a pending task get a input porgress. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] setTaskDidSendBodyDataBlock:^(NSURLSession *session, NSURLSessionTask *task, int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) { - - - - }]; - - -Check if the server supports Sharing api ----------------------------------------- - - -The Sharing API is included in ownCloud 5.0.13 and greater versions. The info -needed is activeUser.url, the server URL that you want to check. - -Code Example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] hasServerShareSupport :_activeUser.url onCommunication :[ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, BOOL hasSupport, NSString *redirectedServer) { - } - failureRequest :^( NSHTTPURLResponse *response, NSError *error){ - } - }]; - - -Read shared all items by link ------------------------------ - -Get information about what files and folder are shared by link. - -The info needed is Path, the server URL that you want to check. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] readSharedByServer :path onCommunication :[ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, NSArray *items, NSString *redirectedServer) { - NSLog ( @"Item: %d" , items); - } - - failureRequest :^( NSHTTPURLResponse *response, NSError *error){ - NSLog ( @"error: %@" , error); - NSLog ( @"Operation error: %d" , response.statusCode); - }]; - - -Read shared items by link of a path ------------------------------------- - -Get information about what files and folder are shared by link in a specific path. - -The info needed is the server URL that you want to check and the specific path tha you want to check. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] readSharedByServer:serverPath andPath:path onCommunication:[AppDelegate sharedOCCommunication] successRequest:^(NSHTTPURLResponse *response, NSArray *items, NSString *redirectedServer) { - NSLog ( @"Item: %d" , items); - - - } failureRequest:^(NSHTTPURLResponse *response, NSError *error) { - NSLog ( @"error: %@" , error); - NSLog ( @"Operation error: %d" , response.statusCode); - }]; - -Share link of file or folder ----------------------------- - - -Share a file or a folder from your cloud server by link. -The info needed is Path, your server URL and the path of the item that you want -to share (for example ``/folder/file.pdf``) - - -Code example -~~~~~~~~~~~~ - - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] shareFileOrFolderByServer :path andFileOrFolderPath :itemPath onCommunication :[ AppDelegate sharedOCCommunication ] - successRequest :^( NSHTTPURLResponse *response, NSString *token, NSString *redirectedServer) { - - NSString *sharedLink = [ NSString stringWithFormat:@ `path/public.php?service=files&t=%@ `_ - , token]; - - } - failureRequest :^( NSHTTPURLResponse *response, NSError *error){ - [ _delegate endLoading ]; - - DLog ( @”error.code: %d” , error. code); - DLog (@”server.error: %d”, response. statusCode); - int code = response. statusCode ; - if (error.code == kOCErrorServerPathNotFound) { - } - - switch (code) { - case kOCErrorServerPathNotFound: - //File to share not exists - break; - case kOCErrorServerUnauthorized: - //Error login - break; - case kOCErrorServerForbidden: - //Permission error - break; - case kOCErrorServerTimeout: - //Not possible to connect to server - break; - default: - if (error.code == kOCErrorServerPathNotFound) { - //File to share not exists - } else { - //Not possible to connect to the server - } - break; - - } - - }]; - - } - - NSLog ( @"error: %@" , error); - NSLog ( @"Operation error: %d" , response.statusCode); - }]; - -Unshare a folder or file by link --------------------------------- - - -Stop sharing by link a file or a folder from your cloud server. - -The info needed is Path, your server URL and the Id of the item that you want -to Unshare. - -Before unsharing an item, you have to read the shared items on the selected -server, using the method “ readSharedByServer ” so that you get the array -“items” with all the shared elements. These are objects OCShareDto, one of -their properties is idRemoteShared, parameter needed to unshared an element. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[ AppDelegate sharedOCCommunication ] unShareFileOrFolderByServer :path andIdRemoteSharedShared :sharedByLink. idRemoteShared onCommunication :[ AppDelegate sharedOCCommunication ] - - successRequest :^( NSHTTPURLResponse *response, NSString *redirectedServer) { - //File unshared - } - failureRequest :^( NSHTTPURLResponse *response, NSError *error){ - //Error - } - ]; - - -Check if file of folder is shared ----------------------------------- - -Check if a specific file or folder is shared in your cloud server. - -The info need is Path, your server URL and the Id of the item that you want. - - -Before check an item, you have to read the shared items on the selected -server, using the method “ readSharedByServer ” so that you get the array -“items” with all the shared elements. These are objects OCShareDto, one of -their properties is idRemoteShared, parameter needed to unshared an element. - -Code example -~~~~~~~~~~~~ - -.. code-block:: objective-c - - [[AppDelegate sharedOCCommunication] isShareFileOrFolderByServer:path andIdRemoteShared:_shareDto.idRemoteShared onCommunication:[AppDelegate sharedOCCommunication] successRequest:^(NSHTTPURLResponse *response, NSString *redirectedServer, BOOL isShared) { - //File/Folder is shared - - } failureRequest:^(NSHTTPURLResponse *response, NSError *error) { - //File/Folder is not shared - }]; - - -Tips ----- - -* Credentials must be set before calling any method -* Paths must not be on URL Encoding -* Correct path: ``https://example.com/owncloud/remote.php/dav/Pop_Music/`` -* Wrong path: ``https://example.com/owncloud/remote.php/dav/Pop%20Music/`` -* There are some forbidden characters to be used in folder and files names on the server, same on the ownCloud iOS library "\", "/","<",">",":",""","","?","*" -* To move a folder the origin path and the destination path must end with “/” -* To move a file the origin path and the destination path must not end with “/” -* Upload and download actions may be cancelled thanks to the object “NSOperation” -* Unit tests, before launching unit tests you have to enter your account information (server url, user and password) on OCCommunicationLibTests.m diff --git a/developer_manual/ios_library/images/100000000000030C000001E61DFDBF76.png b/developer_manual/ios_library/images/100000000000030C000001E61DFDBF76.png deleted file mode 100644 index 5c12b3411d2..00000000000 Binary files a/developer_manual/ios_library/images/100000000000030C000001E61DFDBF76.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100000000000030C000001E637605044.png b/developer_manual/ios_library/images/100000000000030C000001E637605044.png deleted file mode 100644 index 5d58db9b38e..00000000000 Binary files a/developer_manual/ios_library/images/100000000000030C000001E637605044.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100000000000030C000001E7A7A01884.png b/developer_manual/ios_library/images/100000000000030C000001E7A7A01884.png deleted file mode 100644 index 606b6cd8432..00000000000 Binary files a/developer_manual/ios_library/images/100000000000030C000001E7A7A01884.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100000000000030C000001E8AB4C3306.png b/developer_manual/ios_library/images/100000000000030C000001E8AB4C3306.png deleted file mode 100644 index 8be0c83107c..00000000000 Binary files a/developer_manual/ios_library/images/100000000000030C000001E8AB4C3306.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100000000000030C000001ECB85120C2.png b/developer_manual/ios_library/images/100000000000030C000001ECB85120C2.png deleted file mode 100644 index 11339b8b99f..00000000000 Binary files a/developer_manual/ios_library/images/100000000000030C000001ECB85120C2.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003430000020C65A3C5A7.png b/developer_manual/ios_library/images/10000201000003430000020C65A3C5A7.png deleted file mode 100644 index 455e6d913ff..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003430000020C65A3C5A7.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100002010000034700000211B6BE4A2B.png b/developer_manual/ios_library/images/100002010000034700000211B6BE4A2B.png deleted file mode 100644 index d71b4828033..00000000000 Binary files a/developer_manual/ios_library/images/100002010000034700000211B6BE4A2B.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003480000020EC688993D.png b/developer_manual/ios_library/images/10000201000003480000020EC688993D.png deleted file mode 100644 index 53a793104c8..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003480000020EC688993D.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003B9000002B619E44B0C.png b/developer_manual/ios_library/images/10000201000003B9000002B619E44B0C.png deleted file mode 100644 index fa5cbd92523..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003B9000002B619E44B0C.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003B9000002B66AC4279B.png b/developer_manual/ios_library/images/10000201000003B9000002B66AC4279B.png deleted file mode 100644 index cfdf947f640..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003B9000002B66AC4279B.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003B9000002B68F027979.png b/developer_manual/ios_library/images/10000201000003B9000002B68F027979.png deleted file mode 100644 index fdecd6ce868..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003B9000002B68F027979.png and /dev/null differ diff --git a/developer_manual/ios_library/images/10000201000003B9000002B69A5110D2.png b/developer_manual/ios_library/images/10000201000003B9000002B69A5110D2.png deleted file mode 100644 index da8a9bab33e..00000000000 Binary files a/developer_manual/ios_library/images/10000201000003B9000002B69A5110D2.png and /dev/null differ diff --git a/developer_manual/ios_library/images/100002010000046D000002B55ECA38D5.png b/developer_manual/ios_library/images/100002010000046D000002B55ECA38D5.png deleted file mode 100644 index b8c443339ec..00000000000 Binary files a/developer_manual/ios_library/images/100002010000046D000002B55ECA38D5.png and /dev/null differ diff --git a/developer_manual/ios_library/index.rst b/developer_manual/ios_library/index.rst deleted file mode 100644 index 814ad691fcb..00000000000 --- a/developer_manual/ios_library/index.rst +++ /dev/null @@ -1,50 +0,0 @@ -=========================== -iOS Application Development -=========================== -ownCloud provides an official ownCloud iOS client, which gives its users -access to their files on their ownCloud. It also includes functionality like -automatically uploading pictures and videos to ownCloud. - -For third party application developers, ownCloud offers the ownCloud iOS -library under the MIT license. - -iOS ownCloud Client development ------------------------------------ - -If you are interested in working on the ownCloud iOS client, you can find -the source code `in github `_. The -setup and process of contribution is -`documented here `_. - -You might want to start with doing one or two `junior jobs -`_ -to get into the code and note our :doc:`../general/index` - -Note that contribution to the iOS client require signing the iOS addendum to the -`ownCloud Contributor Agreement `_. You are -permitted to test the iOS client on Apple hardware thanks to the -`iOS license exception `_. - -ownCloud iOS Library ------------------------- -This document will describe how to the use ownCloud iOS library. The ownCloud -iOS library for iOS allows a developer to communicate with any ownCloud server; -among the features included are file synchronization, upload and download of -files, delete rename and move of files and folders and share files or folders -by link among others. - -This library may be added to a project and seamlessly integrates any -application with ownCloud. - -The tool needed is Xcode 6, this guide includes some screenshots showing -examples in Xcode 6. - -.. _iosindex: - -.. toctree:: - :maxdepth: 2 - :hidden: - - library_installation - examples - diff --git a/developer_manual/ios_library/library_installation.rst b/developer_manual/ios_library/library_installation.rst deleted file mode 100644 index 03eee3d1305..00000000000 --- a/developer_manual/ios_library/library_installation.rst +++ /dev/null @@ -1,133 +0,0 @@ -Library Installation -==================== - -Obtaining the library ---------------------- - -The ownCloud iOS library may be obtained from the following Github repository: - -`git@github.com:owncloud/ios-library.git -`_ - -Once obtained, this code should be compiled with Xcode 6. The Github -repository not only contains the library, ownCloud iOS library, but also -contains a sample project, OCLibraryExample, which will assist in learning how -to use the library. - -Add the library to a project ----------------------------- - -There are two methods to add this library to a project. - -* Reference the headers and library binary file (``.a``) directly. -* Include the library as a subproject. - - -Which method to choose depends on user preference as well as whether the source -code and project file of the static library are available. - -Reference headers and library binary files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Follow these steps if this is the desired method. - -1. Compile the ownCloud iOS library and run the project. A ``libownCloudiOS.a`` -file will be generated. - -The following files are required: - -**Library file** - -* ``libownCloudiOS.a`` (Library) - -**Library Classes** - -* ``OCCommunication.h`` (Accessors) Import in the communication class -* ``OCErrorMsg.h`` (Error Messages) Import in the communication class -* ``OCFileDto.h`` and ``OCFileDto.m`` (File/Folder object) Import when using -* ``readFolder`` and ``readFile`` methods -* ``OCFrameworkConstants.h`` (Customize constants) - -2. Add the library file to the project. From the “Build Phases” tab, scroll -to “Link binary files” and select the ‘+’ to add a library. Select the library -file. - -|10000201000003480000020EC688993D_png| - -3. Add the path of the library header files. Under the “Build Settings” tab, -select the target library and add the path in the “Header Search Paths” field. - -|10000201000003430000020C65A3C5A7_png| - -4. Remaining in the “Build Setting” tab, add the flag ``-Obj-C`` under the -“Other Linker Flags” option. - -|100002010000034700000211B6BE4A2B_png| - -At this stage, the library is included on your project and you can start -communicating with the ownCloud server. - -Include the library as a subproject -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Follow these steps if this is the desired method. - -5. Add the file ``ownCloud iOS library.xcodeproj`` to the project via drag and -drop. - -|100000000000030C000001E61DFDBF76_png| - -6. Within the project, navigate to the “Build Phases” tab. Under the “Target -Dependencies” section, select the ‘+’ and choose the library target. - -|100000000000030C000001E7A7A01884_png| - -7. Link the library file to the project target. Under the “Build Phases” tab, -select the ‘+’ under the “Link Binary with Libraries” section and select the -library file. - -|100000000000030C000001E8AB4C3306_png| - -8. Add the flag ``-Obj-C`` to “Other Linker Flags” under the project target on -the “Build Settings” tab. - -|100000000000030C000001ECB85120C2_png| - -9. Finally add the path of the library headers. Under the “Build Settings” -tab, add the path under the “Header Search Paths” option. - -|100000000000030C000001E637605044_png| - -Sources -------- - -* `Creating a static library in iOS tutorial (raywenderlich.com)`_ -* `Apple iOS static library documentation`_ - -.. |100000000000030C000001E61DFDBF76_png| image:: images/100000000000030C000001E61DFDBF76.png - :width: 16.51cm - :height: 10.285cm -.. |100002010000034700000211B6BE4A2B_png| image:: images/100002010000034700000211B6BE4A2B.png - :width: 16.261cm - :height: 10.246cm -.. |100000000000030C000001E7A7A01884_png| image:: images/100000000000030C000001E7A7A01884.png - :width: 16.51cm - :height: 12.023cm -.. |10000201000003480000020EC688993D_png| image:: images/10000201000003480000020EC688993D.png - :width: 16.51cm - :height: 10.329cm -.. |100000000000030C000001E8AB4C3306_png| image:: images/100000000000030C000001E8AB4C3306.png - :width: 14.605cm - :height: 9.137cm -.. |10000201000003430000020C65A3C5A7_png| image:: images/10000201000003430000020C65A3C5A7.png - :width: 16.51cm - :height: 10.358cm -.. |100000000000030C000001E637605044_png| image:: images/100000000000030C000001E637605044.png - :width: 14.605cm - :height: 9.098cm -.. |100000000000030C000001ECB85120C2_png| image:: images/100000000000030C000001ECB85120C2.png - :width: 14.605cm - :height: 9.211cm - -.. _`Creating a static library in iOS tutorial (raywenderlich.com)`: http://www.raywenderlich.com/41377/creating-a-static-library-in-ios-tutorial -.. _`Apple iOS static library documentation`: https://developer.apple.com/library/ios/technotes/iOSStaticLibraries/Articles/configuration.html#/apple_ref/doc/uid/TP40012554-CH3-SW2 diff --git a/developer_manual/testing/index.rst b/developer_manual/testing/index.rst deleted file mode 100644 index 70a213ea983..00000000000 --- a/developer_manual/testing/index.rst +++ /dev/null @@ -1,82 +0,0 @@ -==================== -ownCloud Test Pilots -==================== - -.. toctree:: - :maxdepth: 2 - :hidden: - - -The ownCloud Test Pilots help to test and improve different server and client setups with ownCloud. - -Why do you want to join ------------------------ -There are many different setups and people have different interests. If we want ownCloud to run well on NginX for instance someone has to test this configuration. - -Furthermore, during bug fixing the ownCloud developers often do not have the possibility to reproduce the bug in a given environment nor they are able confirm that it was fixed. As a member of the Test Pilot Team you could act as a contact person for a specific area to help developers **fix the bugs you care about**. Testing ownCloud before it is released is the best way of making sure it does what you need it to! - -Another benefit is a closer relationship to the developers: **You know what people are responsible for which parts** and it is easier to get help. - -If you want you will be listed as an active contributor on the `owncloud.org `_ page. - - -Who can join ------------- -Anyone who is interested in improving the quality on his/her setup and is willing to communicate with developers and other testers. - -How do you join ---------------- -Simply register on the `testpilot mailing list `_ and send an introduction of your personal setup and interests to `testpilots@owncloud.org `_ - -You can also join the **#owncloud-testing** channel on **irc.freenode.net** but keep in mind that we may take longer to answer ;) - -For further questions or help you can also send a mail to: - -* freitag@owncloud.com (IRC: dragotin) -* posselt@owncloud.com (IRC: Raydiation) - -What do you do --------------- -You will receive mails from the mailinglist and also from the bug tracker if developers need your help. Also there will be announcements of new releases and preview releases on the mailing list which give you the possibility to test releases early on and help developers to fix them. - -We are looking forward to working with you :) - -How do you test ---------------- -Testing follows these steps: - -* Set up your testing environment -* Pick something to test -* Test it -* Back to 2 until something unexpected/bad happens -* Check if what you found is really a bug -* File the bug - -Installing ownCloud -------------------- -Testing starts with setting up a testing environment. We urge you to not put your production data on testing -releases unless you have a backup somewhere! - -Start by installing ownCloud, either on real hardware or in a VM. - -You can find instructions for installation in the `admin documentation <../../admin_manual/#installation>`_. - -Please note that we are still working on the documentation and if you bump into a problem, you can -`help us fix it `_. Small things can be edited straight on github. - -The Real Testing ----------------- -Testing is a matter of trying out some scenarios you decide or were asked to test, for example, sharing a folder -and mounting it on another ownCloud instance. If it works – awesome, move on. If it doesn't, find out -as much as you can about why it doesn't and use that for a bug report. - -This is the stage where you should see if your issue is already reported by checking the issue -tracker. It might even be fixed, sometimes! It can also be fruitful to contact the -`developers on irc `_. Tell them you're testing ownCloud -and share what problem you bumped into. Or just ask on the test-pilots mailing list. - -Finally, if the issue you bump into is a clear bug and the developers are not aware of it, file it as a new issue. See :doc:`../bugtracker/index` - - - - diff --git a/style_guide.rst b/style_guide.rst index 37dca942f56..dfa16b83dd6 100644 --- a/style_guide.rst +++ b/style_guide.rst @@ -1,20 +1,20 @@ -============================ -ownCloud Manuals Style Guide -============================ +============================= +Nextcloud Manuals Style Guide +============================= *This is a work in progress* -See the `Documentation README `_ for information on setting up your documentation build environment +See the `Documentation README `_ for information on setting up your documentation build environment See `reStructuredText Primer `_ for a complete Sphinx/RST markup reference. -This is the official style guide for the ownCloud Administration and User +This is the official style guide for the Nextcloud Administration and User manuals. Please follow these conventions for consistency, and easier proofreading and copyediting. When you are writing your text, make it as literal and specific as possible. Put -yourself in the place of the person who is using ownCloud and looking for +yourself in the place of the person who is using Nextcloud and looking for instructions on performing a task. Don't make them guess, but spell out every step in order, and tell exactly what buttons to click or what form fields to fill out. Give complete information; for example, when configuring a @@ -33,7 +33,7 @@ Page Titles and Headings ------------------------ There are many ways to markup headings and subheadings. This is the official -ownCloud way. Use title case. Three levels is enough; if you find that you want more, +Nextcloud way. Use title case. Three levels is enough; if you find that you want more, then re-think the organization of your text:: ============== @@ -90,7 +90,7 @@ This is how they render: .. figure:: users-config.png :alt: User listings and administration page. - *Figure 1: The ownCloud user listing and administration page.* + *Figure 1: The Nextcloud user listing and administration page.* Use double-backticks for inline code and command examples:: @@ -115,7 +115,7 @@ Use lowercase with hyphens for image names, for example image-name.png. Images should be in .png format. Keep your screenshots focused on the items you are describing. When you need an image of something large like a configuration -form on the ownCloud admin page, narrow your Web browser to fold the fields +form on the Nextcloud admin page, narrow your Web browser to fold the fields into a smaller space, because a long skinny graphic is not very readable. Think square. @@ -127,7 +127,7 @@ or add a caption. Captions must follow a blank line and be italicized, like this .. figure:: images/users-config.png :alt: User listings and administration page. - *Figure 1: The ownCloud user listing and administration page.* + *Figure 1: The Nextcloud user listing and administration page.* Images must go into a sub-directory of the directory containing your manual page. Currently the manuals have both a single master images directory, and diff --git a/user_manual/conf.py b/user_manual/conf.py index 09e3661b109..1e8bbb5d06a 100644 --- a/user_manual/conf.py +++ b/user_manual/conf.py @@ -44,13 +44,13 @@ # built documents. # # The short X.Y version. -version = '9.1' +version = '10' # The full version, including alpha/beta/rc tags. -release = '9.1' +release = '10' # General information about the project. -project = u'ownCloud %s User Manual' % (version) -copyright = u'2012-2016, The ownCloud developers' +project = u'Nextcloud %s User Manual' % (version) +copyright = u'2012-2016, The Nextcloud developers' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -166,7 +166,7 @@ #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'ownCloudUserManual' +htmlhelp_basename = 'NextcloudUserManual' # -- Options for LaTeX output -------------------------------------------------- @@ -185,8 +185,8 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('contents', 'ownCloud_User_Manual.tex', u'ownCloud User Manual', - u'The ownCloud developers', 'manual'), + ('contents', 'Nextcloud_User_Manual.tex', u'Nextcloud User Manual', + u'The Nextcloud developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -211,15 +211,15 @@ # -- Options for pdf page output ----------------------------------------------- -pdf_documents = [('contents', u'owncloudUserManual', u'ownCloud User Manual', u'The ownCloud developers'),] +pdf_documents = [('contents', u'nextcloudUserManual', u'Nextcloud User Manual', u'The Nextcloud developers'),] # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('contents', 'owncloudusermanual', u'ownCloud User Manual', - [u'The ownCloud developers'], 1) + ('contents', 'nextcloudusermanual', u'Nextcloud User Manual', + [u'The Nextcloud developers'], 1) ] # If true, show URL addresses after external links. @@ -232,8 +232,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('contents', 'ownCloudUserManual', u'ownCloud User Manual', - u'The ownCloud developers', 'ownCloud', 'The ownCloud User Manual.', + ('contents', 'NextcloudUserManual', u'Nextcloud User Manual', + u'The Nextcloud developers', 'Nextcloud', 'The Nextcloud User Manual.', 'Miscellaneous'), ] @@ -250,10 +250,10 @@ # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = u'ownCloud User Manual' -epub_author = u'The ownCloud developers' -epub_publisher = u'The ownCloud developers' -epub_copyright = u'2012-2016, The ownCloud developers' +epub_title = u'Nextcloud User Manual' +epub_author = u'The Nextcloud developers' +epub_publisher = u'The Nextcloud developers' +epub_copyright = u'2012-2016, The Nextcloud developers' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/user_manual/external_storage/external_storage.rst b/user_manual/external_storage/external_storage.rst index e0d255ac0c3..0e03714ec95 100644 --- a/user_manual/external_storage/external_storage.rst +++ b/user_manual/external_storage/external_storage.rst @@ -6,6 +6,8 @@ The External Storage application allows you to mount external storage services, such as Google Drive, Dropbox, Amazon S3, SMB/CIFS fileservers, and FTP servers in Nextcloud. Your Nextcloud server administrator controls which of these are available to you. Please see `Configuring External Storage (GUI) -`_ in the Nextcloud Administrator's manual for configuration howtos and examples. + +.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index 1e08b4f1474..8d5ffb70cf9 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -12,8 +12,8 @@ Nextcloud Desktop and Mobile Clients ------------------------------------ The recommended method for keeping your desktop PC synchronized with your -Nextcloud server is by using the `ownCloud Desktop Client -`_. You can configure the 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 status and logs all activity, so you always know which remote files have been @@ -29,7 +29,7 @@ base URL and folder only:: example.com/nextcloud -In addition to the mobile apps provided by Nextcloud or ownCloud, you can use other apps to +In addition to the mobile apps provided by Nextcloud or Nextcloud, you can use other apps to connect to Nextcloud from your mobile device using WebDAV. `WebDAV Navigator`_ is a good (proprietary) app for `Android devices`_ and `iPhones`_. The URL to use on these is:: @@ -502,10 +502,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 -.. _ownCloud sync clients: https://doc.owncloud.org/desktop/2.1/ -.. _Mount ownCloud 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/access_webgui.rst b/user_manual/files/access_webgui.rst index 17bf578d50a..d533198140f 100644 --- a/user_manual/files/access_webgui.rst +++ b/user_manual/files/access_webgui.rst @@ -133,15 +133,6 @@ Public link shares are marked with a chain link. Un-shared folders are blank. .. figure:: ../images/files_page-5.png :alt: Share status icons. -If your Nextcloud server is the Enterprise edition, you may also have access -to Sharepoint and Windows Network Drive file shares. These have special status -icons. An icon with a red plugin and background means you have to enter a login -to get access to the share. - -.. figure:: ../images/users-overlays-win-net-drive.png - -.. figure:: ../images/users-overlays-sharepoint.png - Creating or Uploading Files and Directories ------------------------------------------- diff --git a/user_manual/files/desktop_mobile_sync.rst b/user_manual/files/desktop_mobile_sync.rst index 3b21339c6d2..ceec8efd20c 100644 --- a/user_manual/files/desktop_mobile_sync.rst +++ b/user_manual/files/desktop_mobile_sync.rst @@ -3,23 +3,23 @@ Desktop and Mobile Synchronization ================================== For synchronizing files with your desktop computer, we recommend using the -`ownCloud Sync Client`_ for Windows, Mac OS X and Linux until the Nextcloud +`Nextcloud Sync Client`_ for Windows, Mac OS X and Linux until the Nextcloud Sync Client will be released.. -The ownCloud Desktop Sync Client enables you to connect to your private -ownCloud Server. +The Nextcloud Desktop Sync Client enables you to connect to your private +Nextcloud Server. You can create folders in your home directory, and keep the contents of those -folders synced with your ownCloud server. Simply copy a file into the directory -and the ownCloud desktop client does the rest. Make a change to the files on one +folders synced with your Nextcloud server. Simply copy a file into the directory +and the Nextcloud desktop client does the rest. Make a change to the files on one computer, it will flow across the others using these desktop sync clients. You will always have your latest files with you wherever you are. -Its usage is documented separately in the `ownCloud Desktop Client Manual`_. +Its usage is documented separately in the `Nextcloud Desktop Client Manual`_. -.. _ownCloud Sync Client: https://owncloud.org/sync-client/ -.. _ownCloud Desktop Client Manual: https://doc.owncloud.org/ +.. _Nextcloud Sync Client: https://nextcloud.com/install/ +.. _Nextcloud Desktop Client Manual: https://docs.nextcloud.org/ Mobile Clients -------------- diff --git a/user_manual/files/federated_cloud_sharing.rst b/user_manual/files/federated_cloud_sharing.rst index f54722aeda9..10d4c0d9985 100644 --- a/user_manual/files/federated_cloud_sharing.rst +++ b/user_manual/files/federated_cloud_sharing.rst @@ -10,7 +10,7 @@ Creating a New Federation Share ------------------------------- 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: +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 @@ -40,11 +40,11 @@ the link for you and email it to your recipient. When your recipient receives your email they will have to take a number of steps to complete the share link. First they must open the link you sent them in -a Web browser, and then click the **Add to your ownCloud** button. +a Web browser, and then click the **Add to your Nextcloud** button. .. figure:: ../images/create_public_share-8.png -The **Add to your ownCloud** button changes to a form field, and your recipient +The **Add to your Nextcloud** button changes to a form field, and your recipient needs to enter the URL of their Nextcloud or ownCloud server in this field and press the return key, or click the arrow. diff --git a/user_manual/files/large_file_upload.rst b/user_manual/files/large_file_upload.rst index 44f69b45b9d..712d30f449b 100644 --- a/user_manual/files/large_file_upload.rst +++ b/user_manual/files/large_file_upload.rst @@ -15,6 +15,7 @@ set by your administrator): * Contact your administrator to request an increase in these variables * Refer to the section in the `Admin Documentation - `_ that describes how to manage file upload size limits. +.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/index.rst b/user_manual/index.rst index a6e00c9f371..ea25df6a48b 100644 --- a/user_manual/index.rst +++ b/user_manual/index.rst @@ -15,12 +15,12 @@ file synchronization and sharing solution on servers that you control. You can share one or more files and folders on your computer, and synchronize them with your Nextcloud server. Place files in your local shared directories, and those files are immediately synchronized to the server and to other devices -using the ownCloud / Nextcloud Desktop Sync Client, Android app, or iOS app. To +using the Nextcloud / ownCloud Desktop Sync Client, Android app, or iOS app. To learn more about the Nextcloud desktop and mobile clients, please refer to their respective manuals: -* `ownCloud Desktop Client`_ +* `Nextcloud/ownCloud Desktop Client`_ * `Nextcloud Android App`_ -.. _`ownCloud 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/ diff --git a/user_manual/pim/calendar.rst b/user_manual/pim/calendar.rst index 26d0f541d99..ebfc55470ef 100644 --- a/user_manual/pim/calendar.rst +++ b/user_manual/pim/calendar.rst @@ -2,11 +2,5 @@ Using the Calendar App ====================== -The Calendar app is not enabled by default in ownCloud |version| and needs to -be enabled separately. It is also not a supported core app. It is currently -under heavy development, so documentation has moved to the `documentation Wiki -on Github -`_. You are welcome to add content to the Wiki document; all you -need is a Github account. - +The Calendar app is not enabled by default in Nextcloud |version| and needs to +be enabled separately. \ No newline at end of file diff --git a/user_manual/pim/contacts.rst b/user_manual/pim/contacts.rst index 83cd9171228..71bf6af1736 100644 --- a/user_manual/pim/contacts.rst +++ b/user_manual/pim/contacts.rst @@ -2,9 +2,5 @@ Using the Contacts App ====================== -The Contacts app is not enabled by default in ownCloud |version| and needs to -be enabled separately. It is also not a supported core app. It is currently -under heavy development, so documentation has moved to the `documentation Wiki -on Github -`_. +The Contacts app is not enabled by default in Nextcloud |version| and needs to +be enabled separately. \ No newline at end of file diff --git a/user_manual/pim/index.rst b/user_manual/pim/index.rst index 1486142b719..9960f226b63 100644 --- a/user_manual/pim/index.rst +++ b/user_manual/pim/index.rst @@ -2,8 +2,8 @@ Contacts & Calendar =================== -The Contacts, Calendar, and Mail apps are not included in ownCloud 9, and are -not supported. You may easily install them by clicking the Enable button on +The Contacts, Calendar, and Mail apps are not included in Nextcloud 10. +You may easily install them by clicking the Enable button on their respective Apps > Productivity entries. .. toctree:: diff --git a/user_manual/pim/sync_ios.rst b/user_manual/pim/sync_ios.rst index d4d72a47430..ed6678faf4e 100644 --- a/user_manual/pim/sync_ios.rst +++ b/user_manual/pim/sync_ios.rst @@ -52,4 +52,5 @@ Now should now find your contacts in the address book of your iPhone. If it's still not working, have a look at the :doc:`troubleshooting` and `Troubleshooting Contacts & Calendar`_ guides. -.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar +.. _Troubleshooting Contacts & Calendar: https://docs.nextcloud.org/server/10/admin_manual/issues/index.html#troubleshooting-contacts-calendar +.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/pim/sync_kde.rst b/user_manual/pim/sync_kde.rst index acacca9ed0e..9a0ee6b6929 100644 --- a/user_manual/pim/sync_kde.rst +++ b/user_manual/pim/sync_kde.rst @@ -4,20 +4,20 @@ Synchronizing with KDE SC .. image:: ../images/kdes1.png -From KDE SC 4.8 and forward setting up ownCloud is very easy. Note that the KDE -calendar needs to have the ownCloud Calendar and Contacts apps enabled on the -ownCloud server. You need both and not just the Calendar. From System Settings +From KDE SC 4.8 and forward setting up Nextcloud is very easy. Note that the KDE +calendar needs to have the Nextcloud Calendar and Contacts apps enabled on the +Nextcloud server. You need both and not just the Calendar. From System Settings Personal Information/Akonadi Resources Configuration select DAV Groupware resource. .. image:: ../images/kdes2.png -Enter your ownCloud username and password and click "Next". +Enter your Nextcloud username and password and click "Next". .. image:: ../images/kdes3.png -Select ownCloud in the drop down list and click "Next". +Select Nextcloud in the drop down list and click "Next". diff --git a/user_manual/pim/sync_osx.rst b/user_manual/pim/sync_osx.rst index 288eb13aee4..9d6b843f8d9 100644 --- a/user_manual/pim/sync_osx.rst +++ b/user_manual/pim/sync_osx.rst @@ -1,12 +1,12 @@ Synchronizing with OS X ======================= -To use ownCloud with iCal you will need to use the following URL:: +To use Nextcloud with iCal you will need to use the following URL:: https://example.com/remote.php/dav/principals/users/USERNAME/ The setup is basically the same as with iOS using the path ``https://example.com/remote.php/dav/principals/users/USERNAME/`` -to sync with ownCloud. For OS X 10.7 Lion and 10.8 Mountain Lion everything works +to sync with Nextcloud. For OS X 10.7 Lion and 10.8 Mountain Lion everything works fine, but OS X 10.6 (Snow Leopard) and older needs some fiddling to work. A user contributed the following: @@ -31,11 +31,11 @@ your favorite text editor. 8. Make it look like this. Please note that the :443 after **example.com** is important:: - servernamehttps://example.com:443/owncloud/remote.php/dav/principals/users/USERNAME usernameusername + servernamehttps://example.com:443/nextcloud/remote.php/dav/principals/users/USERNAME usernameusername 9. Save the file and open addressbook again. It will not work yet. -10. Open the preferences for your ownCloud CardDAV-Account and enter your password. +10. Open the preferences for your Nextcloud CardDAV-Account and enter your password. 11. You may have to restart addressbook once more. After this, it should work. @@ -46,4 +46,5 @@ There is also an easy `HOWTO`_ in the forum. .. _HOWTO: https://forum.owncloud.org/viewtopic.php?f=3&t=132 -.. _Troubleshooting Contacts & Calendar: https://doc.owncloud.org/server/9.0/admin_manual/issues/index.html#troubleshooting-contacts-calendar +.. _Troubleshooting Contacts & Calendar: https://docs.nextcloud.org/server/10/admin_manual/issues/index.html#troubleshooting-contacts-calendar +.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/pim/sync_thunderbird.rst b/user_manual/pim/sync_thunderbird.rst index 097403d41be..1d4791bc891 100644 --- a/user_manual/pim/sync_thunderbird.rst +++ b/user_manual/pim/sync_thunderbird.rst @@ -4,7 +4,7 @@ Thunderbird - Synchronize Addressbook Addressbook ----------- -As someone who is new to ownCloud, New to SoGo Connector, and new to Thunderbird Addressbook... here is what you need in excruciating pithy detail to make this work (for all the other lost souls out there): +As someone who is new to Nextcloud, New to SoGo Connector, and new to Thunderbird Addressbook... here is what you need in excruciating pithy detail to make this work (for all the other lost souls out there): #. `Thunderbird `_ for your OS unless it comes with your OS distribution (Linux) #. `Sogo Connector `_ (latest release) @@ -17,7 +17,7 @@ With an installed Thunderbird mailtool, an installed SoGo Connector, and an inst - "File > New > **Remote Addressbook**" (SoGo Connector added this) - "**Name:**" is the name you want to give your Addressbook in the Thunderbird addressbook bar area - - "**URL:**" is found in your ownCloud Contacts area, that little Gear symbol + - "**URL:**" is found in your Nextcloud Contacts area, that little Gear symbol .. image:: ../images/contact_thunderbird-Symbol_Gear.jpg @@ -30,14 +30,14 @@ which will display the URL you need for your installation to work. .. image:: ../images/contact_thunderbird-URL_config.jpg Once installed, synchronize (right click on your newly made remote address book and select "Synchronize"). -You'll see your address book populate from ownCloud! Don't click "read only" above unless you don't want to -modify your ownCloud server addressbook, like it contains a listing of corporate contacts and is shared with +You'll see your address book populate from Nextcloud! Don't click "read only" above unless you don't want to +modify your Nextcloud server addressbook, like it contains a listing of corporate contacts and is shared with lots of people, and you don't want a new user dragging it somewhere unintended. The rest of the details of dealing with Thunderbird addressbook are left to the reader... First thing I learned is dragging a contact to a different addressbook is a "move" operation. If you are worried about losing the -contact, save it to a VCF file using ownCloud (Or LDIF using Thunderbird Addressbook) first! Like dragging -from "ownCloud Addressbook" to "Personal Address Book" removes the contact from ownCloud Server +contact, save it to a VCF file using Nextcloud (Or LDIF using Thunderbird Addressbook) first! Like dragging +from "Nextcloud Addressbook" to "Personal Address Book" removes the contact from Nextcloud Server (*deleting it from all the other synchronized installations*) and puts it in your Local Machine -only- Address Book. So be careful or you'll have unintended consequences where you might have intended a "copy" operation.