mirror of
https://github.com/maxkratz/documentation.git
synced 2024-09-16 19:29:06 +00:00
#600 Change headers to sentence case
This commit is contained in:
peterdamian
parent
70be00ef68
commit
9919a3fd3d
142 changed files with 454 additions and 454 deletions
|
|
@ -1,5 +1,5 @@
|
|||
========================
|
||||
Converting Database Type
|
||||
Converting database type
|
||||
========================
|
||||
|
||||
You can convert a SQLite database to a more performing MySQL, MariaDB or
|
||||
|
|
@ -41,7 +41,7 @@ with the question ``Continue with the conversion?``
|
|||
On success the converter will automatically configure the new database in your
|
||||
Nextcloud config ``config.php``.
|
||||
|
||||
Unconvertible Tables
|
||||
Unconvertible tables
|
||||
--------------------
|
||||
|
||||
If you updated your Nextcloud installation there might exist old tables, which
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Database Configuration
|
||||
Database configuration
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Database Configuration
|
||||
Database configuration
|
||||
======================
|
||||
|
||||
Nextcloud requires a database in which administrative data is stored. The following databases are currently supported:
|
||||
|
|
@ -36,7 +36,7 @@ Parameters
|
|||
----------
|
||||
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
|
||||
Configuring a MySQL or MariaDB database
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you decide to use a MySQL or MariaDB database, ensure the following:
|
||||
|
|
@ -106,7 +106,7 @@ this:
|
|||
"dbtableprefix" => "oc_",
|
||||
|
||||
|
||||
PostgreSQL Database
|
||||
PostgreSQL database
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you decide to use a PostgreSQL database make sure that you have installed
|
||||
|
|
@ -206,7 +206,7 @@ this:
|
|||
Troubleshooting
|
||||
---------------
|
||||
|
||||
How to workaround General error: 2006 MySQL server has gone away
|
||||
How to workaround general error: 2006 MySQL server has gone away
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The database request takes too long and therefore the MySQL server times out. Its
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ filesystem.
|
|||
.. note:: The Nextcloud sync client is not affected by these upload limits
|
||||
as it is uploading files in smaller chunks.
|
||||
|
||||
System Configuration
|
||||
System configuration
|
||||
--------------------
|
||||
|
||||
* Make sure that the latest version of PHP (at least 5.6.6) is installed
|
||||
|
|
@ -26,7 +26,7 @@ System Configuration
|
|||
the average number of users uploading at the same time is 100: temp space has
|
||||
to hold at least 10x100 GB
|
||||
|
||||
Configuring Your Web server
|
||||
Configuring your Web server
|
||||
---------------------------
|
||||
|
||||
.. note:: Nextcloud comes with its own ``nextcloud/.htaccess`` file. Because ``php-fpm``
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=======================
|
||||
Providing Default Files
|
||||
Providing default files
|
||||
=======================
|
||||
|
||||
You may distribute a set of default files and folders to all users by placing
|
||||
|
|
@ -26,4 +26,4 @@ They appear on the user's Nextcloud Files page just like any other files.
|
|||
|
||||
.. note:: Overwriting the files in ``core/skeleton`` is not recommended,
|
||||
because those changes will be overwritten on the next update of the Nextcloud
|
||||
server.
|
||||
server.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
========================
|
||||
Encryption Configuration
|
||||
Encryption configuration
|
||||
========================
|
||||
|
||||
The primary purpose of the Nextcloud server-side encryption is to protect users'
|
||||
|
|
@ -73,7 +73,7 @@ storage.
|
|||
<https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-
|
||||
data/>`_ for more information.
|
||||
|
||||
Before Enabling Encryption
|
||||
Before enabling encryption
|
||||
--------------------------
|
||||
|
||||
Plan very carefully before enabling encryption because it is not reversible via
|
||||
|
|
@ -85,7 +85,7 @@ You have more options via the ``occ`` command (see :ref:`occ_encryption_label`)
|
|||
|
||||
.. _enable_encryption_label:
|
||||
|
||||
Enabling Encryption
|
||||
Enabling encryption
|
||||
-------------------
|
||||
|
||||
Nextcloud encryption consists of two parts. The base encryption system is
|
||||
|
|
@ -116,7 +116,7 @@ storage.
|
|||
|
||||
.. figure:: images/encryption15.png
|
||||
|
||||
Sharing Encrypted Files
|
||||
Sharing encrypted files
|
||||
-----------------------
|
||||
|
||||
After encryption is enabled your users must also log out and log back in to
|
||||
|
|
@ -133,7 +133,7 @@ individual shares.
|
|||
|
||||
.. figure:: images/encryption9.png
|
||||
|
||||
Encrypting External Mountpoints
|
||||
Encrypting external mountpoints
|
||||
-------------------------------
|
||||
|
||||
You and your users can encrypt individual external mountpoints. You must have
|
||||
|
|
@ -145,7 +145,7 @@ storage mount, see :ref:`external_storage_mount_options_label`
|
|||
|
||||
.. _enable-file-recovery-key:
|
||||
|
||||
Enabling Users File Recovery Keys
|
||||
Enabling users file recovery keys
|
||||
---------------------------------
|
||||
|
||||
If you lose your Nextcloud password, then you lose access to your encrypted
|
||||
|
|
@ -176,7 +176,7 @@ You may change your Recovery Key password.
|
|||
|
||||
.. _occ_encryption_label:
|
||||
|
||||
occ Encryption Commands
|
||||
occ encryption commands
|
||||
-----------------------
|
||||
|
||||
If you have shell access you may use the ``occ`` command to perform encryption
|
||||
|
|
@ -264,7 +264,7 @@ disable it::
|
|||
|
||||
occ encryption:enable-master-key
|
||||
|
||||
Disabling Encryption
|
||||
Disabling encryption
|
||||
--------------------
|
||||
|
||||
You may disable encryption only with ``occ``. Make sure you have backups of all
|
||||
|
|
@ -278,7 +278,7 @@ Take it out of maintenance mode when you are finished::
|
|||
|
||||
occ maintenance:mode --off
|
||||
|
||||
Files Not Encrypted
|
||||
Files not encrypted
|
||||
-------------------
|
||||
|
||||
Only the data in the files in ``data/user/files`` are encrypted, and not the
|
||||
|
|
@ -295,7 +295,7 @@ filenames or folder structures. These files are never encrypted:
|
|||
There may be other files that are not encrypted; only files that are exposed to
|
||||
third-party storage providers are guaranteed to be encrypted.
|
||||
|
||||
LDAP and Other External User Back-ends
|
||||
LDAP and other external user back-ends
|
||||
--------------------------------------
|
||||
|
||||
If you use an external user back-end, such as an LDAP or Samba server, and you
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================================
|
||||
External Storage Authentication mechanisms
|
||||
External Storage authentication mechanisms
|
||||
==========================================
|
||||
|
||||
Nextcloud storage backends accept one or more authentication schemes such as
|
||||
|
|
@ -12,7 +12,7 @@ behavior.
|
|||
.. figure:: images/authentication-types.png
|
||||
:alt: Authentication types
|
||||
|
||||
Special Mechanisms
|
||||
Special mechanisms
|
||||
------------------
|
||||
|
||||
The **None** authentication mechanism requires no configuration parameters, and
|
||||
|
|
@ -23,7 +23,7 @@ parameters, but is used as a placeholder for legacy storages that have not been
|
|||
migrated to the new system and do not take advantage of generic authentication
|
||||
mechanisms. The authentication parameters are provided directly by the backend.
|
||||
|
||||
Password-based Mechanisms
|
||||
Password-based mechanisms
|
||||
-------------------------
|
||||
|
||||
The **Username and password** mechanism requires a manually-defined username and
|
||||
|
|
@ -51,7 +51,7 @@ The **Global credentials** mechanism uses the general input field for "Global
|
|||
credentials" in the external storage settings section as source for the
|
||||
credentials instead of individual credentials for a mount point.
|
||||
|
||||
Public-key Mechanisms
|
||||
Public-key mechanisms
|
||||
---------------------
|
||||
|
||||
Currently only the RSA mechanism is implemented, where a public/private
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ You can find the mount id for a specific storage using ``occ files_external:list
|
|||
On default this command shows no output, can you see the list of detected changes by
|
||||
passing the ``-v`` option to the command.
|
||||
|
||||
SMB Authentication
|
||||
SMB authentication
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In some cases (such as when using login credentials) it's not possible to read the
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=================================================
|
||||
Configuring External Storage (Configuration File)
|
||||
Configuring External Storage (configuration file)
|
||||
=================================================
|
||||
|
||||
Starting with Nextcloud 9.0, the :file:`data/mount.json` file for configuring
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The External storage support application is enabled on your Apps page.
|
|||
.. figure:: external_storage/images/enable-app.png
|
||||
:alt: Enable external storage on your Apps page.
|
||||
|
||||
Storage Configuration
|
||||
Storage configuration
|
||||
---------------------
|
||||
|
||||
To create a new external storage mount, select an available backend from the
|
||||
|
|
@ -55,7 +55,7 @@ re-check your configuration and network availability.
|
|||
If there is an error on the storage, it will be marked as unavailable for ten
|
||||
minutes. To re-check it, click the colored icon or reload your Admin page.
|
||||
|
||||
User and Group Permissions
|
||||
User and group permissions
|
||||
--------------------------
|
||||
|
||||
A storage configured in a user's Personal settings is available only to the user
|
||||
|
|
@ -68,7 +68,7 @@ the **Available for** field.
|
|||
|
||||
.. _external_storage_mount_options_label:
|
||||
|
||||
Mount Options
|
||||
Mount options
|
||||
-------------
|
||||
|
||||
Hover your cursor to the right of any storage configuration to expose
|
||||
|
|
@ -90,7 +90,7 @@ and the previous shares become available again. Sharing is disabled by default.
|
|||
.. figure:: external_storage/images/mount_options.png
|
||||
:alt: Additional mount options exposed on mouseover.
|
||||
|
||||
Using Self-Signed Certificates
|
||||
Using self-signed certificates
|
||||
------------------------------
|
||||
|
||||
When using self-signed certificates for external storage mounts the certificate
|
||||
|
|
@ -122,7 +122,7 @@ may provide their own backends, which are not listed here.
|
|||
.. note:: A non-blocking or correctly configured SELinux setup is needed
|
||||
for these backends to work. Please refer to the :ref:`selinux-config-label`.
|
||||
|
||||
Allow Users to Mount External Storage
|
||||
Allow users to mount external Storage
|
||||
-------------------------------------
|
||||
|
||||
Check **Enable User External Storage** to allow your users to mount their own
|
||||
|
|
@ -133,7 +133,7 @@ on your network!
|
|||
.. figure:: external_storage/images/user_mounts.png
|
||||
:alt: Checkboxes to allow users to mount external storage services.
|
||||
|
||||
Adding Files to External Storages
|
||||
Adding files to external storages
|
||||
---------------------------------
|
||||
|
||||
We recommend configuring the background job **Webcron** or
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ is a few steps on the originating server.
|
|||
|
||||
You may disconnect the share at any time by clicking the trash can icon.
|
||||
|
||||
Configuring Trusted Nextcloud Servers
|
||||
Configuring trusted Nextcloud servers
|
||||
-------------------------------------
|
||||
|
||||
You may create a list of trusted Nextcloud servers for Federation sharing. This
|
||||
|
|
@ -66,7 +66,7 @@ exchanged. A red light means the connection failed.
|
|||
|
||||
.. _label-public-link-share:
|
||||
|
||||
Creating Federation Shares via Public Link Share
|
||||
Creating Federation Shares via public Link Share
|
||||
------------------------------------------------
|
||||
|
||||
Check the ``Share Link`` checkbox to expose more sharing options (which are
|
||||
|
|
@ -97,7 +97,7 @@ federated cloud share link by clicking the **Add remote share** button.
|
|||
Un-check the ``Share Link`` checkbox to disable any federated cloud share
|
||||
created this way.
|
||||
|
||||
Configuration Tips
|
||||
Configuration tips
|
||||
------------------
|
||||
|
||||
The Sharing section on your Admin page allows you to control how your users
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ Configure your sharing policy on your Admin page in the Sharing section.
|
|||
|
||||
.. _transfer_userfiles_label:
|
||||
|
||||
Transferring Files to Another User
|
||||
Transferring files to another user
|
||||
----------------------------------
|
||||
|
||||
You may transfer files from one user to another with ``occ``. This is useful
|
||||
|
|
@ -77,7 +77,7 @@ Trashbin contents are not transferred::
|
|||
(See :doc:`../configuration_server/occ_command` for a complete ``occ``
|
||||
reference.)
|
||||
|
||||
Creating Persistent File Shares
|
||||
Creating persistent file Shares
|
||||
-------------------------------
|
||||
|
||||
When a user is deleted, their files are also deleted. As you can imagine, this
|
||||
|
|
@ -96,7 +96,7 @@ edits them.
|
|||
|
||||
.. _password_policy_label:
|
||||
|
||||
Share Link Password Policy
|
||||
Share link password policy
|
||||
--------------------------
|
||||
|
||||
Nextcloud users have the option of enabling the Share Link Password
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===================================
|
||||
Controlling File Versions and Aging
|
||||
Controlling file versions and aging
|
||||
===================================
|
||||
|
||||
The Versions app (files_versions) expires old file versions automatically to
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Transactional File Locking
|
||||
Transactional file locking
|
||||
==========================
|
||||
|
||||
Nextcloud's Transactional File Locking mechanism locks files to avoid
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===========================
|
||||
File Sharing and Management
|
||||
File sharing and management
|
||||
===========================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Previews Configuration
|
||||
Previews configuration
|
||||
======================
|
||||
|
||||
The Nextcloud thumbnail system generates previews of files for all
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
====================
|
||||
Mimetypes Management
|
||||
Mimetypes management
|
||||
====================
|
||||
|
||||
Mimetype Aliases
|
||||
Mimetype aliases
|
||||
----------------
|
||||
|
||||
Nextcloud allows you to create aliases for mimetypes, so that you can display
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============================
|
||||
Configuring the Activity App
|
||||
Configuring the activity app
|
||||
============================
|
||||
|
||||
You can configure your Nextcloud server to automatically send out e-mail notifications
|
||||
|
|
@ -13,13 +13,13 @@ to your users for various events like:
|
|||
Users can see actions (delete, add, modify) that happen to files they have access to.
|
||||
Sharing actions are only visible to the sharer and sharee.
|
||||
|
||||
Enabling the Activity App
|
||||
Enabling the activity app
|
||||
-------------------------
|
||||
|
||||
The Activity App is shipped and enabled by default. If it is not enabled
|
||||
simply go to your Nextcloud Apps page to enable it.
|
||||
|
||||
Configuring your Nextcloud for the Activity App
|
||||
Configuring your Nextcloud for the activity app
|
||||
-----------------------------------------------
|
||||
|
||||
To configure your Nextcloud to send out e-mail notifications a working
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
========================================
|
||||
Configuring the ClamAV Antivirus Scanner
|
||||
Configuring the ClamAV antivirus scanner
|
||||
========================================
|
||||
|
||||
You can configure your Nextcloud server to automatically run a virus scan on
|
||||
|
|
@ -75,7 +75,7 @@ the ``clamd`` service file and start ``clamd``::
|
|||
That should take care of everything. Enable verbose logging in ``scan.conf``
|
||||
and ``freshclam.conf`` until it is running the way you want.
|
||||
|
||||
Enabling the Antivirus App for Files
|
||||
Enabling the antivirus app for files
|
||||
------------------------------------
|
||||
|
||||
Place the ``files_antivirus`` app into the ``apps`` directory of your Nextcloud
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=============================
|
||||
Automatic Configuration Setup
|
||||
Automatic configuration setup
|
||||
=============================
|
||||
|
||||
If you need to install Nextcloud on multiple servers, you normally do not want
|
||||
|
|
@ -25,7 +25,7 @@ When configuring parameters, you must understand that two parameters are named d
|
|||
| dbpass | dbpassword |
|
||||
+----------------+---------------+
|
||||
|
||||
Automatic Configurations Examples
|
||||
Automatic configurations examples
|
||||
---------------------------------
|
||||
|
||||
The following sections provide sample automatic configuration examples and what information is requested at the end of the configuration.
|
||||
|
|
@ -43,7 +43,7 @@ Using the following parameter settings, the "Finish setup" screen requests datab
|
|||
);
|
||||
|
||||
|
||||
SQLite Database
|
||||
SQLite database
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
|
||||
|
|
@ -57,7 +57,7 @@ Using the following parameter settings, the "Finish setup" screen requests data
|
|||
"dbtableprefix" => "",
|
||||
);
|
||||
|
||||
MySQL Database
|
||||
MySQL database
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
|
||||
|
|
@ -78,7 +78,7 @@ Using the following parameter settings, the "Finish setup" screen requests data
|
|||
creating the database user and database in advance, as described in
|
||||
:doc:`../configuration_database/linux_database_configuration`.
|
||||
|
||||
PostgreSQL Database
|
||||
PostgreSQL database
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Using the following parameter settings, the "Finish setup" screen requests data directory and admin credentials settings.
|
||||
|
|
@ -99,7 +99,7 @@ Using the following parameter settings, the "Finish setup" screen requests data
|
|||
creating the database user and database in advance, as described in
|
||||
:doc:`../configuration_database/linux_database_configuration`.
|
||||
|
||||
All Parameters
|
||||
All parameters
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Using the following parameter settings, because all parameters are already configured in the file, the Nextcloud installation skips the "Finish setup" screen.
|
||||
|
|
@ -122,4 +122,4 @@ Using the following parameter settings, because all parameters are already confi
|
|||
.. note:: Keep in mind that the automatic configuration does not eliminate the need for
|
||||
creating the database user and database in advance, as described in
|
||||
:doc:`../configuration_database/linux_database_configuration`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
========================
|
||||
Defining Background Jobs
|
||||
Defining background jobs
|
||||
========================
|
||||
A system like Nextcloud sometimes requires tasks to be done on a regular basis
|
||||
without the need for user interaction or hindering Nextcloud performance. For
|
||||
|
|
@ -26,7 +26,7 @@ You can choose between the following options:
|
|||
- Webcron
|
||||
- Cron
|
||||
|
||||
Cron Jobs
|
||||
Cron jobs
|
||||
---------
|
||||
|
||||
You can schedule cron jobs in three ways -- using AJAX, Webcron, or cron. The
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Configuring Memory Caching
|
||||
Configuring memory caching
|
||||
==========================
|
||||
|
||||
You can significantly improve your Nextcloud server performance with memory
|
||||
|
|
@ -158,24 +158,24 @@ Only "host" and "port" variables are required, the other ones are optional.
|
|||
Redis is very configurable; consult `the Redis documentation
|
||||
<http://redis.io/documentation>`_ to learn more.
|
||||
|
||||
Cache Directory Location
|
||||
Cache Directory location
|
||||
------------------------
|
||||
|
||||
The cache directory defaults to ``data/$user/cache`` where ``$user`` is the
|
||||
current user. You may use the ``'cache_path'`` directive in ``config.php``
|
||||
(See :doc:`config_sample_php_parameters`) to select a different location.
|
||||
|
||||
Recommendations Based on Type of Deployment
|
||||
Recommendations based on type of deployment
|
||||
-------------------------------------------
|
||||
|
||||
Small/Private Home Server
|
||||
Small/Private home server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Only use APCu::
|
||||
|
||||
'memcache.local' => '\OC\Memcache\APCu',
|
||||
|
||||
Small Organization, Single-server Setup
|
||||
Small organization, single-server setup
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Use APCu for local caching, Redis for file locking::
|
||||
|
|
@ -187,7 +187,7 @@ Use APCu for local caching, Redis for file locking::
|
|||
'port' => 6379,
|
||||
),
|
||||
|
||||
Large Organization, Clustered Setup
|
||||
Large organization, clustered setup
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Use Redis for everything except local memcache::
|
||||
|
|
@ -200,7 +200,7 @@ Use Redis for everything except local memcache::
|
|||
'port' => 6379,
|
||||
),
|
||||
|
||||
Additional notes for Redis vs. APCu on Memory Caching
|
||||
Additional notes for Redis vs. APCu on memory caching
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
APCu is faster at local caching than Redis. If you have enough memory, use APCu for Memory Caching
|
||||
|
|
@ -208,7 +208,7 @@ and Redis for File Locking. If you are low on memory, use Redis for both.
|
|||
|
||||
.. _install_redis_label:
|
||||
|
||||
Additional Redis Installation Help
|
||||
Additional Redis installation help
|
||||
----------------------------------
|
||||
|
||||
If your version of Mint or Ubuntu does not package the required version of
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===================================
|
||||
Custom Client Download Repositories
|
||||
Custom client download repositories
|
||||
===================================
|
||||
|
||||
You may configure the URLs to your own download repositories for your Nextcloud
|
||||
|
|
@ -24,4 +24,4 @@ When you're finished testing you can disable the environment variable::
|
|||
|
||||
unset OCC_UPDATE_URL
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===================
|
||||
Email Configuration
|
||||
Email configuration
|
||||
===================
|
||||
|
||||
Nextcloud is capable of sending password reset emails, notifying users of new
|
||||
|
|
@ -27,7 +27,7 @@ or Sendmail when your mail server is on the same machine as Nextcloud.
|
|||
drop-in Sendmail replacement such as Postfix, Exim, or Courier. All of
|
||||
these include a ``sendmail`` binary, and are freely-interchangeable.
|
||||
|
||||
Configuring an SMTP Server
|
||||
Configuring an SMTP server
|
||||
--------------------------
|
||||
|
||||
You need the following information from your mailserver administrator to
|
||||
|
|
@ -57,7 +57,7 @@ configured on your Personal page. The test message says::
|
|||
Nextcloud
|
||||
a safe home for all your data
|
||||
|
||||
Configuring PHP and Sendmail
|
||||
Configuring PHP and sendmail
|
||||
----------------------------
|
||||
|
||||
Configuring PHP or Sendmail requires only that you select one of them, and then
|
||||
|
|
@ -76,7 +76,7 @@ passing through PHP, and you can control all of your mail server options in one
|
|||
place, in your mail server configuration.
|
||||
|
||||
|
||||
Using Email Templates
|
||||
Using email templates
|
||||
---------------------
|
||||
|
||||
Another useful new feature is editable email templates. Now you can edit
|
||||
|
|
@ -131,7 +131,7 @@ tiniest coding error will break the template.
|
|||
can copy and paste them to a text editor for modification and then copy and
|
||||
paste them back to the template text box for use when you are done.
|
||||
|
||||
Setting Mail Server Parameters in config.php
|
||||
Setting mail server parameters in config.php
|
||||
--------------------------------------------
|
||||
|
||||
If you prefer, you may set your mail server parameters in ``config/config.php``.
|
||||
|
|
@ -300,7 +300,7 @@ be able to send email out of the box.
|
|||
"mail_smtpname" => "",
|
||||
"mail_smtppassword" => "",
|
||||
|
||||
Send a Test Email
|
||||
Send a test email
|
||||
-----------------
|
||||
|
||||
To test your email configuration, save your email address in your personal
|
||||
|
|
@ -426,7 +426,7 @@ using the ``telnet`` command.
|
|||
221 smtp.domain.dom closing connection
|
||||
Connection closed by foreign host.
|
||||
|
||||
Enabling Debug Mode
|
||||
Enabling debug mode
|
||||
-------------------
|
||||
|
||||
If you are unable to send email, it might be useful to activate further debug
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Linking External Sites
|
||||
Linking external sites
|
||||
======================
|
||||
|
||||
You can embed external websites or documents inside your Nextcloud pages with the External
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============================
|
||||
Hardening and Security Guidance
|
||||
Hardening and security guidance
|
||||
===============================
|
||||
|
||||
Nextcloud aims to ship with secure defaults that do not need to get modified by
|
||||
|
|
@ -12,7 +12,7 @@ in a Linux environment.
|
|||
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
|
||||
Limit on password length
|
||||
------------------------
|
||||
|
||||
Nextcloud uses the bcrypt algorithm, and thus for security and performance
|
||||
|
|
@ -172,7 +172,7 @@ 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
|
||||
Serve security related headers by the Web server
|
||||
------------------------------------------------
|
||||
|
||||
Basic security headers are served by Nextcloud already in a default environment.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
====================
|
||||
Server Configuration
|
||||
Server configuration
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============================
|
||||
Knowledge Base Configuration
|
||||
Knowledge base configuration
|
||||
============================
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Language Configuration
|
||||
Language configuration
|
||||
======================
|
||||
|
||||
Default language
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=====================
|
||||
Logging Configuration
|
||||
Logging configuration
|
||||
=====================
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=====================
|
||||
Using the occ Command
|
||||
Using the occ command
|
||||
=====================
|
||||
|
||||
Nextcloud's ``occ`` command (origins from "ownCloud Console") is Nextcloud's command-line
|
||||
|
|
@ -12,7 +12,7 @@ setting, and more.
|
|||
run it as your HTTP user** to ensure that the correct permissions are maintained
|
||||
on your Nextcloud files and directories.
|
||||
|
||||
occ Command Directory
|
||||
occ command Directory
|
||||
---------------------
|
||||
|
||||
* :ref:`http_user_label`
|
||||
|
|
@ -41,7 +41,7 @@ occ Command Directory
|
|||
|
||||
.. _http_user_label:
|
||||
|
||||
Run occ As Your HTTP User
|
||||
Run occ as your HTTP user
|
||||
-------------------------
|
||||
|
||||
The HTTP user is different on the various Linux distributions:
|
||||
|
|
@ -179,7 +179,7 @@ shell's profile (eg. ``~/.bash_profile`` or ``~/.zshrc``).
|
|||
|
||||
.. _apps_commands_label:
|
||||
|
||||
Apps Commands
|
||||
Apps commands
|
||||
-------------
|
||||
|
||||
The ``app`` commands list, enable, and disable apps::
|
||||
|
|
@ -234,7 +234,7 @@ You can get the full filepath to an app::
|
|||
|
||||
.. _background_jobs_selector_label:
|
||||
|
||||
Background Jobs Selector
|
||||
Background jobs selector
|
||||
------------------------
|
||||
|
||||
Use the ``background`` command to select which scheduler you want to use for
|
||||
|
|
@ -260,7 +260,7 @@ See :doc:`../configuration_server/background_jobs_configuration` to learn more.
|
|||
|
||||
.. _config_commands_label:
|
||||
|
||||
Config Commands
|
||||
Config commands
|
||||
---------------
|
||||
|
||||
The ``config`` commands are used to configure the Nextcloud server::
|
||||
|
|
@ -304,7 +304,7 @@ It is also possible to import remote files, by piping the input::
|
|||
directly. Use the ``occ app:enable``, ``occ app:disable`` and ``occ update``
|
||||
commands instead.
|
||||
|
||||
Getting a Single Configuration Value
|
||||
Getting a single configuration value
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
These commands get the value of a single app or system configuration::
|
||||
|
|
@ -315,7 +315,7 @@ These commands get the value of a single app or system configuration::
|
|||
sudo -u www-data php occ config:app:get activity installed_version
|
||||
2.2.1
|
||||
|
||||
Setting a Single Configuration Value
|
||||
Setting a single configuration value
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
These commands set the value of a single app or system configuration::
|
||||
|
|
@ -352,7 +352,7 @@ When you want to e.g. disable the maintenance mode run the following command::
|
|||
Nextcloud is in maintenance mode - no app have been loaded
|
||||
System config value maintenance set to boolean false
|
||||
|
||||
Setting an array Configuration Value
|
||||
Setting an array configuration value
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Some configurations (e.g. the trusted domain setting) are an array of data.
|
||||
|
|
@ -376,7 +376,7 @@ set::
|
|||
nextcloud.local
|
||||
example.com
|
||||
|
||||
Deleting a Single Configuration Value
|
||||
Deleting a single configuration value
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
These commands delete the configuration of an app or system configuration::
|
||||
|
|
@ -398,7 +398,7 @@ before. If you want to be notified in that case, set the
|
|||
|
||||
.. _dav_label:
|
||||
|
||||
Dav Commands
|
||||
Dav commands
|
||||
------------
|
||||
|
||||
A set of commands to create addressbooks, calendars, and to
|
||||
|
|
@ -457,7 +457,7 @@ addressbook::
|
|||
|
||||
.. _database_conversion_label:
|
||||
|
||||
Database Conversion
|
||||
Database conversion
|
||||
-------------------
|
||||
|
||||
The SQLite database is good for testing, and for Nextcloud servers with small
|
||||
|
|
@ -568,7 +568,7 @@ See :doc:`../configuration_files/encryption_configuration` to learn more.
|
|||
|
||||
.. _federation_sync_label:
|
||||
|
||||
Federation Sync
|
||||
Federation sync
|
||||
---------------
|
||||
|
||||
.. note::
|
||||
|
|
@ -588,7 +588,7 @@ to synchronize federated servers::
|
|||
|
||||
.. _file_operations_label:
|
||||
|
||||
File Operations
|
||||
File operations
|
||||
---------------
|
||||
|
||||
``occ`` has three commands for managing files in Nextcloud::
|
||||
|
|
@ -658,7 +658,7 @@ before removing a user::
|
|||
|
||||
.. _files_external_label:
|
||||
|
||||
Files External
|
||||
Files external
|
||||
--------------
|
||||
|
||||
.. note::
|
||||
|
|
@ -692,7 +692,7 @@ and to copy external mount configurations to another Nextcloud server.
|
|||
|
||||
.. _integrity_check_label:
|
||||
|
||||
Integrity Check
|
||||
Integrity check
|
||||
---------------
|
||||
|
||||
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::
|
||||
|
|
@ -721,7 +721,7 @@ See :doc:`../issues/code_signing` to learn more.
|
|||
|
||||
.. _create_javascript_translation_files_label:
|
||||
|
||||
l10n, Create Javascript Translation Files for Apps
|
||||
l10n, create JavaScript translation files for apps
|
||||
--------------------------------------------------
|
||||
|
||||
This command is for app developers to update their translation mechanism from
|
||||
|
|
@ -729,7 +729,7 @@ ownCloud 7 to Nextcloud.
|
|||
|
||||
.. _ldap_commands_label:
|
||||
|
||||
LDAP Commands
|
||||
LDAP commands
|
||||
-------------
|
||||
|
||||
.. note::
|
||||
|
|
@ -828,7 +828,7 @@ documented in :doc:`../configuration_user/user_auth_ldap_cleanup`.
|
|||
|
||||
.. _logging_commands_label:
|
||||
|
||||
Logging Commands
|
||||
Logging commands
|
||||
----------------
|
||||
|
||||
These commands view and configure your Nextcloud logging preferences::
|
||||
|
|
@ -856,7 +856,7 @@ are ``owncloud``, ``Warning``, and ``UTC``. Available options are:
|
|||
|
||||
.. _maintenance_commands_label:
|
||||
|
||||
Maintenance Commands
|
||||
Maintenance commands
|
||||
--------------------
|
||||
|
||||
Use these commands when you upgrade Nextcloud, manage encryption, perform
|
||||
|
|
@ -955,7 +955,7 @@ This example removes the deleted files of users molly and freda::
|
|||
|
||||
.. _user_commands_label:
|
||||
|
||||
User Commands
|
||||
User commands
|
||||
-------------
|
||||
|
||||
The ``user`` commands create and remove users, reset passwords, display a simple
|
||||
|
|
@ -1113,7 +1113,7 @@ You can delete versions for specific users in a space-delimited list::
|
|||
|
||||
.. _command_line_installation_label:
|
||||
|
||||
Command Line Installation
|
||||
Command line installation
|
||||
-------------------------
|
||||
|
||||
These commands are available only after you have downloaded and unpacked the
|
||||
|
|
@ -1202,7 +1202,7 @@ Supported databases are::
|
|||
|
||||
.. _command_line_upgrade_label:
|
||||
|
||||
Command Line Upgrade
|
||||
Command line upgrade
|
||||
--------------------
|
||||
|
||||
These commands are available only after you have downloaded upgraded packages or
|
||||
|
|
@ -1276,7 +1276,7 @@ or to use in a bug report::
|
|||
|
||||
.. _two_factor_auth_label:
|
||||
|
||||
Two-factor Authentication
|
||||
Two-factor authentication
|
||||
-------------------------
|
||||
If a two-factor provider app is enabled, it is enabled for all users by default
|
||||
(though the provider can decide whether or not the user has to pass the challenge).
|
||||
|
|
@ -1292,7 +1292,7 @@ To re-enable two-factor auth again use the following commmand::
|
|||
|
||||
.. _disable_user_label:
|
||||
|
||||
Disable Users
|
||||
Disable users
|
||||
-------------
|
||||
Admins can disable users via the occ command too::
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
===========================
|
||||
Reverse Proxy Configuration
|
||||
Reverse proxy configuration
|
||||
===========================
|
||||
|
||||
Nextcloud can be run through a reverse proxy, which can cache static assets such
|
||||
as images, CSS or JS files, move the load of handling HTTPS to a different
|
||||
server or load balance between multiple servers.
|
||||
|
||||
Defining Trusted Proxies
|
||||
Defining trusted proxies
|
||||
------------------------
|
||||
|
||||
For security, you must explicitly define the proxy servers that Nextcloud is to
|
||||
|
|
@ -29,7 +29,7 @@ to spoof their IP address as visible to Nextcloud, even when going through the
|
|||
trusted proxy! The correct value for this parameter is dependent on your
|
||||
proxy software.
|
||||
|
||||
Overwrite Parameters
|
||||
Overwrite parameters
|
||||
--------------------
|
||||
|
||||
The automatic hostname, protocol or webroot detection of Nextcloud can fail in
|
||||
|
|
@ -53,7 +53,7 @@ access.
|
|||
Example
|
||||
-------
|
||||
|
||||
Multiple Domains Reverse SSL Proxy
|
||||
Multiple domains reverse SSL proxy
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you want to access your Nextcloud installation **http://domain.tld/nextcloud**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Warnings on Admin Page
|
||||
Warnings on admin page
|
||||
======================
|
||||
|
||||
Your Nextcloud server has a built-in configuration checker, and it reports its
|
||||
|
|
@ -14,7 +14,7 @@ IP addresses in the past to try and reach out to `extremely outdated systems <ht
|
|||
and might again in the future. Please, protect your privacy and keep your server
|
||||
up to date! Privacy means little without security.
|
||||
|
||||
Cache Warnings
|
||||
Cache warnings
|
||||
--------------
|
||||
|
||||
"No memory cache has been configured. To enhance your performance please
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=============
|
||||
Server Tuning
|
||||
Server tuning
|
||||
=============
|
||||
|
||||
Using cron to perform background jobs
|
||||
|
|
@ -29,7 +29,7 @@ configure Nextcloud for MySQL or MariaDB. If your installation is already runnin
|
|||
SQLite then it is possible to convert to MySQL or MariaDB using the steps provided
|
||||
in :doc:`../configuration_database/db_conversion`.
|
||||
|
||||
Using Redis-based Transactional File Locking
|
||||
Using Redis-based transactional file locking
|
||||
--------------------------------------------
|
||||
|
||||
File locking is enabled by default, using the database locking backend. This
|
||||
|
|
@ -37,7 +37,7 @@ places a significant load on your database. See the section
|
|||
:doc:`../configuration_files/files_locking_transactional` for how to
|
||||
configure Nextcloud to use Redis-based Transactional File Locking.
|
||||
|
||||
SSL / Encryption App
|
||||
SSL / encryption app
|
||||
--------------------
|
||||
|
||||
SSL (HTTPS) and file encryption/decryption can be offloaded to a processor's
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Configuring Single-Sign-On
|
||||
Configuring single-sign-on
|
||||
==========================
|
||||
|
||||
Using the SSO & SAML app of your Nextcloud you can make it easily possible to integrate your existing Single-Sign-On
|
||||
|
|
@ -66,4 +66,4 @@ would protect the login route:
|
|||
|
||||
|
||||
.. warning:: If this authentication approach is used clients do require an application specific password for authentication.
|
||||
A better integration into our desktop and mobile clients is considered for the future though.
|
||||
A better integration into our desktop and mobile clients is considered for the future though.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
================================
|
||||
Using Third Party PHP Components
|
||||
Using third party PHP components
|
||||
================================
|
||||
|
||||
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
|
||||
Managing third party parameters
|
||||
-------------------------------
|
||||
|
||||
When using third party components, keep the following parameters in mind:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============
|
||||
User Management
|
||||
User management
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
========================
|
||||
Instruction Set For Apps
|
||||
Instruction set for apps
|
||||
========================
|
||||
|
||||
Getlist of apps
|
||||
|
|
@ -25,7 +25,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled``
|
||||
* Gets enabled apps
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -64,7 +64,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files``
|
||||
* Get app info for the ``files`` app
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -118,7 +118,7 @@ Example
|
|||
* POST ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor``
|
||||
* Enable the ``files_texteditor`` app
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -152,7 +152,7 @@ Example
|
|||
* DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor``
|
||||
* Disable the ``files_texteditor`` app
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Instruction Set For Groups
|
||||
Instruction set for groups
|
||||
==========================
|
||||
|
||||
Search/get groups
|
||||
|
|
@ -25,7 +25,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm``
|
||||
* Returns list of groups matching the search string.
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -68,7 +68,7 @@ Example
|
|||
groupid="newgroup"``
|
||||
* Adds a new group called ``newgroup``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -102,7 +102,7 @@ Example
|
|||
* POST ``http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin``
|
||||
* Returns a list of users in the ``admin`` group
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -143,7 +143,7 @@ Example
|
|||
``https://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup/subadmins``
|
||||
* Return the subadmins of the group: ``mygroup``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -182,7 +182,7 @@ Example
|
|||
* DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup``
|
||||
* Delete the group ``mygroup``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=========================
|
||||
Instruction Set For Users
|
||||
Instruction set for users
|
||||
=========================
|
||||
|
||||
Add a new user
|
||||
|
|
@ -28,7 +28,7 @@ Example
|
|||
userid="Frank" -d password="frankspassword"``
|
||||
* Creates the user ``Frank`` with password ``frankspassword``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -66,7 +66,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank``
|
||||
* Returns list of users matching the search string.
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -104,7 +104,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank``
|
||||
* Returns information on the user ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -173,7 +173,7 @@ Examples
|
|||
key="quota" -d value="100MB"``
|
||||
* Updates the quota for the user ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -208,7 +208,7 @@ Example
|
|||
* PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable``
|
||||
* Disables the user ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -244,7 +244,7 @@ Example
|
|||
* PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable``
|
||||
* Enables the user ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -280,7 +280,7 @@ Example
|
|||
* DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank``
|
||||
* Deletes the user ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -314,7 +314,7 @@ Example
|
|||
* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups``
|
||||
* Retrieves a list of groups of which ``Frank`` is a member
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -360,7 +360,7 @@ Example
|
|||
-d groupid="newgroup"``
|
||||
* Adds the user ``Frank`` to the group ``newgroup``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -402,7 +402,7 @@ Example
|
|||
groupid="newgroup"``
|
||||
* Removes the user ``Frank`` from the group ``newgroup``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -443,7 +443,7 @@ Example
|
|||
-d groupid="group"``
|
||||
* Makes the user ``Frank`` a subadmin of the ``group`` group
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -484,7 +484,7 @@ Example
|
|||
-d groupid="oldgroup"``
|
||||
* Removes ``Frank's`` subadmin rights from the ``oldgroup`` group
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -521,7 +521,7 @@ Example
|
|||
``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins``
|
||||
* Returns the groups of which ``Frank`` is a subadmin
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -560,7 +560,7 @@ Example
|
|||
``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/welcome``
|
||||
* Sends the welcome email to ``Frank``
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============================
|
||||
Resetting a Lost Admin Password
|
||||
Resetting a lost admin password
|
||||
===============================
|
||||
|
||||
The normal ways to recover a lost password are:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=========================
|
||||
Resetting a User Password
|
||||
Resetting a user password
|
||||
=========================
|
||||
|
||||
The Nextcloud login screen displays a **Wrong password. Reset it?** message
|
||||
|
|
@ -11,4 +11,4 @@ server than can handle an automatic reset::
|
|||
|
||||
'lost_password_link' => 'https://example.org/link/to/password/reset',
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=========================
|
||||
Two Factor Authentication
|
||||
Two factor authentication
|
||||
=========================
|
||||
|
||||
Starting with Nextcloud 10, it is possible to use two factor authentication
|
||||
|
|
@ -10,7 +10,7 @@ SMS 2-factor and `U2F <https://en.wikipedia.org/wiki/Universal_2nd_Factor>`_.
|
|||
Developers can `built new two-factor provider apps <https://docs.nextcloud.com/server/12/developer_manual/app/two-factor-provider.html>`_.
|
||||
.. TODO ON RELEASE: Update version number above on release
|
||||
|
||||
Enabling Two Factor Authentication
|
||||
Enabling two factor authentication
|
||||
----------------------------------
|
||||
|
||||
You can enable 2FA by installing and enabling a 2FA app like TOTP which works
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===========================================
|
||||
User Authentication with IMAP, SMB, and FTP
|
||||
User authentication with IMAP, SMB, and FTP
|
||||
===========================================
|
||||
|
||||
You may configure additional user backends
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=============================
|
||||
User Authentication with LDAP
|
||||
User authentication with LDAP
|
||||
=============================
|
||||
|
||||
Nextcloud ships with an LDAP application to allow LDAP users (including Active
|
||||
|
|
@ -44,7 +44,7 @@ The LDAP configuration panel has four tabs. A correctly completed first tab
|
|||
the configuration is correct. Hover your cursor over the fields to see some
|
||||
pop-up tooltips.
|
||||
|
||||
Server Tab
|
||||
Server tab
|
||||
^^^^^^^^^^
|
||||
|
||||
Start with the Server tab. You may configure multiple servers if you have them.
|
||||
|
|
@ -104,7 +104,7 @@ Base DN:
|
|||
|
||||
* *dc=my-company,dc=com*
|
||||
|
||||
Users Tab
|
||||
Users tab
|
||||
^^^^^^^^^
|
||||
|
||||
Use this to control which LDAP users are listed as Nextcloud users on your
|
||||
|
|
@ -142,7 +142,7 @@ x users found:
|
|||
This is an indicator that tells you approximately how many users will be
|
||||
listed in Nextcloud. The number updates automatically after any changes.
|
||||
|
||||
Login Attributes Tab
|
||||
Login attributes tab
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The settings in the Login Attributes tab determine which LDAP users can log in to
|
||||
|
|
@ -191,7 +191,7 @@ Edit LDAP Query:
|
|||
((&(objectClass=inetOrgPerson)(memberOf=cn=nextcloudusers,ou=groups,
|
||||
dc=example,dc=com)(|(uid=%uid)(mail=%uid)))
|
||||
|
||||
Groups Tab
|
||||
Groups tab
|
||||
^^^^^^^^^^
|
||||
|
||||
By default, no LDAP groups will be available in Nextcloud. The settings in the
|
||||
|
|
@ -226,7 +226,7 @@ y groups found:
|
|||
The number updates automatically after any change.
|
||||
|
||||
|
||||
Advanced Settings
|
||||
Advanced settings
|
||||
-----------------
|
||||
|
||||
The LDAP Advanced Setting section contains options that are not needed for a
|
||||
|
|
@ -240,7 +240,7 @@ The Advanced Settings are structured into three parts:
|
|||
* Directory Settings
|
||||
* Special Attributes
|
||||
|
||||
Connection Settings
|
||||
Connection settings
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: ../images/ldap-advanced-1-connection.png
|
||||
|
|
@ -296,7 +296,7 @@ operates.
|
|||
|
||||
.. _ldap_directory_settings:
|
||||
|
||||
Directory Settings
|
||||
Directory settings
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: ../images/ldap-advanced-2-directory.png
|
||||
|
|
@ -408,7 +408,7 @@ Default password policy DN:
|
|||
| *cn=default,ou=policies,dc=my-company,dc=com*
|
||||
|
||||
|
||||
Special Attributes
|
||||
Special attributes
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: ../images/ldap-advanced-3-attributes.png
|
||||
|
|
@ -448,7 +448,7 @@ In migrated Nextcloud installations the old behavior still applies, which is usi
|
|||
|
||||
sudo -u www-data php occ config:app:set user_ldap enforce_home_folder_naming_rule --value=1
|
||||
|
||||
Expert Settings
|
||||
Expert settings
|
||||
---------------
|
||||
|
||||
.. figure:: ../images/ldap-expert.png
|
||||
|
|
@ -531,7 +531,7 @@ Additional configuration options via occ
|
|||
|
||||
Few configuration settings can only be set on command line via ``occ``.
|
||||
|
||||
Attribute Update Interval
|
||||
Attribute update interval
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The LDAP backend will update user information that is used within Nextcloud
|
||||
|
|
@ -552,7 +552,7 @@ The value can be modified by::
|
|||
|
||||
A value of 0 will update it on every of the named occasions.
|
||||
|
||||
Nextcloud Avatar integration
|
||||
Nextcloud avatar integration
|
||||
----------------------------
|
||||
|
||||
Nextcloud supports user profile pictures, which are also called avatars. If a user
|
||||
|
|
@ -576,10 +576,10 @@ Nextcloud avatar replaces it.
|
|||
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
|
||||
Troubleshooting, tips and tricks
|
||||
--------------------------------
|
||||
|
||||
SSL Certificate Verification (LDAPS, TLS)
|
||||
SSL certificate verification (LDAPS, TLS)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
A common mistake with SSL certificates is that they may not be known to PHP.
|
||||
|
|
@ -598,7 +598,7 @@ 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
|
||||
memberOf / read memberof permissions
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you want to use ``memberOf`` within your filter you might need to give your
|
||||
|
|
@ -606,7 +606,7 @@ querying user the permissions to use it. For Microsoft Active Directory this
|
|||
is described `here <https://serverfault.com/questions/167371/what-permissions-are
|
||||
-required-for-enumerating-users-groups-in-active-directory/167401#167401>`_.
|
||||
|
||||
Duplicating Server Configurations
|
||||
Duplicating server configurations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In case you have a working configuration and want to create a similar one or
|
||||
|
|
@ -638,12 +638,12 @@ This error message means one of the following:
|
|||
LDAP server than what is returned. You should then enabled pagination on
|
||||
your LDAP server to import all available users.
|
||||
|
||||
Nextcloud LDAP Internals
|
||||
Nextcloud LDAP internals
|
||||
------------------------
|
||||
|
||||
Some parts of how the LDAP backend works are described here.
|
||||
|
||||
User and Group Mapping
|
||||
User and group mapping
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In Nextcloud the user or group name is used to have all relevant information in
|
||||
|
|
@ -698,7 +698,7 @@ 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.
|
||||
|
||||
Handling with Backup Server
|
||||
Handling with backup server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When Nextcloud is not able to contact the main LDAP server, Nextcloud assumes it
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
The LDAP Configuration API
|
||||
The LDAP configuration API
|
||||
==========================
|
||||
|
||||
All methods require that the "OCS-APIREQUEST" header be set to "true". Methods take an optional "format" parameter, which may be "xml" (the default) or "json".
|
||||
|
|
@ -21,7 +21,7 @@ Example
|
|||
* POST ``https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config`` -H "OCS-APIREQUEST: true"
|
||||
* Creates a new, empty configuration
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -54,7 +54,7 @@ Example
|
|||
* DELETE ``https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s02 -H "OCS-APIREQUEST: true"``
|
||||
* deletes the LDAP configuration
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -86,7 +86,7 @@ Example
|
|||
* GET ``https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s02?showPassword=1 -H "OCS-APIREQUEST: true"``
|
||||
* fetches the LDAP configuration
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -172,7 +172,7 @@ Example
|
|||
* PUT ``https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s01 -H "OCS-APIREQUEST: true" -d "configData[ldapHost]=ldap%3A%2F%2Fldap.server.tld &configData[ldapPort]=389"``
|
||||
* fetches the LDAP configuration
|
||||
|
||||
XML Output
|
||||
XML output
|
||||
^^^^^^^^^^
|
||||
|
||||
.. code-block:: xml
|
||||
|
|
@ -187,7 +187,7 @@ XML Output
|
|||
<data/>
|
||||
</ocs>
|
||||
|
||||
Configuration Keys
|
||||
Configuration keys
|
||||
------------------
|
||||
|
||||
+-------------------------------+------+----------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=================
|
||||
LDAP User Cleanup
|
||||
LDAP user cleanup
|
||||
=================
|
||||
|
||||
LDAP User Cleanup is a new feature in the ``LDAP user and group backend``
|
||||
|
|
@ -62,7 +62,7 @@ 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 Nextcloud name.
|
||||
|
||||
Deleting Local Nextcloud Users
|
||||
Deleting local Nextcloud users
|
||||
------------------------------
|
||||
|
||||
You may also use ``occ user:delete [user]`` to remove a local Nextcloud user;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============
|
||||
User Management
|
||||
User management
|
||||
===============
|
||||
|
||||
On the User management page of your Nextcloud Web UI you can:
|
||||
|
|
@ -58,7 +58,7 @@ User accounts have the following properties:
|
|||
cannot upload or sync data. You have the the option to include external
|
||||
storage in user quotas.
|
||||
|
||||
Creating a New User
|
||||
Creating a new user
|
||||
-------------------
|
||||
|
||||
To create a user account:
|
||||
|
|
@ -83,7 +83,7 @@ Admin page (see :doc:`../configuration_server/email_configuration`).
|
|||
Set the **Send email to new user**-checkbox allows you to leave the **Password**
|
||||
field empty. The user will get an activation-email to set his own password.
|
||||
|
||||
Reset a User's Password
|
||||
Reset a user's password
|
||||
-----------------------
|
||||
|
||||
You cannot recover a user's password, but you can set a new one:
|
||||
|
|
@ -97,7 +97,7 @@ If you have encryption enabled, there are special considerations for user
|
|||
password resets. Please see
|
||||
:doc:`../configuration_files/encryption_configuration`.
|
||||
|
||||
Renaming a User
|
||||
Renaming a user
|
||||
---------------
|
||||
|
||||
Each Nextcloud user has two names: a unique **Login Name** used for
|
||||
|
|
@ -111,7 +111,7 @@ To set or change a user's display name:
|
|||
* Enter the user's new display name
|
||||
|
||||
|
||||
Granting Administrator Privileges to a User
|
||||
Granting administrator privileges to a user
|
||||
-------------------------------------------
|
||||
|
||||
Nextcloud has two types of administrators: **Super Administrators** and **Group
|
||||
|
|
@ -128,7 +128,7 @@ access and modify all settings. To assign the **Super Administrators** role to
|
|||
a user, simply add them to the ``admin`` group.
|
||||
|
||||
|
||||
Managing Groups
|
||||
Managing groups
|
||||
---------------
|
||||
|
||||
You can assign new users to groups when you create them, and create new groups
|
||||
|
|
@ -136,7 +136,7 @@ when you create new users. You may also use the **Add Group** button at the top
|
|||
of the left pane to create new groups. New group members will immediately
|
||||
have access to file shares that belong to their new groups.
|
||||
|
||||
Setting Storage Quotas
|
||||
Setting Storage quotas
|
||||
----------------------
|
||||
|
||||
Click the gear on the lower left pane to set a default storage quota. This is
|
||||
|
|
@ -176,7 +176,7 @@ against quotas.
|
|||
When a user creates a public share via URL, and allows uploads, any uploaded
|
||||
files count against that user's quota.
|
||||
|
||||
Disable and Enable users
|
||||
Disable and enable users
|
||||
------------------------
|
||||
|
||||
.. figure:: ../images/users-actions.png
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
========================
|
||||
User Password Policy App
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=====================
|
||||
User Provisioning API
|
||||
User provisioning API
|
||||
=====================
|
||||
|
||||
The Provisioning API application enables a set of APIs that external systems can use to create,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=================
|
||||
Table of Contents
|
||||
Table of contents
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
====================
|
||||
Files Access Control
|
||||
Files access control
|
||||
====================
|
||||
|
||||
Nextcloud's File Access Control app enables administrators to create and
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Automated Tagging of Files
|
||||
Automated tagging of files
|
||||
==========================
|
||||
|
||||
Nextcloud's Files Automated Tagging app allows to assign collaborative tags
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==============
|
||||
File Workflows
|
||||
File workflows
|
||||
==============
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==================
|
||||
Retention of Files
|
||||
Retention of files
|
||||
==================
|
||||
|
||||
Nextcloud's Files Retention app allows to automatically delete files that
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Nextcloud server is available:
|
|||
See :doc:`../release_notes` for more information on the different Nextcloud
|
||||
editions.
|
||||
|
||||
Videos and Blogs
|
||||
Videos and blogs
|
||||
----------------
|
||||
|
||||
See the `official Nextcloud channel
|
||||
|
|
@ -29,7 +29,7 @@ on YouTube for tutorials, overviews, and conference videos.
|
|||
Visit `Nextcloud Planet <https://nextcloud.com/news/>`_ for news and developer
|
||||
blogs.
|
||||
|
||||
Target Audience
|
||||
Target audience
|
||||
---------------
|
||||
|
||||
This guide is for users who want to install, administer, and
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
============================
|
||||
Installing and Managing Apps
|
||||
Installing and managing apps
|
||||
============================
|
||||
|
||||
After installing Nextcloud, you may provide added functionality by installing
|
||||
applications.
|
||||
|
||||
Supported Apps
|
||||
Supported apps
|
||||
--------------
|
||||
|
||||
See :doc:`apps_supported` for a list of supported apps.
|
||||
|
||||
Viewing Enabled Apps
|
||||
Viewing enabled apps
|
||||
--------------------
|
||||
|
||||
During the Nextcloud installation, some apps are enabled by default. To see which
|
||||
|
|
@ -23,7 +23,7 @@ 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
|
||||
Managing apps
|
||||
-------------
|
||||
|
||||
In the Apps page you can enable or disable applications. Some apps have
|
||||
|
|
@ -31,7 +31,7 @@ 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
|
||||
Adding third party apps
|
||||
-----------------------
|
||||
|
||||
Some apps are developed and supported by Nextcloud directly. These have an
|
||||
|
|
@ -52,7 +52,7 @@ API. If they are then they will not be installed.
|
|||
<https://docs.nextcloud.org/server/12/developer_manual/app/index.html>`_.
|
||||
.. TODO ON RELEASE: Update version number above on release
|
||||
|
||||
Using Custom App Directories
|
||||
Using custom app directories
|
||||
----------------------------
|
||||
|
||||
Use the **apps_paths** array in ``config.php`` to set any custom apps directory
|
||||
|
|
@ -82,7 +82,7 @@ in that folder.
|
|||
),
|
||||
),
|
||||
|
||||
Using Your Own Appstore
|
||||
Using your own appstore
|
||||
-----------------------
|
||||
|
||||
You can enable the installation of apps from your own apps store. This requires that you
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==============
|
||||
Supported Apps
|
||||
Supported apps
|
||||
==============
|
||||
|
||||
Below is the list of apps supported for Nextcloud |version|. Supported here means that we'll accept bugreports and resolve them in these apps with regard to functionality and compatibility with Nextcloud |version|. To get access to work-arounds, long term support, priority bug fixing and custom consulting, contact Nextcloud GmbH.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============================
|
||||
Installing from Command Line
|
||||
Installing from command line
|
||||
============================
|
||||
|
||||
It is now possible to install Nextcloud entirely from the command line. This is
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Deployment Recommendations
|
||||
Deployment recommendations
|
||||
==========================
|
||||
|
||||
What is the best way to install and maintain Nextcloud? The answer to that is
|
||||
|
|
@ -8,7 +8,7 @@ particular needs and IT infrastructure. Nextcloud and the LAMP stack are
|
|||
highly-configurable, so we will present three typical scenarios and make
|
||||
best-practice recommendations for both software and hardware.
|
||||
|
||||
General Recommendations
|
||||
General recommendations
|
||||
-----------------------
|
||||
|
||||
.. note:: Whatever the size of your organization, always keep one thing in mind:
|
||||
|
|
@ -36,7 +36,7 @@ keep individual Nextcloud instances to a manageable size.
|
|||
scale better under load and limited RAM restrictions:
|
||||
http://blog.bitnami.com/2014/06/performance-enhacements-for-apache-and.html
|
||||
|
||||
Small Workgroups or Departments
|
||||
Small workgroups or departments
|
||||
-------------------------------
|
||||
|
||||
* Number of users
|
||||
|
|
@ -50,7 +50,7 @@ Small Workgroups or Departments
|
|||
interruption of service. Alternate backup scheme on other filesystems:
|
||||
nightly backups with service interruption.
|
||||
|
||||
Recommended System Requirements
|
||||
Recommended system requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
One machine running the application server, Web server, database server and
|
||||
|
|
@ -123,7 +123,7 @@ Authentication via an existing LDAP or Active Directory server.
|
|||
* Storage
|
||||
Local storage.
|
||||
|
||||
Mid-sized Enterprises
|
||||
Mid-sized enterprises
|
||||
---------------------
|
||||
|
||||
* Number of users
|
||||
|
|
@ -136,7 +136,7 @@ Mid-sized Enterprises
|
|||
Every component is fully redundant and can fail without service interruption.
|
||||
Backups without service interruption
|
||||
|
||||
Recommended System Requirements
|
||||
Recommended system requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
2 to 4 application servers.
|
||||
|
|
@ -247,7 +247,7 @@ Authentication via an existing LDAP or Active Directory server.
|
|||
Use an off-the-shelf NFS solution, such as IBM Elastic Storage or RedHat
|
||||
Ceph.
|
||||
|
||||
Large Enterprises and Service Providers
|
||||
Large enterprises and service providers
|
||||
---------------------------------------
|
||||
|
||||
* Number of users
|
||||
|
|
@ -260,7 +260,7 @@ Large Enterprises and Service Providers
|
|||
Every component is fully redundant and can fail without service interruption.
|
||||
Backups without service interruption
|
||||
|
||||
Recommended System Requirements
|
||||
Recommended system requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
4 to 20 application/Web servers.
|
||||
|
|
@ -376,7 +376,7 @@ Authentication via an existing LDAP or Active Directory server, or SAML.
|
|||
Storage or RedHAT Ceph. Optionally, an S3 compatible object store can also
|
||||
be used.
|
||||
|
||||
Hardware Considerations
|
||||
Hardware considerations
|
||||
-----------------------
|
||||
|
||||
* Solid-state drives (SSDs) for I/O.
|
||||
|
|
@ -384,7 +384,7 @@ Hardware Considerations
|
|||
* Multiple network interfaces to distribute server synchronisation and backend
|
||||
traffic across multiple subnets.
|
||||
|
||||
Single Machine / Scale-Up Deployment
|
||||
Single machine / scale-up deployment
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The single-machine deployment is widely used in the community.
|
||||
|
|
@ -404,7 +404,7 @@ Cons:
|
|||
single machine will not scale; I/O performance decreases and becomes a
|
||||
bottleneck with multiple up- and downloads, even with solid-state drives.
|
||||
|
||||
Scale-Out Deployment
|
||||
Scale-Out deployment
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Provider setup:
|
||||
|
|
@ -433,13 +433,13 @@ Cons:
|
|||
* Currently DB filecache table will grow rapidly, making migrations painful in
|
||||
case the table is altered.
|
||||
|
||||
What About Nginx / PHP-FPM?
|
||||
What about Nginx / PHP-FPM?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Could be used instead of HAproxy as the load balancer.
|
||||
But on uploads stores the whole file on disk before handing it over to PHP-FPM.
|
||||
|
||||
A Single Master DB is Single Point of Failure, Does Not Scale
|
||||
A single master DB is single point of failure, does not scale
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When master fails another slave can become master.
|
||||
|
|
@ -456,10 +456,10 @@ When Galera cluster is used as DB cluster solution, we recommend to use
|
|||
`MaxScale`_ as load balancer infront of the cluster to distribute writes to
|
||||
the master node and reads to the slaves.
|
||||
|
||||
Software Considerations
|
||||
Software considerations
|
||||
-----------------------
|
||||
|
||||
Operating System
|
||||
Operating system
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
We are dependent on distributions that offer an easy way to install the various
|
||||
|
|
@ -476,7 +476,7 @@ best option, as Nginx does not support all features necessary for enterprise
|
|||
deployments. Mod_php is recommended instead of PHP_FPM, because in scale-out
|
||||
deployments separate PHP pools are simply not necessary.
|
||||
|
||||
Relational Database
|
||||
Relational database
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
More often than not the customer already has an opinion on what database to
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
===================
|
||||
Installation Wizard
|
||||
Installation wizard
|
||||
===================
|
||||
|
||||
Quick Start
|
||||
Quick start
|
||||
-----------
|
||||
|
||||
When Nextcloud prerequisites are fulfilled and all Nextcloud files are installed,
|
||||
|
|
@ -30,7 +30,7 @@ installation and post-installation steps.
|
|||
|
||||
.. _data_directory_location_label:
|
||||
|
||||
Data Directory Location
|
||||
Data directory location
|
||||
-----------------------
|
||||
|
||||
Click **Storage and Database** to expose additional installation configuration
|
||||
|
|
@ -50,7 +50,7 @@ and must be owned by your HTTP user.
|
|||
|
||||
.. _database_choice_label:
|
||||
|
||||
Database Choice
|
||||
Database choice
|
||||
---------------
|
||||
|
||||
SQLite is the default database for Nextcloud Server and it is good only for
|
||||
|
|
@ -84,7 +84,7 @@ Now we will look at some important post-installation steps.
|
|||
|
||||
.. _trusted_domains_label:
|
||||
|
||||
Trusted Domains
|
||||
Trusted domains
|
||||
---------------
|
||||
|
||||
All URLs used to access your Nextcloud server must be whitelisted in your
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===================
|
||||
Nginx Configuration
|
||||
Nginx configuration
|
||||
===================
|
||||
|
||||
This page covers example Nginx configurations to use with running an Nextcloud
|
||||
|
|
@ -312,10 +312,10 @@ your nginx installation.
|
|||
}
|
||||
}
|
||||
|
||||
Tips and Tricks
|
||||
Tips and tricks
|
||||
---------------
|
||||
|
||||
Suppressing Log Messages
|
||||
Suppressing log messages
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you're seeing meaningless messages in your logfile, for example ``client
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
.. _selinux-config-label:
|
||||
|
||||
=====================
|
||||
SELinux Configuration
|
||||
SELinux configuration
|
||||
=====================
|
||||
|
||||
When you have SELinux enabled on your Linux distribution, you may run into
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ archive <https://nextcloud.com/install/>`_.
|
|||
|
||||
.. _vm_label:
|
||||
|
||||
Installing on Windows (Virtual Machine)
|
||||
Installing on Windows (virtual machine)
|
||||
---------------------------------------
|
||||
|
||||
If you are using Windows, the easiest way to get Nextcloud up an running is using our Virtual Machine. The VM is mainly maintainted by Tech and Me and are offered in several different versions. The main version is for VMware version 10 and comes in different sizes. The standard size is 20 GB, but you can also download a 500 GB and a 1 TB version. Tech and Me also provides a Hyper-V version for all Hyper-V users.
|
||||
|
|
@ -43,7 +43,7 @@ Of course you can also install it on other OSes than Windows and you are not lim
|
|||
|
||||
.. _snaps_label:
|
||||
|
||||
Installing via Snap Packages
|
||||
Installing via Snap packages
|
||||
----------------------------
|
||||
|
||||
A snap is a zip file containing an application together with its dependencies,
|
||||
|
|
@ -63,7 +63,7 @@ To install the Nextcloud Snap Package, run the following command in a terminal::
|
|||
|
||||
.. _prerequisites_label:
|
||||
|
||||
Prerequisites for Manual Installation
|
||||
Prerequisites for manual installation
|
||||
-------------------------------------
|
||||
|
||||
The Nextcloud .tar archive contains all of the required PHP modules. This
|
||||
|
|
@ -148,7 +148,7 @@ If ``mod_webdav`` is enabled you must disable it for Nextcloud. (See
|
|||
|
||||
.. _ubuntu_installation_label:
|
||||
|
||||
Example Installation on Ubuntu 16.04 LTS Server
|
||||
Example installation on Ubuntu 16.04 LTS server
|
||||
-----------------------------------------------
|
||||
|
||||
On a machine running a pristine Ubuntu 16.04 LTS server, you have two options:
|
||||
|
|
@ -240,7 +240,7 @@ See :ref:`db-binlog-label`.
|
|||
|
||||
.. _apache_configuration_label:
|
||||
|
||||
Apache Web Server Configuration
|
||||
Apache Web server configuration
|
||||
-------------------------------
|
||||
|
||||
On Debian, Ubuntu, and their derivatives, Apache installs with a useful
|
||||
|
|
@ -267,7 +267,7 @@ Then create a symlink to :file:`/etc/apache2/sites-enabled`::
|
|||
|
||||
ln -s /etc/apache2/sites-available/nextcloud.conf /etc/apache2/sites-enabled/nextcloud.conf
|
||||
|
||||
Additional Apache Configurations
|
||||
Additional Apache configurations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* For Nextcloud to work correctly, we need the module ``mod_rewrite``. Enable
|
||||
|
|
@ -360,7 +360,7 @@ the default site. Open a terminal and run::
|
|||
|
||||
.. _installation_wizard_label:
|
||||
|
||||
Installation Wizard
|
||||
Installation wizard
|
||||
-------------------
|
||||
|
||||
After restarting Apache you must complete your installation by running either
|
||||
|
|
@ -380,7 +380,7 @@ To use the graphical Installation Wizard see :doc:`installation_wizard`.
|
|||
|
||||
.. _selinux_tips_label:
|
||||
|
||||
SELinux Configuration Tips
|
||||
SELinux configuration tips
|
||||
--------------------------
|
||||
|
||||
See :doc:`selinux_configuration` for a suggested configuration for
|
||||
|
|
@ -388,7 +388,7 @@ SELinux-enabled distributions such as Fedora and CentOS.
|
|||
|
||||
.. _php_ini_tips_label:
|
||||
|
||||
php.ini Configuration Notes
|
||||
php.ini configuration notes
|
||||
---------------------------
|
||||
|
||||
Keep in mind that changes to ``php.ini`` may have to be configured on more than one
|
||||
|
|
@ -410,7 +410,7 @@ ini file. This can be the case, for example, for the ``date.timezone`` setting.
|
|||
|
||||
.. _php_fpm_tips_label:
|
||||
|
||||
php-fpm Configuration Notes
|
||||
php-fpm configuration notes
|
||||
---------------------------
|
||||
|
||||
**Security: Use at least PHP >= 5.6.6**
|
||||
|
|
@ -481,7 +481,7 @@ be set in the ``nextcloud/.user.ini`` file.
|
|||
|
||||
.. _other_HTTP_servers_label:
|
||||
|
||||
Other Web Servers
|
||||
Other Web servers
|
||||
-----------------
|
||||
|
||||
:doc:`nginx`
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===================
|
||||
System Requirements
|
||||
System requirements
|
||||
===================
|
||||
|
||||
Memory
|
||||
|
|
@ -9,7 +9,7 @@ Memory requirements for running an Nextcloud server are greatly variable,
|
|||
depending on the numbers of users and files, and volume of server activity.
|
||||
Nextcloud needs a minimum of 128MB RAM, and we recommend a minimum of 512MB.
|
||||
|
||||
Recommended Setup for Running Nextcloud
|
||||
Recommended setup for running Nextcloud
|
||||
---------------------------------------
|
||||
|
||||
For best performance, stability, support, and full functionality we recommend:
|
||||
|
|
@ -19,7 +19,7 @@ For best performance, stability, support, and full functionality we recommend:
|
|||
* PHP 7.0 +
|
||||
* Apache 2.4 with mod_php
|
||||
|
||||
Supported Platforms
|
||||
Supported platforms
|
||||
-------------------
|
||||
|
||||
* Server: Linux (Debian 7, SUSE Linux Enterprise Server 11 SP3 & 12,
|
||||
|
|
@ -38,7 +38,7 @@ Supported Platforms
|
|||
See :doc:`source_installation` for minimum software versions for installing
|
||||
Nextcloud.
|
||||
|
||||
Database Requirements for MySQL / MariaDB
|
||||
Database requirements for MySQL / MariaDB
|
||||
-----------------------------------------
|
||||
|
||||
The following is currently required if you're running Nextcloud together with a MySQL / MariaDB database:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============
|
||||
Code Signing
|
||||
Code signing
|
||||
============
|
||||
|
||||
.. sectionauthor:: Lukas Reschke <lukas@nextcloud.com>
|
||||
|
|
@ -16,14 +16,14 @@ updates were a significant source of errors when updating Nextcloud.
|
|||
FAQ
|
||||
---
|
||||
|
||||
Why Did Nextcloud 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
|
||||
ensuring proper upgrades.
|
||||
|
||||
Do We Lock Down Nextcloud?
|
||||
Do we lock down Nextcloud?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Nextcloud project is open source and always will be. We do not want to
|
||||
|
|
@ -32,7 +32,7 @@ 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?
|
||||
Not open source anymore?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Nextcloud project is open source and always will be. The code signing
|
||||
|
|
@ -43,14 +43,14 @@ been set to stable.
|
|||
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?
|
||||
Is code signing mandatory for apps?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Code signing is required for all applications on apps.nextcloud.com.
|
||||
|
||||
.. _code_signing_fix_warning_label:
|
||||
|
||||
Fixing Invalid Code Integrity Messages
|
||||
Fixing invalid code integrity messages
|
||||
--------------------------------------
|
||||
|
||||
A code integrity error message ("There were problems with the code integrity
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=======================
|
||||
General Troubleshooting
|
||||
General troubleshooting
|
||||
=======================
|
||||
|
||||
If you have trouble installing, configuring or maintaining Nextcloud, please
|
||||
|
|
@ -40,7 +40,7 @@ configuration report with the :ref:`occ config command
|
|||
https://docs.nextcloud.org/server/12/developer_manual/bugtracker/index.html
|
||||
.. TODO ON RELEASE: Update version number above on release
|
||||
|
||||
General Troubleshooting
|
||||
General troubleshooting
|
||||
-----------------------
|
||||
|
||||
Check the Nextcloud :doc:`../installation/system_requirements`, especially
|
||||
|
|
@ -56,7 +56,7 @@ 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.
|
||||
|
||||
Nextcloud Logfiles
|
||||
Nextcloud logfiles
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In a standard Nextcloud installation the log level is set to ``Normal``. To find
|
||||
|
|
@ -79,7 +79,7 @@ the `Firebug extension <https://getfirebug.com/>`_.
|
|||
|
||||
.. _label-phpinfo:
|
||||
|
||||
PHP Version and Information
|
||||
PHP version and information
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You will need to know your PHP version and configurations. To do this, create a
|
||||
|
|
@ -101,7 +101,7 @@ When you are finished reviewing your information you must delete
|
|||
``phpinfo.php``, or move it outside of your Web directory, because it is a
|
||||
security risk to expose such sensitive data.
|
||||
|
||||
Debugging Sync Issues
|
||||
Debugging sync issues
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. warning:: The data directory on the server is exclusive to Nextcloud and must
|
||||
|
|
@ -232,7 +232,7 @@ There is also a well maintained FAQ thread available at the `ownCloud Forums
|
|||
<https://forum.owncloud.org/viewtopic.php?f=17&t=7536>`_
|
||||
which contains various additional information about WebDAV problems.
|
||||
|
||||
Troubleshooting Contacts & Calendar
|
||||
Troubleshooting contacts & calendar
|
||||
-----------------------------------
|
||||
|
||||
.. _service-discovery-label:
|
||||
|
|
@ -283,7 +283,7 @@ instead of e.g.
|
|||
There are also several techniques to remedy this, which are described extensively at
|
||||
the `Sabre DAV website <http://sabre.io/dav/service-discovery/>`_.
|
||||
|
||||
Unable to update Contacts or Events
|
||||
Unable to update contacts or events
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you get an error like:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==========================
|
||||
Issues and Troubleshooting
|
||||
Issues and troubleshooting
|
||||
==========================
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -7,4 +7,4 @@ Issues and Troubleshooting
|
|||
|
||||
general_troubleshooting
|
||||
code_signing
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ To backup an Nextcloud installation there are four main things you need to retai
|
|||
#. The database
|
||||
#. The theme folder
|
||||
|
||||
Backup Folders
|
||||
Backup folders
|
||||
--------------
|
||||
|
||||
Simply copy your config, data and theme folders (or even your whole Nextcloud install and data folder) to a place outside of
|
||||
|
|
@ -17,7 +17,7 @@ your Nextcloud environment. You could use this command::
|
|||
|
||||
rsync -Aax nextcloud/ nextcloud-dirbkp_`date +"%Y%m%d"`/
|
||||
|
||||
Backup Database
|
||||
Backup database
|
||||
---------------
|
||||
|
||||
.. warning:: Before restoring a backup see :doc:`restore`
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
================
|
||||
Upgrade Manually
|
||||
Upgrade manually
|
||||
================
|
||||
|
||||
Always start by making a fresh backup and disabling all 3rd party apps.
|
||||
|
|
@ -59,7 +59,7 @@ verify the version number. Check your other settings to make sure they're
|
|||
correct. Go to the Apps page and review the core apps to make sure the right
|
||||
ones are enabled. Re-enable your third-party apps.
|
||||
|
||||
Previous Nextcloud Releases
|
||||
Previous Nextcloud releases
|
||||
---------------------------
|
||||
|
||||
You'll find previous Nextcloud releases in the `Nextcloud Server Changelog
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============================
|
||||
Migrating to a Different Server
|
||||
Migrating to a different server
|
||||
===============================
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
====================
|
||||
Upgrade via Packages
|
||||
Upgrade via packages
|
||||
====================
|
||||
|
||||
Upgrade Quickstart
|
||||
Upgrade quickstart
|
||||
------------------
|
||||
|
||||
One effective, if unofficial method for keeping Nextcloud current on Linux servers is by configuring
|
||||
|
|
@ -51,7 +51,7 @@ using Snappy Base 16.04 as it's currently unreleased.
|
|||
<maintenance_commands_label>`.
|
||||
* Re-enable third-party apps.
|
||||
|
||||
Upgrade Tips
|
||||
Upgrade tips
|
||||
------------
|
||||
|
||||
Upgrading Nextcloud from a Snap is just like upgrading any snap package.
|
||||
|
|
@ -79,7 +79,7 @@ This example is for CentOS/RHEL/Fedora::
|
|||
|
||||
.. _skipped_release_upgrade_label:
|
||||
|
||||
Upgrading Across Skipped Releases
|
||||
Upgrading across skipped releases
|
||||
---------------------------------
|
||||
|
||||
It is best to update your Nextcloud installation with every new point release,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
================
|
||||
Restoring Backup
|
||||
Restoring backup
|
||||
================
|
||||
|
||||
To restore a Nextcloud installation there are four main things you need to
|
||||
|
|
@ -19,7 +19,7 @@ Permissions`` section of :doc:`../installation/installation_wizard`.
|
|||
Also make sure to run the :ref:`maintenance:data-fingerprint <maintenance_commands_label>` command
|
||||
afterwards, to ensure your sync clients can recover from the restored backup.
|
||||
|
||||
Restore Folders
|
||||
Restore folders
|
||||
---------------
|
||||
|
||||
.. note:: This guide assumes that your previous backup is called
|
||||
|
|
@ -30,7 +30,7 @@ install and data folder) to your Nextcloud environment. You could use this comma
|
|||
|
||||
rsync -Aax nextcloud-dirbkp/ nextcloud/
|
||||
|
||||
Restore Database
|
||||
Restore database
|
||||
----------------
|
||||
|
||||
.. warning:: Before restoring a backup you need to make sure to delete all existing database tables.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
==============
|
||||
How to Upgrade
|
||||
How to upgrade
|
||||
==============
|
||||
|
||||
There are three ways to upgrade your Nextcloud server:
|
||||
|
|
@ -35,7 +35,7 @@ installations may take several hours to complete the upgrade.
|
|||
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.
|
||||
|
||||
Update Notifications
|
||||
Update notifications
|
||||
--------------------
|
||||
|
||||
Nextcloud has an update notification app, that informs the administrator about
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============================
|
||||
Considerations on Monitoring
|
||||
Considerations on monitoring
|
||||
============================
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -13,7 +13,7 @@ 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.
|
||||
|
||||
Nextcloud Deployment Architecture
|
||||
Nextcloud deployment architecture
|
||||
---------------------------------
|
||||
|
||||
Before discussing how to monitor Nextcloud, it is important to understand the architecture of a
|
||||
|
|
@ -25,7 +25,7 @@ It is assumed that specific enterprise tools (monitoring, log management, etc) t
|
|||
operations are available, and that Nextcloud is simply a new target for these tools.
|
||||
|
||||
|
||||
The Important Components of Nextcloud
|
||||
The important components of Nextcloud
|
||||
-------------------------------------
|
||||
|
||||
Nextcloud is a PHP application that depends on a filesystem for file storage, and a database for storing
|
||||
|
|
@ -78,13 +78,13 @@ The load and general health of the database server or cluster has to be monitore
|
|||
All mysql vendors provide tools to monitor this.
|
||||
|
||||
|
||||
Clustered Filesystem
|
||||
Clustered filesystem
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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
|
||||
Load balancer
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
The load balancer is monitoring the health of the application servers and is distributing the traffic in
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
================================
|
||||
Scaling Across Multiple Machines
|
||||
Scaling across multiple machines
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -17,7 +17,7 @@ three main elements of an Nextcloud deployment:
|
|||
At each layer the goal is to provide the ability to scale, and providing a high
|
||||
availability while maintaining the needed level of performance.
|
||||
|
||||
Application Layer
|
||||
Application layer
|
||||
-----------------
|
||||
|
||||
For the application layer of this reference architecture we used Oracle
|
||||
|
|
@ -68,7 +68,7 @@ the IP address should one fail.
|
|||
.. Nextcloud application servers, with details to be filled in around session
|
||||
.. management upon further testing.
|
||||
|
||||
Database Layer
|
||||
Database layer
|
||||
--------------
|
||||
|
||||
For the purposes of this example, we have chosen a MySQL cluster using the NDB
|
||||
|
|
@ -98,7 +98,7 @@ following:
|
|||
In this example we have also added a second HAProxy server with Heartbeat to prevent any single point of failure.
|
||||
We have also implemented NIC bonding to load balance the traffic across multiple physical NICs.
|
||||
|
||||
Storage Layer
|
||||
Storage layer
|
||||
-------------
|
||||
|
||||
Storage was deployed using the Red Hat Storage server with the GlusterFS
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
=============
|
||||
Release Notes
|
||||
Release notes
|
||||
=============
|
||||
|
||||
Changes in Nextcloud |version|
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
.. _androidindex:
|
||||
|
||||
===============================
|
||||
Android Application Development
|
||||
Android application development
|
||||
===============================
|
||||
Nextcloud provides an official Nextcloud Android client, which gives its users
|
||||
access to their files on their Nextcloud. It also includes functionality like
|
||||
|
|
@ -10,7 +10,7 @@ automatically uploading pictures and videos to Nextcloud.
|
|||
For third party application developers, Nextcloud offers the Nextcloud Android
|
||||
library under the MIT license.
|
||||
|
||||
Android Nextcloud Client development
|
||||
Android Nextcloud client development
|
||||
------------------------------------
|
||||
|
||||
If you are interested in working on the Nextcloud Android client, you can find
|
||||
|
|
@ -21,7 +21,7 @@ setup and process of contribution is
|
|||
You might want to start with doing one or two `starter issues <https://github.com/nextcloud/android/issues?q=is%3Aopen+is%3Aissue+label%3A%22starter+issue%22>`_
|
||||
to get into the code and note our :doc:`../general/index`.
|
||||
|
||||
Nextcloud Android Library
|
||||
Nextcloud Android library
|
||||
-------------------------
|
||||
|
||||
This document will describe how to the use Nextcloud Android Library. The
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
====================
|
||||
Library Installation
|
||||
Library installation
|
||||
====================
|
||||
|
||||
Obtaining the library
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Usage is almost trivial when your app is using the AppFramework.
|
|||
|
||||
This gives your controller access to the IAppData simple filesystem of your app.
|
||||
|
||||
The Simple Filesystem
|
||||
The simple filesystem
|
||||
---------------------
|
||||
|
||||
The `IAppData` uses the simple filesystem. This is a very simplified filesystem that will allow for easy
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Background Jobs (Cron)
|
||||
Background jobs (Cron)
|
||||
======================
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The classloader is provided by Nextcloud and loads all your classes automaticall
|
|||
|
||||
.. versionadded:: 10
|
||||
|
||||
PSR-4 Autoloading
|
||||
PSR-4 autoloading
|
||||
-----------------
|
||||
|
||||
Since Nextcloud 10 there is a PSR-4 autoloader in place. The namespace **\\OCA\\MyApp**
|
||||
|
|
@ -34,7 +34,7 @@ info.xml in the following way:
|
|||
A second PSR-4 root is available when running tests. **\\OCA\\MyApp\\Tests** is
|
||||
thereby mapped to :file:`/apps/myapp/tests/`.
|
||||
|
||||
Legacy Autoloading
|
||||
Legacy autoloading
|
||||
------------------
|
||||
|
||||
The legacy classloader, deprecated since 10, is still in place and works like this:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============
|
||||
Code Signing
|
||||
Code signing
|
||||
============
|
||||
|
||||
.. sectionauthor:: Lukas Reschke <lukas@nextcloud.com>
|
||||
|
|
@ -15,14 +15,14 @@ updates were a significant source of errors when updating Nextcloud.
|
|||
FAQ
|
||||
---
|
||||
|
||||
Why Did Nextcloud 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
|
||||
ensuring proper upgrades.
|
||||
|
||||
Do We Lock Down Nextcloud?
|
||||
Do we lock down Nextcloud?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Nextcloud project is open source and always will be. We do not want to make
|
||||
|
|
@ -31,7 +31,7 @@ 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?
|
||||
Not open source anymore?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Nextcloud project is open source and always will be. The code signing
|
||||
|
|
@ -42,7 +42,7 @@ been set to stable.
|
|||
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?
|
||||
Is code signing mandatory for apps?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Code signing is required for all applications on apps.nextcloud.com.
|
||||
|
|
@ -100,7 +100,7 @@ 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
|
||||
How code signing affects apps in the app store
|
||||
----------------------------------------------
|
||||
|
||||
- Apps which have an ``official`` tag **MUST** be code signed.
|
||||
|
|
@ -108,7 +108,7 @@ How Code Signing Affects Apps in the App Store
|
|||
- 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
|
||||
How to get your app signed
|
||||
--------------------------
|
||||
|
||||
The following commands require that you have OpenSSL installed on your machine.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ If you are unfamiliar with this pattern, watch the following videos:
|
|||
|
||||
.. _dependency-injection:
|
||||
|
||||
Dependency Injection
|
||||
Dependency injection
|
||||
--------------------
|
||||
|
||||
Dependency Injection sounds pretty complicated but it just means: Don't put new dependencies in your constructor or methods but pass them in. So this:
|
||||
|
|
|
|||
|
|
@ -611,7 +611,7 @@ If you want to use a custom, lazily rendered response simply implement the inter
|
|||
|
||||
.. note:: Because this code is rendered after several usually built in helpers, you need to take care of errors and proper HTTP caching by yourself.
|
||||
|
||||
Modifying the Content Security Policy
|
||||
Modifying the content security policy
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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 <https://developer.mozilla.org/en-US/docs/Web/Security/CSP/Introducing_Content_Security_Policy>`_. However if an app relies on third-party media or other features which are forbidden by the current policy the policy can be relaxed.
|
||||
|
|
@ -858,4 +858,4 @@ A controller method that would employ brute-force protection with an action of "
|
|||
}
|
||||
return $templateResponse;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============
|
||||
Database Access
|
||||
Database access
|
||||
===============
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ Hooks available in scope **\\OC\\Group**:
|
|||
* **preCreate** (string $groupId)
|
||||
* **postCreate** (\\OC\\Group\\Group $group)
|
||||
|
||||
Filesystem Root
|
||||
Filesystem root
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Injectable from the ServerContainer by calling the method **getRootFolder()**, **getUserFolder()** or **getAppFolder()**.
|
||||
|
|
@ -161,7 +161,7 @@ Filesystem hooks available in scope **\\OC\\Files**:
|
|||
* **preRename** (\\OCP\\Files\\Node $source, \\OCP\\Files\\Node $target)
|
||||
* **postRename** (\\OCP\\Files\\Node $source, \\OCP\\Files\\Node $target)
|
||||
|
||||
Filesystem Scanner
|
||||
Filesystem scanner
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Filesystem scanner hooks available in scope **\\OC\\Files\\Utils\\Scanner**:
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@
|
|||
code_signing
|
||||
|
||||
===============
|
||||
App Development
|
||||
App development
|
||||
===============
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
||||
|
|
@ -120,7 +120,7 @@ Create database tables, run Sql queries, store/retrieve configuration informatio
|
|||
* :doc:`configuration`
|
||||
* :doc:`filesystem`
|
||||
|
||||
Authentication & Users
|
||||
Authentication & users
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Creating, deleting, updating, searching, login and logout:
|
||||
|
|
@ -138,7 +138,7 @@ Listen on events like user creation and execute code:
|
|||
|
||||
* :doc:`hooks`
|
||||
|
||||
Background Jobs
|
||||
Background jobs
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Periodically run code in the background:
|
||||
|
|
@ -173,7 +173,7 @@ Write automated tests to ensure stability and ease maintenance:
|
|||
|
||||
* :doc:`testing`
|
||||
|
||||
PHPDoc Class Documentation
|
||||
PHPDoc class documentation
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Nextcloud class and function documentation:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============
|
||||
App Metadata
|
||||
App metadata
|
||||
============
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
====================================
|
||||
Navigation and Pre-App configuration
|
||||
Navigation and pre-app configuration
|
||||
====================================
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ App store publishing
|
|||
|
||||
.. sectionauthor:: Jos Poortvliet <jospoortvliet@gmail.com>
|
||||
|
||||
The Nextcloud App Store
|
||||
The Nextcloud app store
|
||||
-----------------------
|
||||
The Nextcloud app store is built 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:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
============
|
||||
Repair Steps
|
||||
Repair steps
|
||||
============
|
||||
|
||||
Repair steps are methods which are executed by Nextcloud on certain
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============
|
||||
Database Schema
|
||||
Database schema
|
||||
===============
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ anymore, but divided into sections, where related settings forms are grouped.
|
|||
For example, in the **Sharing** section are only settings (built-in and of apps)
|
||||
related to sharing.
|
||||
|
||||
Settings Form
|
||||
Settings form
|
||||
-------------
|
||||
|
||||
For the settings form, three things are necessary:
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Download the compressed file that contains the generated app and extract it into
|
|||
|
||||
The first basic app is now available at ``http://localhost:8080/index.php/apps/yourappid/``
|
||||
|
||||
Routes & Controllers
|
||||
Routes & controllers
|
||||
--------------------
|
||||
|
||||
A typical web application consists of server side and client side code. The glue between those two parts are the URLs. In case of the notes app the following URLs will be used:
|
||||
|
|
@ -336,7 +336,7 @@ Entities are returned from so called :doc:`Mappers <database>`. Let's create one
|
|||
|
||||
.. note:: The first parent constructor parameter is the database layer, the second one is the database table and the third is the entity on which the result should be mapped onto. Insert, delete and update methods are already implemented.
|
||||
|
||||
Connect Database & Controllers
|
||||
Connect database & controllers
|
||||
------------------------------
|
||||
|
||||
The mapper which provides the database access is finished and can be passed into the controller.
|
||||
|
|
@ -671,7 +671,7 @@ 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 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
|
||||
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.
|
||||
|
|
@ -812,7 +812,7 @@ If `PHPUnit is installed <https://phpunit.de/>`_ we can run the tests inside **o
|
|||
|
||||
.. note:: You need to adjust the **ownnotes/tests/Unit/Controller/PageControllerTest** file to get the tests passing: remove the **testEcho** method since that method is no longer present in your **PageController** and do not test the user id parameters since they are not passed anymore
|
||||
|
||||
Integration Tests
|
||||
Integration tests
|
||||
-----------------
|
||||
|
||||
Integration tests are slow and need a fully working instance but make sure that our classes work well together. Instead of mocking out all classes and parameters we can decide whether to use full instances or replace certain classes. Because they are slow we don't want as many integration tests as unit tests.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
====================
|
||||
Two-factor Providers
|
||||
Two-factor providers
|
||||
====================
|
||||
|
||||
.. sectionauthor:: Christoph Wurst <christoph@owncloud.com>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
===============
|
||||
User Management
|
||||
User management
|
||||
===============
|
||||
|
||||
.. sectionauthor:: Bernhard Posselt <dev@bernhard-posselt.com>
|
||||
|
|
@ -105,7 +105,7 @@ Users can be modified by getting a user by the userId or by a search pattern. Th
|
|||
}
|
||||
}
|
||||
|
||||
User Session Information
|
||||
User session information
|
||||
------------------------
|
||||
|
||||
To login, logout or getting the currently logged in user, the UserSession has to be injected from the ServerContainer:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Code Reviews on GitHub
|
||||
Code reviews on GitHub
|
||||
======================
|
||||
|
||||
Given enough eyeballs, all bugs are shallow
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ 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 `forums`_.
|
||||
|
||||
The Labels
|
||||
The labels
|
||||
----------
|
||||
|
||||
The following list shows what the labels mean in the life-cycle and will
|
||||
|
|
@ -67,7 +67,7 @@ When can I pull?
|
|||
Who is Assigned?
|
||||
The maintainer that feels responsible for the issue.
|
||||
|
||||
To Develop
|
||||
To develop
|
||||
^^^^^^^^^^
|
||||
|
||||
Why do we have it?
|
||||
|
|
@ -115,7 +115,7 @@ When can I pull?
|
|||
Who is Assigned?
|
||||
The most active developer should assign himself.
|
||||
|
||||
To Review
|
||||
To review
|
||||
^^^^^^^^^
|
||||
|
||||
Why do we have it?
|
||||
|
|
@ -163,7 +163,7 @@ When can I pull?
|
|||
Who is Assigned?
|
||||
The most active reviewer should assign himself.
|
||||
|
||||
To Release
|
||||
To release
|
||||
^^^^^^^^^^
|
||||
|
||||
Why do we have it?
|
||||
|
|
@ -199,10 +199,10 @@ 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!
|
||||
|
||||
Other Labels
|
||||
Other labels
|
||||
------------
|
||||
|
||||
Priority Labels
|
||||
Priority labels
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
* Panic should be used with caution. It is reserved for Bugs that would result
|
||||
|
|
@ -223,21 +223,21 @@ Priority Labels
|
|||
describe the functionality as a Gherkin scenario and either fix it or assign
|
||||
it to the developer in charge of that part.
|
||||
|
||||
App Labels
|
||||
App labels
|
||||
^^^^^^^^^^
|
||||
|
||||
In the apps repository there are labels like ``app:gallery`` and
|
||||
``app:calendar``. The ``app:`` prefix is used to allow developers to filter
|
||||
issues related to a specific app.
|
||||
|
||||
Resolution Status
|
||||
Resolution status
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
* Fixed – Should be assigned to issues in to Release
|
||||
* Won’t fix – Reason is given as a comment
|
||||
* Duplicate – Corresponding bug is given in a comment (using #guthubissuenumber)
|
||||
|
||||
Misc Labels
|
||||
Misc labels
|
||||
^^^^^^^^^^^
|
||||
|
||||
* Needs info – Either from a developer or the bug reporter. This is nearly as
|
||||
|
|
@ -245,7 +245,7 @@ Misc Labels
|
|||
* L18n – A translation issue; go see our `Transifex`_
|
||||
* Junior Job – The issue is considered a good starting point to get involved in Nextcloud development
|
||||
|
||||
Milestones equal Releases
|
||||
Milestones equal releases
|
||||
-------------------------
|
||||
|
||||
Releases are planned via milestones which contain all the Enhancements and Bugs
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
======================
|
||||
Nextcloud Bug Triaging
|
||||
Nextcloud bug triaging
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue