maxkratz/documentation
1
0
Fork 0
mirror of https://github.com/maxkratz/documentation.git synced 2024-09-07 23:33:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

Revert "Fix images and alt tags, fix #621, fix #622"

Browse source
This commit is contained in:
Roeland Jago Douma 2021-04-30 13:18:44 +02:00 committed by GitHub
parent ecb873ec8c
commit eb82b93a46
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
65 changed files with 839 additions and 999 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
admin_manual/apps_management.rst
View file

@ -14,8 +14,8 @@ needs.
Apps
----
.. image:: images/apps_overview.png
:alt:
.. figure:: images/apps_overview.png
:alt: Apps page for enabling and disabling apps.
During the Nextcloud server installation, some apps are enabled by default.
To see which apps are enabled go to your Apps page.
@ -23,7 +23,7 @@ To see which apps are enabled go to your Apps page.
Those apps are supported and developed by Nextcloud GmbH directly and
have an **Featured**-tag. See :doc:`installation/apps_supported` for a list of supported apps.
.. note:: Your Nextcloud server needs to be able to communicate with
.. note:: Your Nextcloud server needs to be able to communicate with
``https://apps.nextcloud.com`` to list and download apps. Please make sure to whitelist this target in your firewall or proxy if necessary.
.. note:: To get access to work-arounds, long-term-support, priority bug fixing
@ -38,8 +38,8 @@ All apps must be licensed under AGPLv3+ or any compatible license.
Managing apps
-------------
.. image:: images/apps_store.png
:alt:
.. figure:: images/apps_store.png
:alt: App store page for installing, enabling and disabling apps.
You will see which apps are enabled, disabled and available. You'll also
see additional app bundles and filters, such as Customization, Security and
@ -117,6 +117,6 @@ To enable a self hosted apps store:
"appstoreurl" => "https://my.appstore.instance/v1",
By default the apps store is enabled and configured to use ``https://apps.nextcloud.com/api/v1`` as apps store url. Nextcloud will fetch ``apps.json`` and ``categories.json`` from there. To use the defaults again remove **appstoreenabled** and **appstoreurl** from the configuration.
By default the apps store is enabled and configured to use ``https://apps.nextcloud.com/api/v1`` as apps store url. Nextcloud will fetch ``apps.json`` and ``categories.json`` from there. To use the defaults again remove **appstoreenabled** and **appstoreurl** from the configuration.
Example: If ``categories.json`` is available at ``https://apps.nextcloud.com/api/v1/categories.json`` the apps store url is ``https://apps.nextcloud.com/api/v1``.

2
admin_manual/configuration_files/default_files_configuration.rst
View file

@ -19,12 +19,10 @@ affecting the originals.
This screenshot shows a set of photos in the ``skeleton`` directory.
.. image:: ../images/skeleton-files.png
:alt:
They appear on the user's Nextcloud Files page just like any other files.
.. image:: ../images/skeleton-files1.png
:alt:
.. note:: Overwriting the files in ``core/skeleton`` is not recommended,
because those changes will be overwritten on the next update of the Nextcloud

257
admin_manual/configuration_files/encryption_configuration.rst
View file

@ -2,82 +2,82 @@
Encryption configuration
========================
The primary purpose of the Nextcloud server-side encryption is to protect users'
files on remote storage, such as Dropbox and Google Drive, and to do it easily
The primary purpose of the Nextcloud server-side encryption is to protect users'
files on remote storage, such as Dropbox and Google Drive, and to do it easily
and seamlessly from within Nextcloud.
Server-side encryption separates encryption of local and remote storage.
This allows you to encrypt remote storage, such as Dropbox and
Google, without having to also encrypt your home storage on your Nextcloud
Server-side encryption separates encryption of local and remote storage.
This allows you to encrypt remote storage, such as Dropbox and
Google, without having to also encrypt your home storage on your Nextcloud
server.
.. note:: Nextcloud supports Authenticated Encryption for all
newly encrypted files. See https://hackerone.com/reports/108082 for more
newly encrypted files. See https://hackerone.com/reports/108082 for more
technical information about the impact.
For maximum security make sure to configure external storage with "Check for
changes: Never". This will let Nextcloud ignore new files not added via Nextcloud,
so a malicious external storage administrator could not add new files to the
storage without your knowledge. Of course, this is not wise if your external
For maximum security make sure to configure external storage with "Check for
changes: Never". This will let Nextcloud ignore new files not added via Nextcloud,
so a malicious external storage administrator could not add new files to the
storage without your knowledge. Of course, this is not wise if your external
storage is subject to legitimate external changes.
Nextcloud server-side encryption encrypts files stored on the Nextcloud server,
and files on remote storage that is connected to your Nextcloud server.
Encryption and decryption are performed on the Nextcloud server. All files sent
to remote storage will be encrypted by the Nextcloud server, and upon retrieval,
Nextcloud server-side encryption encrypts files stored on the Nextcloud server,
and files on remote storage that is connected to your Nextcloud server.
Encryption and decryption are performed on the Nextcloud server. All files sent
to remote storage will be encrypted by the Nextcloud server, and upon retrieval,
decrypted before serving them to you and anyone you have shared them with.
.. note:: Encrypting files increases their size by roughly 35%, so you must
take this into account when you are provisioning storage and setting
storage quotas. User's quotas are based on the unencrypted file size, and
.. note:: Encrypting files increases their size by roughly 35%, so you must
take this into account when you are provisioning storage and setting
storage quotas. User's quotas are based on the unencrypted file size, and
not the encrypted file size.
When files on external storage are encrypted in Nextcloud, you cannot share them
directly from the external storage services, but only through Nextcloud sharing
When files on external storage are encrypted in Nextcloud, you cannot share them
directly from the external storage services, but only through Nextcloud sharing
because the key to decrypt the data never leaves the Nextcloud server.
Nextcloud's server-side encryption generates a strong encryption key, which is
unlocked by user's passwords. Your users don't need to track an extra
password, but simply log in as they normally do. It encrypts only the contents
Nextcloud's server-side encryption generates a strong encryption key, which is
unlocked by user's passwords. Your users don't need to track an extra
password, but simply log in as they normally do. It encrypts only the contents
of files, and not filenames and directory structures.
You should regularly backup all encryption keys to prevent permanent data loss.
You should regularly backup all encryption keys to prevent permanent data loss.
The encryption keys are stored in the following directories:
``data/<user>/files_encryption``
``data/<user>/files_encryption``
Users' private keys and all other keys necessary to decrypt the users' files
``data/files_encryption``
private keys and all other keys necessary to decrypt the files stored on a
system wide external storage
When encryption is enabled, all files are encrypted and decrypted by the
When encryption is enabled, all files are encrypted and decrypted by the
Nextcloud application, and stored encrypted on your remote storage.
This protects your data on externally hosted storage. The Nextcloud
admin and the storage admin will see only encrypted files when browsing backend
storage.
This protects your data on externally hosted storage. The Nextcloud
admin and the storage admin will see only encrypted files when browsing backend
storage.
.. warning:: Encryption keys are stored only on the Nextcloud server, eliminating
exposure of your data to third-party storage providers. The encryption app
exposure of your data to third-party storage providers. The encryption app
does **not** protect your data if your Nextcloud server is compromised, and it
does not prevent Nextcloud administrators from reading user's files. This
would require client-side encryption, which this app does not provide. If
your Nextcloud server is not connected to any external storage services then
it is better to use other encryption tools, such as file-level or
whole-disk encryption.
Note also that SSL terminates at or before Apache on the Nextcloud server, and
all files will exist in an unencrypted state between the SSL connection
termination and the Nextcloud code that encrypts and decrypts files. This is
also potentially exploitable by anyone with administrator access to your
server. Read `How Nextcloud uses encryption to protect your data
does not prevent Nextcloud administrators from reading user's files. This
would require client-side encryption, which this app does not provide. If
your Nextcloud server is not connected to any external storage services then
it is better to use other encryption tools, such as file-level or
whole-disk encryption.
Note also that SSL terminates at or before Apache on the Nextcloud server, and
all files will exist in an unencrypted state between the SSL connection
termination and the Nextcloud code that encrypts and decrypts files. This is
also potentially exploitable by anyone with administrator access to your
server. Read `How Nextcloud uses encryption to protect your data
<https://nextcloud.com/blog/encryption-in-nextcloud/>`_ for more information.
Before enabling encryption
--------------------------
Plan very carefully before enabling encryption because it is not reversible via
the Nextcloud Web interface. If you lose your encryption keys your files are not
recoverable. Always have backups of your encryption keys stored in a safe
Plan very carefully before enabling encryption because it is not reversible via
the Nextcloud Web interface. If you lose your encryption keys your files are not
recoverable. Always have backups of your encryption keys stored in a safe
location, and consider enabling all recovery options.
You have more options via the ``occ`` command (see :ref:`occ_encryption_label`)
@ -87,60 +87,55 @@ You have more options via the ``occ`` command (see :ref:`occ_encryption_label`)
Enabling encryption
-------------------
Nextcloud encryption consists of two parts. The base encryption system is
enabled and disabled on your Admin page. First you must enable this, and then
select an encryption module to load. Currently the only available encryption
Nextcloud encryption consists of two parts. The base encryption system is
enabled and disabled on your Admin page. First you must enable this, and then
select an encryption module to load. Currently the only available encryption
module is the Nextcloud Default Encryption Module.
First go to the **Server-side encryption** section of your Admin page and check
First go to the **Server-side encryption** section of your Admin page and check
**Enable server-side encryption**. You have one last chance to change your mind.
.. image:: images/encryption3.png
:alt:
.. figure:: images/encryption3.png
After clicking the **Enable Encryption** button you see the message "No
encryption module loaded, please load a encryption module in the app menu", so
After clicking the **Enable Encryption** button you see the message "No
encryption module loaded, please load a encryption module in the app menu", so
go to your Apps page to enable the Nextcloud Default Encryption Module.
.. image:: images/encryption1.png
:alt:
.. figure:: images/encryption1.png
Return to your Admin page to see the Nextcloud Default Encryption
Module added to the module selector, and automatically selected. Now you must
Return to your Admin page to see the Nextcloud Default Encryption
Module added to the module selector, and automatically selected. Now you must
log out and then log back in to initialize your encryption keys.
.. image:: images/encryption14.png
:alt:
.. figure:: images/encryption14.png
When you log back in, there is a checkbox for enabling encryption on your home
storage. This is checked by default. Un-check to avoid encrypting your home
When you log back in, there is a checkbox for enabling encryption on your home
storage. This is checked by default. Un-check to avoid encrypting your home
storage.
.. image:: images/encryption15.png
:alt:
.. figure:: images/encryption15.png
Sharing encrypted files
-----------------------
After encryption is enabled your users must also log out and log back in to
generate their personal encryption keys. They will see a yellow warning banner
that says "Encryption App is enabled but your keys are not initialized, please
log-out and log-in again."
After encryption is enabled your users must also log out and log back in to
generate their personal encryption keys. They will see a yellow warning banner
that says "Encryption App is enabled but your keys are not initialized, please
log-out and log-in again."
Share owners may need to re-share files after encryption is enabled; users
trying to access the share will see a message advising them to ask the share
owner to re-share the file with them. For individual shares, un-share and
re-share the file. For group shares, share with any individuals who can't access
the share. This updates the encryption, and then the share owner can remove the
Share owners may need to re-share files after encryption is enabled; users
trying to access the share will see a message advising them to ask the share
owner to re-share the file with them. For individual shares, un-share and
re-share the file. For group shares, share with any individuals who can't access
the share. This updates the encryption, and then the share owner can remove the
individual shares.
.. image:: images/encryption9.png
:alt:
.. figure:: images/encryption9.png
Encrypting external mountpoints
-------------------------------
You and your users can encrypt individual external mountpoints. You must have
You and your users can encrypt individual external mountpoints. You must have
external storage enabled on your Admin page, and enabled for your users.
Encryption settings can be configured in the mount options for an external
@ -152,50 +147,46 @@ storage mount, see :ref:`external_storage_mount_options_label`
Enabling users file recovery keys
---------------------------------
If you lose your Nextcloud password, then you lose access to your encrypted
files. If one of your users loses their Nextcloud password their files are
unrecoverable. You cannot reset their password in the normal way; you'll see a
yellow banner warning "Please provide an admin recovery password, otherwise all
If you lose your Nextcloud password, then you lose access to your encrypted
files. If one of your users loses their Nextcloud password their files are
unrecoverable. You cannot reset their password in the normal way; you'll see a
yellow banner warning "Please provide an admin recovery password, otherwise all
user data will be lost".
To avoid all this, create a Recovery Key. Go to the Encryption section of your
To avoid all this, create a Recovery Key. Go to the Encryption section of your
Admin page and set a recovery key password.
.. image:: images/encryption10.png
:alt:
.. figure:: images/encryption10.png
Then your users have the option of enabling password recovery on their Personal
Then your users have the option of enabling password recovery on their Personal
pages. If they do not do this, then the Recovery Key won't work for them.
.. image:: images/encryption7.png
:alt:
.. figure:: images/encryption7.png
For users who have enabled password recovery, give them a new password and
recover access to their encrypted files by supplying the Recovery Key on the
For users who have enabled password recovery, give them a new password and
recover access to their encrypted files by supplying the Recovery Key on the
Users page.
.. image:: images/encryption8.png
:alt:
.. figure:: images/encryption8.png
You may change your Recovery Key password.
.. image:: images/encryption12.png
:alt:
.. figure:: images/encryption12.png
.. _occ_encryption_label:
occ encryption commands
-----------------------
If you have shell access you may use the ``occ`` command to perform encryption
operations, and you have additional options such as decryption and creating a
single master encryption key. See :ref:`encryption_label` for detailed
If you have shell access you may use the ``occ`` command to perform encryption
operations, and you have additional options such as decryption and creating a
single master encryption key. See :ref:`encryption_label` for detailed
instructions on using ``occ``.
Get the current status of encryption and the loaded encryption module::
occ encryption:status
- enabled: false
- enabled: false
- defaultModule: OC_DEFAULT_MODULE
This is equivalent to checking **Enable server-side encryption** on your Admin
@ -205,50 +196,50 @@ page::
Encryption enabled
Default module: OC_DEFAULT_MODULE
List the available encryption modules::
occ encryption:list-modules
- OC_DEFAULT_MODULE: Default encryption module [default*]
Select a different default Encryption module (currently the only available
Select a different default Encryption module (currently the only available
module is OC_DEFAULT_MODULE)::
occ encryption:set-default-module [Module ID].
occ encryption:set-default-module [Module ID].
The [module ID] is taken from the ``encryption:list-modules`` command.
Encrypt all data files for all users. For performance reasons, when you enable
encryption on a Nextcloud server only new and changed files are encrypted. This
command gives you the option to encrypt all files.
Encrypt all data files for all users. For performance reasons, when you enable
encryption on a Nextcloud server only new and changed files are encrypted. This
command gives you the option to encrypt all files.
Run ``occ``::
occ encryption:encrypt-all
You are about to start to encrypt all files stored in your Nextcloud.
It will depend on the encryption module you use which files get encrypted.
Depending on the number and size of your files this can take some time.
Please make sure that no users access their files during this process!
Do you really want to continue? (y/n)
When you type ``y`` it creates a key pair for each of your users, and then
encrypts their files, displaying progress until all user files are encrypted.
Do you really want to continue? (y/n)
When you type ``y`` it creates a key pair for each of your users, and then
encrypts their files, displaying progress until all user files are encrypted.
Decrypt all user data files, or optionally a single user::
occ encryption:decrypt-all [username]
View current location of keys::
occ encryption:show-key-storage-root
Current key storage root: default storage location (data/)
Current key storage root: default storage location (data/)
Move keys to a different folder, either locally or on a different server.
The folder must already exist, be owned by root and your HTTP group, and be
Move keys to a different folder, either locally or on a different server.
The folder must already exist, be owned by root and your HTTP group, and be
restricted to root and your HTTP group. Further the folder needs to be located
somewhere in your Nextcloud data folder, either physically, or as a mount.
somewhere in your Nextcloud data folder, either physically, or as a mount.
This example is for Ubuntu Linux. Note that the new folder is relative to your ``occ`` directory::
cd /your/nextcloud/data
@ -259,24 +250,24 @@ This example is for Ubuntu Linux. Note that the new folder is relative to your `
Start to move keys:
4 [============================]
Key storage root successfully changed to keys
Create a new master key. Use this when you have a single-sign on
infrastructure. Use this only on fresh installations with no existing data, or
on systems where encryption has not already been enabled. It is not possible to
Create a new master key. Use this when you have a single-sign on
infrastructure. Use this only on fresh installations with no existing data, or
on systems where encryption has not already been enabled. It is not possible to
disable it::
occ encryption:enable-master-key
Disabling encryption
--------------------
You may disable encryption only with ``occ``. Make sure you have backups of all
encryption keys, including users'. Put your Nextcloud server into
You may disable encryption only with ``occ``. Make sure you have backups of all
encryption keys, including users'. Put your Nextcloud server into
maintenance mode, and then disable your encryption module with this command::
occ maintenance:mode --on
occ encryption:disable
Take it out of maintenance mode when you are finished::
occ maintenance:mode --off
@ -284,10 +275,10 @@ Take it out of maintenance mode when you are finished::
Files not encrypted
-------------------
Only the data in the files in ``data/user/files`` are encrypted, and not the
Only the data in the files in ``data/user/files`` are encrypted, and not the
filenames or folder structures. These files are never encrypted:
- Existing files in the trash bin & Versions. Only new and changed files after
- Existing files in the trash bin & Versions. Only new and changed files after
encryption is enabled are encrypted.
- Existing files in Versions
- Image thumbnails from the Gallery app
@ -295,18 +286,18 @@ filenames or folder structures. These files are never encrypted:
- The search index from the full text search app
- Third-party app data
There may be other files that are not encrypted; only files that are exposed to
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
--------------------------------------
If you use an external user back-end, such as an LDAP or Samba server, and you
change a user's password on the back-end, the user will be prompted to change
their Nextcloud login to match on their next Nextcloud login. The user will need
both their old and new passwords to do this. If you have enabled the Recovery
Key then you can change a user's password in the Nextcloud Users panel to match
their back-end password, and then, of course, notify the user and give them
If you use an external user back-end, such as an LDAP or Samba server, and you
change a user's password on the back-end, the user will be prompted to change
their Nextcloud login to match on their next Nextcloud login. The user will need
both their old and new passwords to do this. If you have enabled the Recovery
Key then you can change a user's password in the Nextcloud Users panel to match
their back-end password, and then, of course, notify the user and give them
their new password.
Troubleshooting
@ -316,7 +307,7 @@ Invalid private key for encryption app
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This `issue <https://github.com/nextcloud/server/issues/8546>`_ is being worked
on. In the meantime there is a
on. In the meantime there is a
`workaround <https://github.com/nextcloud/server/issues/8546#issuecomment-514139714>`_
which unfortunately is only suitable for administrators comfortable with the
command line.

2
admin_manual/configuration_files/external_storage/amazons3.rst
View file

@ -17,7 +17,7 @@ access your S3 mount.
The ``Enable SSL`` checkbox enables HTTPS connections; using HTTPS is always
highly-recommended.
.. image:: images/amazons3.png
.. figure:: images/amazons3.png
:alt:
Optionally, you can override the hostname, port and region of your S3 server,

10
admin_manual/configuration_files/external_storage/auth_mechanisms.rst
View file

@ -9,8 +9,8 @@ mechanisms require different configuration parameters, depending on their
behavior.
.. image:: images/authentication-types.png
:alt:
.. figure:: images/authentication-types.png
:alt: Authentication types
Special mechanisms
------------------
@ -33,7 +33,7 @@ setup of the mount point.
The **Log-in credentials, save in session** mechanism uses the Nextcloud login
credentials of the user to connect to the storage. These are not stored anywhere
on the server, but rather in the user session, giving increased security.
This method has some important drawbacks, since Nextcloud has no access to the storage
This method has some important drawbacks, since Nextcloud has no access to the storage
credentials and therefore cannot perform any background tasks on the storage:
* Sharing is disabled
@ -67,5 +67,5 @@ keypair is generated by Nextcloud and the public half shown in the GUI. The keys
are generated in the SSH format, and are currently 1024 bits in length. Keys
can be regenerated with a button in the GUI.
.. image:: images/auth_rsa.png
:alt:
.. figure:: images/auth_rsa.png
:alt: Form on admin page for generating RSA keys.

28
admin_manual/configuration_files/external_storage/ftp.rst
View file

@ -4,32 +4,32 @@ FTP/FTPS
To connect to an FTP server, you will need:
* A folder name for your local mountpoint; the folder will be created if it
* A folder name for your local mountpoint; the folder will be created if it
does not exist
* The URL of the FTP server
* Port number (default: 21)
* FTP server username and password
* Remote Subfolder, the FTP directory to mount in Nextcloud. Nextcloud defaults
to the root directory. If you specify a subfolder you must leave
* Remote Subfolder, the FTP directory to mount in Nextcloud. Nextcloud defaults
to the root directory. If you specify a subfolder you must leave
off the leading slash. For example, ``public_html/images``
Your new mountpoint is available to all users by default, and you may restrict
access by entering specific users or groups in the **Available for** field.
Your new mountpoint is available to all users by default, and you may restrict
access by entering specific users or groups in the **Available for** field.
Optionally, Nextcloud can use FTPS (FTP over SSL) by checking **Secure ftps://**.
This requires additional configuration with your root certificate if the FTP
Optionally, Nextcloud can use FTPS (FTP over SSL) by checking **Secure ftps://**.
This requires additional configuration with your root certificate if the FTP
server uses a self-signed certificate.
.. image:: images/ftp.png
:alt:
.. figure:: images/ftp.png
:alt: Nextcloud GUI FTP configuration.
.. note:: The external storage ``FTP/FTPS`` needs the ``allow_url_fopen`` PHP
setting to be set to ``1``. When having connection problems make sure that it
is not set to ``0`` in your ``php.ini``. See :ref:`label-phpinfo` to learn
setting to be set to ``1``. When having connection problems make sure that it
is not set to ``0`` in your ``php.ini``. See :ref:`label-phpinfo` to learn
how to find the right ``php.ini`` file to edit.
See :doc:`../external_storage_configuration_gui` for additional mount
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
FTP uses the password authentication scheme; see :doc:`auth_mechanisms` for
FTP uses the password authentication scheme; see :doc:`auth_mechanisms` for
more information on authentication schemes.

21
admin_manual/configuration_files/external_storage/local.rst
View file

@ -4,12 +4,12 @@ Local
Local storages provide access to any directory on the Nextcloud server. Since
this is a significant security risk, Local storage can only be configured in
the Nextcloud admin settings. Non-admin users cannot create Local storage
mounts.
the Nextcloud admin settings. Non-admin users cannot create Local storage
mounts.
Use this to mount any directory on your Nextcloud server that is outside
of your Nextcloud ``data/`` directory. This directory must be readable and
writable by your HTTP server user. These ownership and permission examples
Use this to mount any directory on your Nextcloud server that is outside
of your Nextcloud ``data/`` directory. This directory must be readable and
writable by your HTTP server user. These ownership and permission examples
are on Ubuntu Linux::
sudo chown -R www-data:www-data /path/to/localdir
@ -21,19 +21,18 @@ Important: If you use consecutive commands, make sure, you are user ``www-data``
cd /path/to/localdir
mkdir data
In the **Folder name** field enter the folder name that you want to appear on
In the **Folder name** field enter the folder name that you want to appear on
your Nextcloud Files page.
In the **Configuration** field enter the full filepath of the directory you
In the **Configuration** field enter the full filepath of the directory you
want to mount.
In the **Available for** field enter the users or groups who have permission to
In the **Available for** field enter the users or groups who have permission to
access the mount. By default all users have access.
.. image:: images/local.png
:alt:
.. figure:: images/local.png
See :doc:`../external_storage_configuration_gui` for additional mount
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

30
admin_manual/configuration_files/external_storage/openstack.rst
View file

@ -2,43 +2,43 @@
OpenStack Object Storage
========================
OpenStack Object Storage is used to connect to an OpenStack Swift server, or to
Rackspace. Two authentication mechanisms are available: one is the generic
OpenStack mechanism, and the other is used exclusively for Rackspace, a provider
OpenStack Object Storage is used to connect to an OpenStack Swift server, or to
Rackspace. Two authentication mechanisms are available: one is the generic
OpenStack mechanism, and the other is used exclusively for Rackspace, a provider
of object storage that uses the OpenStack Swift protocol.
The OpenStack authentication mechanism uses the OpenStack Keystone v2
protocol. Your Nextcloud configuration needs:
* **Bucket**. This is user-defined; think of it as a subdirectory of your total
* **Bucket**. This is user-defined; think of it as a subdirectory of your total
storage. The bucket will be created if it does not exist.
* **Username** of your account.
* **Password** of your account.
* **Tenant name** of your account. (A tenant is similar to a user group.)
* **Identity Endpoint URL**, the URL to log in to your OpenStack account.
.. image:: images/openstack.png
:alt:
.. figure:: images/openstack.png
:alt: Openstack configuration.
The Rackspace authentication mechanism requires:
The Rackspace authentication mechanism requires:
* **Bucket**
* **Bucket**
* **Username**
* **API key**.
* **API key**.
You must also enter the term **cloudFiles** in the **Service name** field.
.. image:: images/rackspace.png
:alt:
.. figure:: images/rackspace.png
:alt: Openstack configuration.
It may be necessary to specify a **Region**. Your region should be named in
your account information, and you can read about Rackspace regions at
It may be necessary to specify a **Region**. Your region should be named in
your account information, and you can read about Rackspace regions at
`About Regions <https://support.rackspace.com/how-to/about-regions/>`_.
The timeout of HTTP requests is set in the **Request timeout** field, in
The timeout of HTTP requests is set in the **Request timeout** field, in
seconds.
See :doc:`../external_storage_configuration_gui` for additional mount
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

18
admin_manual/configuration_files/external_storage/sftp.rst
View file

@ -2,27 +2,27 @@
SFTP
====
Nextcloud's SFTP (SSH File Transfer Protocol) backend supports both password and
public key authentication.
Nextcloud's SFTP (SSH File Transfer Protocol) backend supports both password and
public key authentication.
The **Host** field is required; a port can be specified as part of the **Host**
field in the following format: ``hostname.domain:port``. The default port is 22
The **Host** field is required; a port can be specified as part of the **Host**
field in the following format: ``hostname.domain:port``. The default port is 22
(SSH).
For public key authentication, you can generate a public/private key pair from
For public key authentication, you can generate a public/private key pair from
your **SFTP with secret key login** configuration.
.. image:: images/auth_mechanism.png
:alt:
.. figure:: images/auth_mechanism.png
:alt: Generating an RSA key pair in the SFTP configuration.
After generating your keys, you need to copy your new public key to the
destination server to ``.ssh/authorized_keys``. Nextcloud will then use its
private key to authenticate to the SFTP server.
The default **Remote Subfolder** is the root directory (``/``) of the remote
The default **Remote Subfolder** is the root directory (``/``) of the remote
SFTP server, and you may enter any directory you wish.
See :doc:`../external_storage_configuration_gui` for additional mount
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

4
admin_manual/configuration_files/external_storage/smb.rst
View file

@ -37,8 +37,8 @@ modified. This is concatenated with the username, so the backend gets
``libsmbclient-php``, a native PHP module for connecting to
SMB servers.
.. image:: images/smb.png
:alt:
.. figure:: images/smb.png
:alt: Samba external storage configuration.
:scale: 75%
See :doc:`../external_storage_configuration_gui` for additional mount

14
admin_manual/configuration_files/external_storage/webdav.rst
View file

@ -2,7 +2,7 @@
WebDAV
======
Use this backend to mount a directory from any WebDAV server, or another
Use this backend to mount a directory from any WebDAV server, or another
Nextcloud server.
You need the following information:
@ -10,20 +10,20 @@ You need the following information:
* Folder name: The name of your local mountpoint.
* The URL of the WebDAV or Nextcloud server.
* Username and password for the remote server
* Secure https://: We always recommend https:// for security, though you can
* Secure https://: We always recommend https:// for security, though you can
leave this unchecked for http://.
Optionally, a ``Remote Subfolder`` can be specified to change the destination
directory. The default is to use the whole root.
.. image:: images/webdav.png
:alt:
.. figure:: images/webdav.png
:alt: Webdav configuration form.
.. Note:: CPanel users should install `Web Disk
<https://documentation.cpanel.net/display/ALD/Web+Disk>`_ to enable WebDAV
.. Note:: CPanel users should install `Web Disk
<https://documentation.cpanel.net/display/ALD/Web+Disk>`_ to enable WebDAV
functionality.
See :doc:`../external_storage_configuration_gui` for additional mount
See :doc:`../external_storage_configuration_gui` for additional mount
options and information.
See :doc:`auth_mechanisms` for more information on authentication schemes.

75
admin_manual/configuration_files/external_storage_configuration_gui.rst
View file

@ -2,8 +2,8 @@
Configuring External Storage (GUI)
==================================
The External Storage Support application enables you to mount external storage
services and devices as secondary Nextcloud storage devices. You may also allow
The External Storage Support application enables you to mount external storage
services and devices as secondary Nextcloud storage devices. You may also allow
users to mount their own external storage services.
For configuration of external storages via occ command, see :ref:`occ documentation <files_external_label>`.
@ -13,40 +13,39 @@ Enabling External Storage Support
The External storage support application is enabled on your Apps page.
.. image:: external_storage/images/enable-app.png
:alt:
.. figure:: external_storage/images/enable-app.png
:alt: Enable external storage on your Apps page.
Storage configuration
---------------------
To create a new external storage mount, select an available backend from the
dropdown **Add storage**. Each backend has different required options, which
dropdown **Add storage**. Each backend has different required options, which
are configured in the configuration fields.
.. image:: external_storage/images/add_storage.png
:alt:
.. figure:: external_storage/images/add_storage.png
Each backend may also accept multiple authentication methods. These are selected
with the dropdown under **Authentication**. Different backends support different
authentication mechanisms; some specific to the backend, others are more
generic. See :doc:`external_storage/auth_mechanisms` for more detailed
Each backend may also accept multiple authentication methods. These are selected
with the dropdown under **Authentication**. Different backends support different
authentication mechanisms; some specific to the backend, others are more
generic. See :doc:`external_storage/auth_mechanisms` for more detailed
information.
When you select an authentication mechanism, the configuration fields change as
appropriate for the mechanism. The SFTP backend, for one example, supports
**username and password**, **Log-in credentials, save in session**, and **RSA
When you select an authentication mechanism, the configuration fields change as
appropriate for the mechanism. The SFTP backend, for one example, supports
**username and password**, **Log-in credentials, save in session**, and **RSA
public key**.
.. image:: external_storage/images/auth_mechanism.png
:alt:
.. figure:: external_storage/images/auth_mechanism.png
:alt: An SFTP configuration example.
Required fields are marked with a red border. When all required fields are
filled, the storage is automatically saved. A green dot next to the storage row
indicates the storage is ready for use. A red or yellow icon indicates
that Nextcloud could not connect to the external storage, so you need to
Required fields are marked with a red border. When all required fields are
filled, the storage is automatically saved. A green dot next to the storage row
indicates the storage is ready for use. A red or yellow icon indicates
that Nextcloud could not connect to the external storage, so you need to
re-check your configuration and network availability.
If there is an error on the storage, it will be marked as unavailable for ten
If there is an error on the storage, it will be marked as unavailable for ten
minutes. To re-check it, click the colored icon or reload your Admin page.
Usage of variables for mount paths
@ -59,23 +58,23 @@ Use ``$user`` for automatic substitution with the logged in user's username.
Use ``$home`` for automatic substitution with a configurable home directory variable
(requires LDAP, see :ref:`LDAP_Special_Attributes` in the LDAP configuration documentation for details)
In the following example, the mount point for a logged in user "alice" would substitute
In the following example, the mount point for a logged in user "alice" would substitute
to ``/opt/userDirectories/alice/myPictures``.
.. image:: external_storage/images/externalStorages_variables.png
:alt:
.. figure:: external_storage/images/externalStorages_variables.png
:alt: External storage user variable substitution
User and group permissions
--------------------------
A storage configured in a user's Personal settings is available only to the user
that created it. A storage configured in the Admin settings is available to
all users by default, and it can be restricted to specific users and groups in
A storage configured in a user's Personal settings is available only to the user
that created it. A storage configured in the Admin settings is available to
all users by default, and it can be restricted to specific users and groups in
the **Available for** field.
.. image:: external_storage/images/applicable.png
:alt:
.. figure:: external_storage/images/applicable.png
:alt: User and groups selector
.. _external_storage_mount_options_label:
@ -100,15 +99,15 @@ encryption is not available for other Nextcloud servers used as external storage
When sharing is disabled the shares are retained internally, so that you can re-enable sharing
and the previous shares become available again. Sharing is disabled by default.
.. image:: external_storage/images/mount_options.png
:alt:
.. figure:: external_storage/images/mount_options.png
:alt: Additional mount options exposed on mouseover.
Using self-signed certificates
------------------------------
When using self-signed certificates for external storage mounts the certificate
must be imported into the personal settings of the user. Please refer to
`Nextcloud HTTPS External Mount
must be imported into the personal settings of the user. Please refer to
`Nextcloud HTTPS External Mount
<https://ownclouden.blogspot.de/2014/11/owncloud-https-external-mount.html>`_
for more information.
@ -135,13 +134,13 @@ The following backends are provided by the external storages app.
Allow users to mount external Storage
-------------------------------------
Check **Enable User External Storage** to allow your users to mount their own
external storage services, and check the backends you want to allow. Beware, as
this allows a user to make potentially arbitrary connections to other services
Check **Enable User External Storage** to allow your users to mount their own
external storage services, and check the backends you want to allow. Beware, as
this allows a user to make potentially arbitrary connections to other services
on your network!
.. image:: external_storage/images/user_mounts.png
:alt:
.. figure:: external_storage/images/user_mounts.png
:alt: Checkboxes to allow users to mount external storage services.
Adding files to external storages
---------------------------------

130
admin_manual/configuration_files/federated_cloud_sharing_configuration.rst
View file

@ -2,130 +2,122 @@
Configuring Federation Sharing
==============================
Federated Cloud Sharing is now managed by the Federation app (9.0+), and is
now called Federation sharing. When you enable the Federation app you can
easily and securely link file shares between Nextcloud servers, in effect
Federated Cloud Sharing is now managed by the Federation app (9.0+), and is
now called Federation sharing. When you enable the Federation app you can
easily and securely link file shares between Nextcloud servers, in effect
creating a cloud of Nextclouds.
.. _label-direct-share-link:
.. _label-direct-share-link:
Creating a new Federation Share
-------------------------------
Follow these steps to create a new Federation share between two Nextcloud
servers. This requires no action by the user on the remote server; all it takes
Follow these steps to create a new Federation share between two Nextcloud
servers. This requires no action by the user on the remote server; all it takes
is a few steps on the originating server.
1. Enable the Federation app.
2. Go to your Nextcloud Admin page and scroll to the Sharing
section. Verify that **Allow users on this server to send shares to other
servers** and **Allow users on this server to receive shares from other
servers** are enabled.
2. Go to your Nextcloud Admin page and scroll to the Sharing
section. Verify that **Allow users on this server to send shares to other
servers** and **Allow users on this server to receive shares from other
servers** are enabled.
3. Now go to the Federation
section. By default, **Add server automatically once a federated share was
created successfully** is checked. The Federation app supports creating a
list of trusted Nextcloud servers, which allows the trusted servers to
exchange user directories and auto-complete the names of external users when
3. Now go to the Federation
section. By default, **Add server automatically once a federated share was
created successfully** is checked. The Federation app supports creating a
list of trusted Nextcloud servers, which allows the trusted servers to
exchange user directories and auto-complete the names of external users when
you create shares. If you do not want this enabled, then un-check it.
.. image:: images/federation-0.png
:alt:
4. Now go to your Files page and select a folder to share. Click the share
icon, and then enter the username and URL of the user on the remote Nextcloud
server. In this example, that is ``freda@https://example.com/nextcloud``.
When Nextcloud verifies the link, it displays it with the **(remote)** label.
.. figure:: images/federation-0.png
4. Now go to your Files page and select a folder to share. Click the share
icon, and then enter the username and URL of the user on the remote Nextcloud
server. In this example, that is ``freda@https://example.com/nextcloud``.
When Nextcloud verifies the link, it displays it with the **(remote)** label.
Click on this label to establish the link.
.. image:: images/federation-2.png
:alt:
.. figure:: images/federation-2.png
5. When the link is successfully completed, you have a single share option,
5. When the link is successfully completed, you have a single share option,
and that is **can edit**.
.. image:: images/federation-3.png
:alt:
.. figure:: images/federation-3.png
You may disconnect the share at any time by clicking the trash can icon.
Configuring trusted Nextcloud servers
-------------------------------------
You may create a list of trusted Nextcloud servers for Federation sharing. This
allows your linked Nextcloud servers to share user directories, and to auto-fill
user names in share dialogs. If **Add server automatically once a federated
share was created successfully** is enabled on your Admin page, servers will be
You may create a list of trusted Nextcloud servers for Federation sharing. This
allows your linked Nextcloud servers to share user directories, and to auto-fill
user names in share dialogs. If **Add server automatically once a federated
share was created successfully** is enabled on your Admin page, servers will be
automatically added to your trusted list when you create new Federation shares.
You may also enter Nextcloud server URLs in the **Add Nextcloud Server** field.
The yellow light indicates a successful connection, with no user names
exchanged. The green light indicates a successful connection with user names
You may also enter Nextcloud server URLs in the **Add Nextcloud Server** field.
The yellow light indicates a successful connection, with no user names
exchanged. The green light indicates a successful connection with user names
exchanged. A red light means the connection failed.
.. image:: images/federation-1.png
:alt:
.. figure:: images/federation-1.png
.. _label-public-link-share:
Creating Federation Shares via public Link Share
------------------------------------------------
Check the ``Share link`` entry to expose more sharing options (which are
described more fully in :doc:`file_sharing_configuration`). You may create a
Federation share by allowing Nextcloud to create a public link for you, and then
Check the ``Share link`` entry to expose more sharing options (which are
described more fully in :doc:`file_sharing_configuration`). You may create a
Federation share by allowing Nextcloud to create a public link for you, and then
email it to the person you want to create the share with.
.. image:: images/create_public_share-6.png
:alt:
You may optionally set a password and expiration date on it. When your recipient
receives your email they must click the link, or copy it to a Web
browser. They will see a page displaying a thumbnail of the file, with a button
.. figure:: images/create_public_share-6.png
You may optionally set a password and expiration date on it. When your recipient
receives your email they must click the link, or copy it to a Web
browser. They will see a page displaying a thumbnail of the file, with a button
to **Add to your Nextcloud**.
.. image:: images/create_public_share-8.png
:alt:
.. figure:: images/create_public_share-8.png
Your recipient should click the **Add to your Nextcloud** button. On the next
screen your recipient needs to enter the URL to their Nextcloud
Your recipient should click the **Add to your Nextcloud** button. On the next
screen your recipient needs to enter the URL to their Nextcloud
server, and then press the return key.
.. image:: images/create_public_share-9.png
:alt:
.. figure:: images/create_public_share-9.png
Your recipient has to take one more step, and that is to confirm creating the
Your recipient has to take one more step, and that is to confirm creating the
federated cloud share link by clicking the **Accept** button.
.. image:: images/create_public_share-10.png
:alt:
.. figure:: images/create_public_share-10.png
Un-check the ``Share link`` checkbox to disable any federated cloud share
Un-check the ``Share link`` checkbox to disable any federated cloud share
created this way.
Configuration tips
------------------
The Sharing section on your Admin page allows you to control how your users
The Sharing section on your Admin page allows you to control how your users
manage federated cloud shares:
* Check ``Enforce password protection`` to require passwords on link shares.
* Check ``Set default expiration date`` to require an expiration date on link
* Check ``Set default expiration date`` to require an expiration date on link
shares.
* Check ``Allow public uploads`` to allow two-way file sharing.
Your Apache Web server must have ``mod_rewrite`` enabled, and you must have
``trusted_domains`` correctly configured in ``config.php`` to allow external
connections (see :doc:`../installation/installation_wizard`). Consider also
Your Apache Web server must have ``mod_rewrite`` enabled, and you must have
``trusted_domains`` correctly configured in ``config.php`` to allow external
connections (see :doc:`../installation/installation_wizard`). Consider also
enabling SSL to encrypt all traffic between your servers .
Your Nextcloud server creates the share link from the URL that you used to log
into the server, so make sure that you log into your server using a URL that is
accessible to your users. For example, if you log in via its LAN IP address,
such as ``http://192.168.10.50``, then your share URL will be something like
``http://192.168.10.50/nextcloud/index.php/s/jWfCfTVztGlWTJe``, which is not
accessible outside of your LAN. This also applies to using the server name; for
access outside of your LAN you need to use a fully-qualified domain name such as
Your Nextcloud server creates the share link from the URL that you used to log
into the server, so make sure that you log into your server using a URL that is
accessible to your users. For example, if you log in via its LAN IP address,
such as ``http://192.168.10.50``, then your share URL will be something like
``http://192.168.10.50/nextcloud/index.php/s/jWfCfTVztGlWTJe``, which is not
accessible outside of your LAN. This also applies to using the server name; for
access outside of your LAN you need to use a fully-qualified domain name such as
``http://myserver.example.com``, rather than ``http://myserver``.

89
admin_manual/configuration_files/file_sharing_configuration.rst
View file

@ -2,16 +2,15 @@
File Sharing
============
Nextcloud users can share files with their Nextcloud groups and other users on
the same Nextcloud server, with Nextcloud users on :doc:`other Nextcloud servers <federated_cloud_sharing_configuration>`, and create public shares for people who are not
Nextcloud users can share files with their Nextcloud groups and other users on
the same Nextcloud server, with Nextcloud users on :doc:`other Nextcloud servers <federated_cloud_sharing_configuration>`, and create public shares for people who are not
Nextcloud users. You have control of a number of user permissions on file shares.
Configure your sharing policy on your Admin page in the Sharing section.
.. image:: images/sharing-files-1.png
:alt:
.. figure:: images/sharing-files-1.png
* Check ``Allow apps to use the Share API`` to enable users to share files. If
* Check ``Allow apps to use the Share API`` to enable users to share files. If
this is not checked, no users can create file shares.
* Check ``Set default expiration date for shares`` to set a default expiration date
on local user and group shares.
@ -19,27 +18,27 @@ Configure your sharing policy on your Admin page in the Sharing section.
on local user and group shares.
.. note:: Users will not be able to set the expiration date further
in the future than the enforced expiration date, although they
in the future than the enforced expiration date, although they
will be able to set a more recent date.
Also note that users will be able to update the expiration date again at
a later point. The expiration date is based on the current date and not on the share
creation date. The user will be able to extend the expiration date again whenever a
previous expiration date is close to be reached.
* Check ``Allow users to share via link`` to enable creating public shares for
* Check ``Allow users to share via link`` to enable creating public shares for
people who are not Nextcloud users via hyperlink.
* Check ``Allow public uploads`` to allow anyone to upload files to public shares.
* Check ``Always ask for a password`` to proactively ask a user to set a password
for a share link.
* Check ``Enforce password protection`` to force users to set a password on all
* Check ``Enforce password protection`` to force users to set a password on all
public share links. This does not apply to local user and group shares.
* Check ``Set default expiration date for link shares`` to set a default expiration date on
* Check ``Set default expiration date for link shares`` to set a default expiration date on
public shares.
* Check ``Enforce expiration date`` to always enforce the configured expiration date
on public shares.
on public shares.
.. note:: Users will not be able to set the expiration date further
in the future than the enforced expiration date, although they
in the future than the enforced expiration date, although they
will be able to set a more recent date.
Also note that users will be able to update the expiration date again at
a later point. The expiration date is based on the current date and not on the share
@ -48,39 +47,39 @@ Configure your sharing policy on your Admin page in the Sharing section.
* Check ``Allow resharing`` to enable users to re-share files shared with them.
* Check ``Allow sharing with groups`` to enable users to share with groups.
* Check ``Restrict users to only share with users in their groups`` to confine
* Check ``Restrict users to only share with users in their groups`` to confine
sharing within group memberships.
.. note:: This setting does not apply to the Federated Cloud sharing
feature. If :doc:`Federated Cloud Sharing
.. note:: This setting does not apply to the Federated Cloud sharing
feature. If :doc:`Federated Cloud Sharing
<federated_cloud_sharing_configuration>` is
enabled, users can still share items with any users on any instances
(including the one they are on) via a remote share.
* Check ``Exclude groups from sharing`` to prevent members of specific groups
from creating any file shares in those groups. When you check this, you'll
get a dropdown list of all your groups to choose from. Members of excluded
* Check ``Exclude groups from sharing`` to prevent members of specific groups
from creating any file shares in those groups. When you check this, you'll
get a dropdown list of all your groups to choose from. Members of excluded
groups can still receive shares, but not create any.
* Check ``Allow username autocompletion in share dialog`` to enable
* Check ``Allow username autocompletion in share dialog`` to enable
auto-completion of Nextcloud usernames.
* Check ``Restrict username autocompletion to users within the same groups`` to limit
username autocompletion to users from within the same groups as the share owner.
* Check ``Show disclaimer text on the public link upload page`` to set and show
a disclaimer text on public links with hidden file lists.
With ``Default share permissions`` you are able to set the default permissions
With ``Default share permissions`` you are able to set the default permissions
for user-shares (``Create``, ``Change``, ``Delete`` and ``Reshare``) without
forcing them.
.. note:: Nextcloud does not preserve the mtime (modification time) of
directories, though it does update the mtimes on files. See
`Wrong folder date when syncing
.. note:: Nextcloud does not preserve the mtime (modification time) of
directories, though it does update the mtimes on files. See
`Wrong folder date when syncing
<https://github.com/owncloud/core/issues/7009>`_ for discussion of this.
.. note:: There are more sharing options on config.php level available:
.. note:: There are more sharing options on config.php level available:
:ref:`Configuration Parameters<configPHP_Sharing>`
.. _transfer_userfiles_label:
.. _transfer_userfiles_label:
Distinguish between max expiration date and default expiration date
-------------------------------------------------------------------
@ -110,34 +109,34 @@ A notification will be send for all shares which expire within the next 24 hours
Transferring files to another user
----------------------------------
You may transfer files from one user to another with ``occ``. This is useful
when you have to remove a user. Be sure to transfer the files before you delete
the user! This transfers all files from user1 to user2, and the shares and
metadata info associated with those files (shares, tags, comments, etc).
You may transfer files from one user to another with ``occ``. This is useful
when you have to remove a user. Be sure to transfer the files before you delete
the user! This transfers all files from user1 to user2, and the shares and
metadata info associated with those files (shares, tags, comments, etc).
Trashbin contents are not transferred::
occ files:transfer-ownership user1 user2
(See :doc:`../configuration_server/occ_command` for a complete ``occ``
reference.)
(See :doc:`../configuration_server/occ_command` for a complete ``occ``
reference.)
Users may also transfer files or folders selectively by themselves.
See `user documentation <https://docs.nextcloud.com/server/latest/user_manual/en/files/transfer_ownership.html>`_ for details.
Creating persistent file Shares
-------------------------------
When a user is deleted, their files are also deleted. As you can imagine, this
is a problem if they created file shares that need to be preserved, because
these disappear as well. In Nextcloud files are tied to their owners, so
When a user is deleted, their files are also deleted. As you can imagine, this
is a problem if they created file shares that need to be preserved, because
these disappear as well. In Nextcloud files are tied to their owners, so
whatever happens to the file owner also happens to the files.
One solution is to create persistent shares for your users. You can retain
ownership of them, or you could create a special user for the purpose of
establishing permanent file shares. Simply create a shared folder in the usual
way, and share it with the users or groups who need to use it. Set the
appropriate permissions on it, and then no matter which users come and go, the
file shares will remain. Because all files added to the share, or edited in it,
automatically become owned by the owner of the share regardless of who adds or
edits them.
One solution is to create persistent shares for your users. You can retain
ownership of them, or you could create a special user for the purpose of
establishing permanent file shares. Simply create a shared folder in the usual
way, and share it with the users or groups who need to use it. Set the
appropriate permissions on it, and then no matter which users come and go, the
file shares will remain. Because all files added to the share, or edited in it,
automatically become owned by the owner of the share regardless of who adds or
edits them.

30
admin_manual/configuration_files/previews_configuration.rst
View file

@ -2,13 +2,13 @@
Previews configuration
======================
The Nextcloud thumbnail system generates previews of files for all
The Nextcloud thumbnail system generates previews of files for all
Nextcloud apps that display files, such as Files and Gallery.
The following image shows some examples of previews of various file types.
.. image:: ../images/preview_images.png
:alt:
.. figure:: ../images/preview_images.png
:alt: Thumbnails of various image and audio/video files.
By default, Nextcloud can generate previews for the following filetypes:
@ -20,23 +20,23 @@ By default, Nextcloud can generate previews for the following filetypes:
of other file types such as PDF, SVG or various office documents.
Due to security concerns those providers have been disabled by
default and are considered unsupported.
While those providers are still available, we discourage enabling
While those providers are still available, we discourage enabling
them, and they are not documented.
Parameters
----------
Please notice that the Nextcloud preview system comes already with sensible
defaults, and therefore it is usually unnecessary to adjust those configuration
values.
Please notice that the Nextcloud preview system comes already with sensible
defaults, and therefore it is usually unnecessary to adjust those configuration
values.
Disabling previews:
^^^^^^^^^^^^^^^^^^^
Under certain circumstances, for example if the server has limited
resources, you might want to consider disabling the generation of previews.
Note that if you do this all previews in all apps are disabled, including
the Gallery app, and will display generic icons instead of
Under certain circumstances, for example if the server has limited
resources, you might want to consider disabling the generation of previews.
Note that if you do this all previews in all apps are disabled, including
the Gallery app, and will display generic icons instead of
thumbnails.
Set the configuration option ``enable_previews`` in config.php to ``false``:
@ -72,8 +72,8 @@ to a maximum size of 100×100px:
Maximum scale factor:
^^^^^^^^^^^^^^^^^^^^^
If a lot of small pictures are stored on the Nextcloud instance and the preview
system generates blurry previews, you might want to consider setting a maximum
If a lot of small pictures are stored on the Nextcloud instance and the preview
system generates blurry previews, you might want to consider setting a maximum
scale factor. By default, pictures are upscaled to 10 times the original size:
::
@ -88,7 +88,7 @@ If you want to disable scaling at all, you can set the config value to '1':
<?php
'preview_max_scale_factor' => 1,
If you want to disable the maximum scaling factor, you can set the config value
If you want to disable the maximum scaling factor, you can set the config value
to 'null':
::
@ -101,6 +101,6 @@ JPEG quality setting:
Default JPEG quality setting for preview images is '90'. Change this with:
::
::
occ config:app:set preview jpeg_quality --value="60"

22
admin_manual/configuration_server/antivirus_configuration.rst
View file

@ -83,9 +83,9 @@ You can mount ClamAV Socket from the Docker Container to the host System as volu
Also you need to edit config files as described above and added configuration for a local Socket. In this particular Image configuration parameters could be passed via ``CLAMD_SETTINGS_CSV``.
For a Docker run this command::
docker run --name clamav -d -v /var/run/clamav/:/var/run/clamav/ -e CLAMD_SETTINGS_CSV="LocalSocket=/var/run/clamav/clamd.ctl" quay.io/ukhomeofficedigital/clamav:latest
For a Docker-compose use following settings::
version: "3.6"
@ -106,8 +106,7 @@ Place the ``files_antivirus`` app into the ``apps`` directory of your Nextcloud
server. Then the app shows up on the Nextcloud Apps page where it simply can be
enabled.
.. image:: ../images/antivirus-app.png
:alt:
.. figure:: ../images/antivirus-app.png
Configuring ClamAV on Nextcloud
-------------------------------
@ -115,13 +114,11 @@ Configuring ClamAV on Nextcloud
Next, go to your Nextcloud Admin page and set your Nextcloud logging level to
Everything.
.. image:: ../images/antivirus-logging.png
:alt:
.. figure:: ../images/antivirus-logging.png
Now find your Antivirus Configuration panel on your Admin page.
.. image:: ../images/antivirus-config.png
:alt:
.. figure:: ../images/antivirus-config.png
ClamAV runs in one of three modes:
@ -146,8 +143,7 @@ Daemon (Socket)
netstat -a|grep clam
unix 2 [ ACC ] STREAM LISTENING 15857 /var/run/clamav/clamd.ctl
.. image:: ../images/antivirus-daemon-socket.png
:alt:
.. figure:: ../images/antivirus-daemon-socket.png
The ``Stream Length`` value sets the number of bytes read in one pass.
10485760 bytes, or ten megabytes, is the default. This value should be
@ -162,15 +158,13 @@ Daemon
For the Daemon option you need the hostname or IP address of the remote
server running ClamAV, and the server's port number.
.. image:: ../images/antivirus-daemon.png
:alt:
.. figure:: ../images/antivirus-daemon.png
Executable
The Executable option requires the path to ``clamscan``, which is the
interactive ClamAV scanning command. Nextcloud should find it automatically.
.. image:: ../images/antivirus-executable.png
:alt:
.. figure:: ../images/antivirus-executable.png
When you are satisfied with how ClamAV is operating, you might want to go
back and change all of your logging to less verbose levels.

6
admin_manual/configuration_server/email_configuration.rst
View file

@ -11,8 +11,7 @@ existing mail server. You must have a functioning mail server for Nextcloud to b
able to send emails. You may have a mail server on the same machine as Nextcloud,
or it may be a remote server.
.. image:: ../images/smtp-config-wizard.png
:alt:
.. figure:: ../images/smtp-config-wizard.png
With the wizard, connecting Nextcloud to your mail server is fast and easy.
The wizard fills in the values in ``config/config.php``, so you may use either
@ -44,8 +43,7 @@ connect Nextcloud to a remote SMTP server:
* Login credentials (if required)
.. image:: ../images/smtp-config-smtp.png
:alt:
.. figure:: ../images/smtp-config-smtp.png
Your changes are saved immediately, and you can click the Send Email button to
test your configuration. This sends a test message to the email address you

49
admin_manual/configuration_server/external_sites.rst
View file

@ -5,12 +5,13 @@ Linking external sites
You can embed external websites or documents inside your Nextcloud pages with the **External
sites** app, as this screenshot shows.
.. image:: ../images/external-sites-1.png
:alt:
.. figure:: ../images/external-sites-1.png
*Click to enlarge*
This is useful for quick access to important pages such as the
Nextcloud manuals and informational pages for your company, and for presenting
external pages inside your custom Nextcloud branding, if you use your own custom
Nextcloud manuals and informational pages for your company, and for presenting
external pages inside your custom Nextcloud branding, if you use your own custom
themes.
The External sites app can be easily installed from the app store. Go to **Settings > Apps >
@ -26,43 +27,41 @@ Currently the following options are available: All devices, Android app, iOS app
It is also possible to add links only for members of a given group.
.. image:: ../images/external-sites-2.png
:alt:
.. figure:: ../images/external-sites-2.png
*Click to enlarge*
The links appear in the Nextcloud menu on the top or in the settings menu, after
reloading the page.
.. image:: ../images/external-sites-3.png
:alt:
.. figure:: ../images/external-sites-3.png
Configurations preventing embedding
-----------------------------------
Your links may or may not work correctly due to the various ways that Web
browsers and Web sites handle HTTP and HTTPS URLs, and because the External
Sites app embeds external links in IFrames. Modern Web browsers try very hard
to protect Web surfers from dangerous links, and safety apps like
`Privacy Badger <https://www.eff.org/privacybadger>`_ and ad-blockers may block
embedded pages. It is strongly recommended to enforce HTTPS on your Nextcloud
server; do not weaken this, or any of your security tools, just to make
embedded Web pages work. After all, you can freely access them outside of
Your links may or may not work correctly due to the various ways that Web
browsers and Web sites handle HTTP and HTTPS URLs, and because the External
Sites app embeds external links in IFrames. Modern Web browsers try very hard
to protect Web surfers from dangerous links, and safety apps like
`Privacy Badger <https://www.eff.org/privacybadger>`_ and ad-blockers may block
embedded pages. It is strongly recommended to enforce HTTPS on your Nextcloud
server; do not weaken this, or any of your security tools, just to make
embedded Web pages work. After all, you can freely access them outside of
Nextcloud.
Most Web sites that offer login functionalities use the ``X-Frame-Options`` or
``Content-Security-Policy`` HTTP header which instructs browsers to not
allow their pages to be embedded for security reasons (e.g. "Clickjacking"). You
can usually verify the reason why embedding the website is not possible by using
your browser's console tool. For example, this page has an invalid SSL
Most Web sites that offer login functionalities use the ``X-Frame-Options`` or
``Content-Security-Policy`` HTTP header which instructs browsers to not
allow their pages to be embedded for security reasons (e.g. "Clickjacking"). You
can usually verify the reason why embedding the website is not possible by using
your browser's console tool. For example, this page has an invalid SSL
certificate.
.. image:: ../images/external-sites-4.png
:alt:
.. figure:: ../images/external-sites-4.png
On this page, X-Frame-Options prevents the embedding.
.. image:: ../images/external-sites-5.png
:alt:
.. figure:: ../images/external-sites-5.png
There is also a redirect option, which allows that those websites can still be added for quick access.
Instead of embedding the website the user will be redirected to it.

5
admin_manual/configuration_server/oauth2.rst
View file

@ -13,8 +13,7 @@ Add an OAuth2 Application
Head over to your Administrator Security Settings. Here you can add a new ``OAuth2`` client.
.. image:: images/oauth2-settings.png
:alt:
.. figure:: images/oauth2-settings.png
Enter the name of your application and provide a redirection url.
You should now have a Client Identifier and Secret. Enter those into your ``OAuth2`` client.
@ -39,6 +38,6 @@ Note that apache by default strips this. Make sure you have ``mod_headers``, ``m
Security considerations
-----------------------
Nextcloud ``OAuth2`` implementation currently does not support scoped access. This means that every token has full access to the complete account including read and write permission to the stored files. It is essential to store the ``OAuth2`` tokens in a safe way!
Nextcloud ``OAuth2`` implementation currently does not support scoped access. This means that every token has full access to the complete account including read and write permission to the stored files. It is essential to store the ``OAuth2`` tokens in a safe way!
Without scopes and restrictable access it is not recommended to use a Nextcloud instance as a user authentication service.

39
admin_manual/configuration_server/security_setup_warnings.rst
View file

@ -2,12 +2,11 @@
Warnings on admin page
======================
Your Nextcloud server has a built-in configuration checker, and it reports its
findings at the top of your Admin page. These are some of the warnings you
Your Nextcloud server has a built-in configuration checker, and it reports its
findings at the top of your Admin page. These are some of the warnings you
might see, and what to do about them.
.. image:: ../images/security-setup-warning-1.png
:alt:
.. figure:: ../images/security-setup-warning-1.png
You can use the `Nextcloud Security Scan <https://scan.nextcloud.com>`_ to see
if your system is up to date and well secured. We have ran this scan over public
@ -18,7 +17,7 @@ up to date! Privacy means little without security.
Cache warnings
--------------
"No memory cache has been configured. To enhance your performance please
"No memory cache has been configured. To enhance your performance please
configure a memcache if available." Nextcloud supports multiple php caching
extensions:
@ -26,15 +25,15 @@ extensions:
* Memcached
* Redis (minimum required PHP extension version: 2.2.6)
You will see this warning if you have no caches installed and enabled, or if
your cache does not have the required minimum version installed; older versions
You will see this warning if you have no caches installed and enabled, or if
your cache does not have the required minimum version installed; older versions
are disabled because of performance problems.
If you see "*{Cache}* below version *{Version}* is installed. for stability and
performance reasons we recommend to update to a newer *{Cache}* version" then
you need to upgrade, or, if you're not using it, remove it.
You are not required to use any caches, but caches improve server performance.
You are not required to use any caches, but caches improve server performance.
See :doc:`caching_configuration`.
Transactional file locking is disabled
@ -49,11 +48,11 @@ to correctly configure your environment for transactional file locking.
You are accessing this site via HTTP
------------------------------------
"You are accessing this site via HTTP. We strongly suggest you configure your
server to require using HTTPS instead." Please take this warning seriously;
using HTTPS is a fundamental security measure. You must configure your Web
server to support it, and then there are some settings in the **Security**
section of your Nextcloud Admin page to enable. The following pages
"You are accessing this site via HTTP. We strongly suggest you configure your
server to require using HTTPS instead." Please take this warning seriously;
using HTTPS is a fundamental security measure. You must configure your Web
server to support it, and then there are some settings in the **Security**
section of your Nextcloud Admin page to enable. The following pages
describe how to enable HTTPS on the Apache and Nginx Web servers.
:ref:`enabling_ssl_label` (on Apache)
@ -66,7 +65,7 @@ The test with getenv(\"PATH\") only returns an empty response
-------------------------------------------------------------
Some environments are not passing a valid PATH variable to Nextcloud. The
:ref:`php_fpm_tips_label` provides the information about how to configure your
:ref:`php_fpm_tips_label` provides the information about how to configure your
environment.
The "Strict-Transport-Security" HTTP header is not configured
@ -99,20 +98,20 @@ is maintained containing various information and debugging hints.
Outdated NSS / OpenSSL version
------------------------------
"cURL is using an outdated OpenSSL version (OpenSSL/$version). Please update your
operating system or features such as installing and updating apps via the app store
"cURL is using an outdated OpenSSL version (OpenSSL/$version). Please update your
operating system or features such as installing and updating apps via the app store
or Federated Cloud Sharing will not work reliably."
"cURL is using an outdated NSS version (NSS/$version). Please update your operating
system or features such as installing and updating apps via the app store or Federated
"cURL is using an outdated NSS version (NSS/$version). Please update your operating
system or features such as installing and updating apps via the app store or Federated
Cloud Sharing will not work reliably."
There are known bugs in older OpenSSL and NSS versions leading to misbehavior in
There are known bugs in older OpenSSL and NSS versions leading to misbehavior in
combination with remote hosts using SNI. A technology used by most of the HTTPS
websites. To ensure that Nextcloud will work properly you need to update OpenSSL
to at least 1.0.2b or 1.0.1d. For NSS the patch version depends on your distribution
and an heuristic is running the test which actually reproduces the bug. There
are distributions such as RHEL/CentOS which have this backport still `pending
are distributions such as RHEL/CentOS which have this backport still `pending
<https://bugzilla.redhat.com/show_bug.cgi?id=1241172>`_.
Your Web server is not set up properly to resolve /.well-known/caldav/ or /.well-known/carddav/

3
admin_manual/configuration_server/theming.rst
View file

@ -23,8 +23,7 @@ You can change the following parameters of the look and feel on your instance:
* Additional legal links (Legal notice and Privacy policy link)
* Custom header logo and favicon as alternative to auto-generation based on logo
.. image:: ../configuration_server/images/theming.png
:alt:
.. figure:: ../configuration_server/images/theming.png
Theming of icons
----------------

10
admin_manual/configuration_user/two_factor-auth.rst
View file

@ -9,8 +9,8 @@ of the Nextcloud Server component but provided by featured and 3rd-party Nextclo
Several 2FA apps are already available including
`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm>`_,
a Telegram/Signal/SMS gateway and `U2F <https://en.wikipedia.org/wiki/Universal_2nd_Factor>`_.
`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm>`_,
a Telegram/Signal/SMS gateway and `U2F <https://en.wikipedia.org/wiki/Universal_2nd_Factor>`_.
Developers can `build new two-factor provider apps <https://docs.nextcloud.com/server/latest/developer_manual/app/two-factor-provider.html>`_.
@ -25,8 +25,7 @@ with Google Authenticator and compatible apps. The apps are available in the
Nextcloud App store so by navigating there and clicking **enable** for the app
you want, 2FA will be installed and enabled on your Nextcloud server.
.. image:: ../images/2fa-app-install.png
:alt:
.. figure:: ../images/2fa-app-install.png
Once 2FA has been enabled, users have to `activate it in their personal settings. <https://docs.nextcloud.com/server/latest/user_manual/en/user_2fa.html>`_
@ -46,8 +45,7 @@ also be excluded for certain groups.
These settings can be found in the administrator's security settings.
.. image:: ../images/2fa-admin-settings.png
:alt:
.. figure:: ../images/2fa-admin-settings.png
When groups are selected/excluded, they use the following logic to determine if
a user has 2FA enforced:

44
admin_manual/configuration_user/user_auth_ldap.rst
View file

@ -53,8 +53,8 @@ authentication, enter your credentials on this tab. Nextcloud will then attempt
to auto-detect the server's port and base DN. The base DN and port are
mandatory, so if Nextcloud cannot detect them you must enter them manually.
.. image:: ../images/ldap-wizard-1-server.png
:alt:
.. figure:: ../images/ldap-wizard-1-server.png
:alt: LDAP wizard, server tab
Server configuration:
Configure one or more LDAP servers. Click the **Delete Configuration**
@ -113,8 +113,8 @@ server use the **Login Attributes** tab. Those LDAP users who have access but ar
as users (if there are any) will be hidden users. You may bypass the form fields
and enter a raw LDAP filter if you prefer.
.. image:: ../images/ldap-wizard-2-user.png
:alt:
.. figure:: ../images/ldap-wizard-2-user.png
:alt: User filter
Only those object classes:
Nextcloud will determine the object classes that are typically available for
@ -154,8 +154,8 @@ filter if you prefer.)
You may override your User Filter settings on the Users tab by using a raw
LDAP filter.
.. image:: ../images/ldap-wizard-3-login.png
:alt:
.. figure:: ../images/ldap-wizard-3-login.png
:alt: Login filter
LDAP Username:
If this value is checked, the login value will be compared to the username in
@ -198,8 +198,8 @@ By default, no LDAP groups will be available in Nextcloud. The settings in the
Groups tab determine which groups will be available in Nextcloud. You may
also elect to enter a raw LDAP filter instead.
.. image:: ../images/ldap-wizard-4-group.png
:alt:
.. figure:: ../images/ldap-wizard-4-group.png
:alt: Group filter
Only these object classes:
Nextcloud will determine the object classes that are typically available for
@ -244,8 +244,8 @@ The Advanced Settings are structured into three parts:
Connection settings
^^^^^^^^^^^^^^^^^^^
.. image:: ../images/ldap-advanced-1-connection.png
:alt:
.. figure:: ../images/ldap-advanced-1-connection.png
:alt: Advanced settings
Configuration Active:
Enables or Disables the current configuration. By default, it is turned off.
@ -309,8 +309,8 @@ operates.
Directory settings
^^^^^^^^^^^^^^^^^^
.. image:: ../images/ldap-advanced-2-directory.png
:alt:
.. figure:: ../images/ldap-advanced-2-directory.png
:alt: Directory settings.
User Display Name Field:
The attribute that should be used as display name in Nextcloud.
@ -429,8 +429,8 @@ Default password policy DN:
Special attributes
^^^^^^^^^^^^^^^^^^
.. image:: ../images/ldap-advanced-3-attributes.png
:alt:
.. figure:: ../images/ldap-advanced-3-attributes.png
:alt: Special Attributes.
Quota Field:
Nextcloud can read an LDAP attribute and set the user quota according to its
@ -469,8 +469,8 @@ In migrated Nextcloud installations the old behavior still applies, which is usi
Expert settings
---------------
.. image:: ../images/ldap-expert.png
:alt:
.. figure:: ../images/ldap-expert.png
:alt: Expert settings.
In the Expert Settings fundamental behavior can be adjusted to your needs. The
configuration should be well-tested before starting production use.
@ -494,10 +494,10 @@ Internal Username:
You can override all of this with the Internal Username setting. Leave it
empty for default behavior. Changes will affect only newly mapped LDAP users.
When configuring this, be aware that the username in Nextcloud is considered
When configuring this, be aware that the username in Nextcloud is considered
immutable and cannot be changed afterwards. This can cause issues when using
an attribute that might change, e.g. the email address of a user that will
an attribute that might change, e.g. the email address of a user that will
get changed during name change.
* Example: *uid*
@ -584,8 +584,8 @@ server, it will be used as their avatar. In this case the user cannot alter thei
avatar (on their Personal page) as it must be changed in LDAP. *jpegPhoto* is
preferred over *thumbnailPhoto*.
.. image:: ../images/ldap-fetched-avatar.png
:alt:
.. figure:: ../images/ldap-fetched-avatar.png
:alt: Profile picture fetched from LDAP.
If the *jpegPhoto* or *thumbnailPhoto* attribute is not set or empty, then
users can upload and manage their avatars on their Nextcloud Personal pages.
@ -715,7 +715,7 @@ The attributes of users are fetched on demand (i.e. for sharing autocompletion
or in the user management) and then stored inside the Nextcloud database to
allow a better performance on our side. They are typically checked twice a day
in batches from all users again. Beside that they are also refreshed during a
login for this user or can be fetched manually via the occ command
login for this user or can be fetched manually via the occ command
``occ ldap:check-user --update USERID`` where ``USERID`` is Nextcloud's user id.
Caching

23
admin_manual/configuration_user/user_configuration.rst
View file

@ -18,21 +18,18 @@ On the User management page of your Nextcloud Web UI you can:
The default view displays basic information about your users.
.. image:: ../images/users-config.png
:alt:
.. figure:: ../images/users-config.png
The Group filters on the left sidebar lets you quickly filter users by their
group memberships, and create new groups.
.. image:: ../images/users-config-1.png
:alt:
.. figure:: ../images/users-config-1.png
Click the gear icon on the lower left sidebar to set a default storage quota,
and to display additional fields: **Show storage location, Show last log in,
Show user backend, Send email to new users,** and **Show email address**.
.. image:: ../images/users-config-2.png
:alt:
.. figure:: ../images/users-config-2.png
User accounts have the following properties:
@ -70,8 +67,7 @@ To create a user account:
* Optionally, assign **Groups** memberships
* Click the **Create** button
.. image:: ../images/users-create.png
:alt:
.. figure:: ../images/users-create.png
Login names may contain letters (a-z, A-Z), numbers (0-9), dashes (-),
underscores (_), periods (.) and at signs (@). After creating the user, you
@ -125,8 +121,7 @@ system settings, or add or modify users in the groups that they are not **Group
Administrators** for. Use the dropdown menus in the **Group Admin** column to
assign group admin privileges.
.. image:: ../images/users-groups.png
:alt:
.. figure:: ../images/users-groups.png
**Super Administrators** have full rights on your Nextcloud server, and can
access and modify all settings. To assign the **Super Administrators** role to
@ -189,8 +184,7 @@ files count against that user's quota.
Disable and enable users
------------------------
.. image:: ../images/users-actions.png
:alt:
.. figure:: ../images/users-actions.png
Sometimes you may want to disable a user without permanently deleting their
settings and files. The user can be activated any time again, without data-loss.
@ -208,8 +202,7 @@ select **Enable**.
Deleting users
--------------
.. image:: ../images/users-actions.png
:alt:
.. figure:: ../images/users-actions.png
Deleting a user is easy: hover your cursor over their name on the **Users** page
until the "..."-menu icon appears at the far right. After clicking on it, you will
@ -219,7 +212,7 @@ You'll see an undo button at the top of the page, which remains for some seconds
When the undo button is gone you cannot recover the deleted user.
All of the files owned by the user are deleted as well, including all files they
have shared. If you need to preserve the user's files and shares, you must first
have shared. If you need to preserve the user's files and shares, you must first
download them from your Nextcloud Files page, which compresses them into a zip
file, or use a sync client to copy them to your local computer. See
:doc:`../configuration_files/file_sharing_configuration` to learn how to create

8
admin_manual/configuration_user/user_password_policy.rst
View file

@ -4,17 +4,17 @@ User password policy
A password policy is a set of rules designed to enhance computer security by encouraging users to employ strong passwords and use them properly.
In the security-section of your administrator-settings you can configure
In the security-section of your administrator-settings you can configure
* a minimal length of a password. Default is 8 characters.
* a password history
* a password expiration period
* a lockout policy
* to forbid common passwords like 'password' or 'login'.
* to forbid common passwords like 'password' or 'login'.
* to enforce upper and lower case characters
* to enforce numeric characters
* to enforce special characters like ! or :
* to check the password against the list of breached passwords from haveibeenpwnd.com (hashed check via haveibeenpwnd.com-API)
.. image:: ../images/user_password_policy_configuration_app.png
:alt:
.. figure:: ../images/user_password_policy_configuration_app.png

12
admin_manual/file_workflows/access_control.rst
View file

@ -24,8 +24,8 @@ Examples
After installing the File Access Control app as described in :doc:`../apps_management`
navigate to the configuration and locate the File Access Control settings.
.. image:: images/files_access_control_sample_rules.png
:alt:
.. figure:: images/files_access_control_sample_rules.png
:alt: Sample rules to block on user group, time and IP base.
The first rule group ``Support only 9-5`` denies any access to files for users
of the Support user group, between 5pm and 9am.
@ -48,8 +48,8 @@ user could remove and reassign the tag.
This example blocks access to any folder with the tag ``Confidential``.
.. image:: images/files_access_control_collaborative_tags.png
:alt:
.. figure:: images/files_access_control_collaborative_tags.png
:alt: Deny access based on collaborative tag
Prevent uploading of specific files
-----------------------------------
@ -63,8 +63,8 @@ used for the type of file you're trying to block.
The following example prevents zip files from being uploaded by using the regular
expression: ``/^application\/(zip|x-zip-compressed)$/i``
.. image:: images/files_access_control_block_mimetype.png
:alt:
.. figure:: images/files_access_control_block_mimetype.png
:alt: Prevent upload based on mimetype
Common misconfigurations
------------------------

8
admin_manual/file_workflows/automated_tagging.rst
View file

@ -21,8 +21,8 @@ Example
After installing the Files automated tagging app as described in :doc:`../apps_management`
navigate to the configuration and locate the Workflow settings.
.. image:: images/automated_tagging_sample_rule.png
:alt:
.. figure:: images/automated_tagging_sample_rule.png
:alt: Example rule to assign a restricted tag.
In the example you can see a simple rule with only one condition.
It will tag all files with the restricted tag ``Protected file`` that are
@ -33,8 +33,8 @@ both work fine without users being able to work around them.
In this case folder will be also tagged with tag ``Protected file``, to avoid
this, simply modify the rule to exclude Directory ``httpd/unix-directory`` from it.
.. image:: images/automated_tagging_sample_rule_exclude_folder.png
:alt:
.. figure:: images/automated_tagging_sample_rule_exclude_folder.png
:alt: Example rule to assign a restricted tag except to Directory.
Available rules
---------------

4
admin_manual/file_workflows/retention.rst
View file

@ -11,8 +11,8 @@ Example
After installing the Retention app as described in :doc:`../apps_management`
navigate to the configuration and locate the Workflow settings.
.. image:: images/retention_sample.png
:alt:
.. figure:: images/retention_sample.png
:alt: Sample rule to delete files after 14 days.
The rule from the example will delete all files tagged with ``Temporary file`` after 14 days.

84
admin_manual/installation/installation_wizard.rst
View file

@ -5,23 +5,23 @@ Installation wizard
Quick start
-----------
When Nextcloud prerequisites are fulfilled and all Nextcloud files are installed,
the last step to completing the installation is running the Installation
Wizard.
When Nextcloud prerequisites are fulfilled and all Nextcloud files are installed,
the last step to completing the installation is running the Installation
Wizard.
This is just three steps:
#. Point your Web browser to ``http://localhost/nextcloud``
#. Enter your desired administrator's username and password.
#. Click **Finish Setup**.
.. image:: images/install-wizard-a.png
:alt:
.. figure:: images/install-wizard-a.png
:scale: 75%
:alt: screenshot of the installation wizard
You're finished and can start using your new Nextcloud server.
You're finished and can start using your new Nextcloud server.
Of course, there is much more that you can do to set up your Nextcloud server for
best performance and security. In the following sections we will cover important
Of course, there is much more that you can do to set up your Nextcloud server for
best performance and security. In the following sections we will cover important
installation and post-installation steps.
* :ref:`Data Directory Location <data_directory_location_label>`
@ -33,19 +33,19 @@ installation and post-installation steps.
Data directory location
-----------------------
Click **Storage and Database** to expose additional installation configuration
Click **Storage and Database** to expose additional installation configuration
options for your Nextcloud data directory and database.
.. image:: images/install-wizard-a1.png
:alt:
.. figure:: images/install-wizard-a1.png
:scale: 75%
:alt: installation wizard with all options exposed
You should locate your Nextcloud data directory outside of your Web root if you
are using an HTTP server other than Apache, or you may wish to store your
Nextcloud data in a different location for other reasons (e.g. on a storage
server). It is best to configure your data directory location at installation,
as it is difficult to move after installation. You may put it anywhere; in this
example is it located in ``/opt/nextcloud/``. This directory must already exist,
You should locate your Nextcloud data directory outside of your Web root if you
are using an HTTP server other than Apache, or you may wish to store your
Nextcloud data in a different location for other reasons (e.g. on a storage
server). It is best to configure your data directory location at installation,
as it is difficult to move after installation. You may put it anywhere; in this
example is it located in ``/opt/nextcloud/``. This directory must already exist,
and must be owned by your HTTP user.
.. _database_choice_label:
@ -60,55 +60,55 @@ recommend :doc:`MySQL/MariaDB <system_requirements>`. Your database and PHP
connectors must be installed before you run the Installation Wizard. When
you install Nextcloud from packages all the necessary dependencies will be
satisfied (see :doc:`source_installation` for a detailed listing of required
and optional PHP modules). You will need the root database login, or any
and optional PHP modules). You will need the root database login, or any
administrator login , and then enter any name you want for your Nextcloud database.
Be careful your administrator login needs to have the permissions to create
and modify databases and they needs to have the permissions to grant permissions
to other users.
After you enter your root or administrator login for your database, the
installer creates a special database user with privileges limited to the
Nextcloud database. Then Nextcloud needs only the special Nextcloud database
user, and drops the root dB login. This user is named for your Nextcloud admin
user, with an ``oc_`` prefix, and then given a random password. The Nextcloud
After you enter your root or administrator login for your database, the
installer creates a special database user with privileges limited to the
Nextcloud database. Then Nextcloud needs only the special Nextcloud database
user, and drops the root dB login. This user is named for your Nextcloud admin
user, with an ``oc_`` prefix, and then given a random password. The Nextcloud
database user and password are written into ``config.php``::
'dbuser' => 'oc_molly',
'dbpassword' => 'pX65Ty5DrHQkYPE5HRsDvyFHlZZHcm',
'dbpassword' => 'pX65Ty5DrHQkYPE5HRsDvyFHlZZHcm',
Click Finish Setup, and start using your new Nextcloud server.
Click Finish Setup, and start using your new Nextcloud server.
.. image:: images/install-wizard-a2.png
:alt:
.. figure:: images/install-wizard-a2.png
:scale: 75%
:alt: Nextcloud welcome screen after a successful installation
Now we will look at some important post-installation steps.
.. _trusted_domains_label:
.. _trusted_domains_label:
Trusted domains
---------------
All URLs used to access your Nextcloud server must be whitelisted in your
``config.php`` file, under the ``trusted_domains`` setting. Users
are allowed to log into Nextcloud only when they point their browsers to a
URL that is listed in the ``trusted_domains`` setting. You may use IP addresses
All URLs used to access your Nextcloud server must be whitelisted in your
``config.php`` file, under the ``trusted_domains`` setting. Users
are allowed to log into Nextcloud only when they point their browsers to a
URL that is listed in the ``trusted_domains`` setting. You may use IP addresses
and domain names. A typical configuration looks like this::
'trusted_domains' =>
'trusted_domains' =>
array (
0 => 'localhost',
1 => 'server1.example.com',
0 => 'localhost',
1 => 'server1.example.com',
2 => '192.168.1.50',
3 => '[fe80::1:50]',
),
The loopback address, ``127.0.0.1``, is automatically whitelisted, so as long
as you have access to the physical server you can always log in. In the event
that a load balancer is in place there will be no issues as long as it sends
the correct X-Forwarded-Host header. When a user tries a URL that
The loopback address, ``127.0.0.1``, is automatically whitelisted, so as long
as you have access to the physical server you can always log in. In the event
that a load balancer is in place there will be no issues as long as it sends
the correct X-Forwarded-Host header. When a user tries a URL that
is not whitelisted the following error appears:
.. image:: images/install-wizard-a4.png
:alt:
.. figure:: images/install-wizard-a4.png
:scale: 75%
:alt: Error message when URL is not whitelisted

2
admin_manual/issues/applying_patch.rst
View file

@ -42,6 +42,6 @@ If you found a related pull request on GitHub that solves your issue, or you wan
4. In case you are on an older version, you might first need to go the the correct version of the patch.
.. image:: images/getting-a-patch-from-github.png
:alt:
:alt: backportbot-nextcloud linking to the pull request for an older version.
5. You can find it by looking for a link by the ``backportbot-nextcloud`` or a developer will leave a manual comment about the backport to an older Nextcloud version. For the example above you the pull request for Nextcloud 21 is at https://github.com/nextcloud/server/pull/26406 and the patch at https://github.com/nextcloud/server/pull/26406.patch

2
admin_manual/issues/code_signing.rst
View file

@ -61,7 +61,7 @@ the following options:
3. Trigger a rescan.
.. image:: images/code-integrity-admin.png
:alt:
:alt: Links for resolving code integrity warnings.
To debug issues caused by the code integrity check click on "List of invalid
files...", and you will be shown a text document listing the different issues. The

3
admin_manual/issues/general_troubleshooting.rst
View file

@ -91,8 +91,7 @@ contains just this line::
Open this file in a Web browser by pointing your browser to
``localhost/phpinfo.php``:
.. image:: ../images/phpinfo.png
:alt:
.. figure:: ../images/phpinfo.png
Your PHP version is at the top, and the rest of the page contains abundant
system information such as active modules, active ``.ini`` files, and much more.

56
admin_manual/maintenance/package_upgrade.rst
View file

@ -1,20 +1,20 @@
====================
Upgrade via packages
====================
Upgrade quickstart
------------------
One effective, if unofficial method for keeping Nextcloud current on Linux servers is by configuring
your system to use Nextcloud via a self contained "Snap" package, A technology allowing users to
One effective, if unofficial method for keeping Nextcloud current on Linux servers is by configuring
your system to use Nextcloud via a self contained "Snap" package, A technology allowing users to
always have the latest version of an "app".
That version from Canonical is quite restrictive. It is not aimed at developers or advanced users
who would want to tune their configuration by installing extra features. It is aimed at end-users
who want a no-brainer solution. Install it, use it. No need to worry about updating Nextcloud any
That version from Canonical is quite restrictive. It is not aimed at developers or advanced users
who would want to tune their configuration by installing extra features. It is aimed at end-users
who want a no-brainer solution. Install it, use it. No need to worry about updating Nextcloud any
more.
It will work for as long as Canonical pushes releases, just like with any other Linux package
It will work for as long as Canonical pushes releases, just like with any other Linux package
maintained independently of Nextcloud.
Installation
@ -31,24 +31,24 @@ Install Nextcloud $ sudo snap install nextcloud
1st login
---------
After a successful install, assuming you and the device on which it was installed are on the
same network, you should be able to reach the Nextcloud installation by visiting .local in
your browser. If your hostname is localhost or localhost.localdomain, like on an Ubuntu Base
After a successful install, assuming you and the device on which it was installed are on the
same network, you should be able to reach the Nextcloud installation by visiting .local in
your browser. If your hostname is localhost or localhost.localdomain, like on an Ubuntu Base
device (IoT), nextcloud.local will be used instead.
You will be asked to create a password for "admin" and your favourite cloud will be ready
**Note**
Do not use on IoT devices yet. You probably don't need these instructions anyway if you're
Do not use on IoT devices yet. You probably don't need these instructions anyway if you're
using Snappy Base 16.04 as it's currently unreleased.
* Make a :doc:`fresh backup <backup>`.
* Upgrade your Nextcloud snap: sudo snap refresh nextcloud
* Run :ref:`occ upgrade <command_line_upgrade_label>`.
* Take your Nextcloud server out of :ref:`maintenance mode
<maintenance_commands_label>`.
* Take your Nextcloud server out of :ref:`maintenance mode
<maintenance_commands_label>`.
* Re-enable third-party apps.
Upgrade tips
@ -58,33 +58,33 @@ Upgrading Nextcloud from a Snap is just like upgrading any snap package.
For example:
sudo snap refresh nextcloud
Your Snap package manager only upgrades the current Nextcloud Snap. Then
your Nextcloud server is immediately put into maintenance mode. You may not see
Your Snap package manager only upgrades the current Nextcloud Snap. Then
your Nextcloud server is immediately put into maintenance mode. You may not see
this until you refresh your Nextcloud page.
.. image:: images/upgrade-1.png
.. figure:: images/upgrade-1.png
:scale: 75%
:alt:
:alt: Nextcloud status screen informing users that it is in maintenance mode.
Then use ``occ`` to complete the upgrade. You must run ``occ`` as your HTTP
Then use ``occ`` to complete the upgrade. You must run ``occ`` as your HTTP
user. This example is for Debian/Ubuntu::
sudo -u www-data php occ upgrade
This example is for CentOS/RHEL/Fedora::
sudo -u apache php occ upgrade
.. _skipped_release_upgrade_label:
sudo -u apache php occ upgrade
.. _skipped_release_upgrade_label:
Upgrading across skipped releases
---------------------------------
It is best to update your Nextcloud installation with every new point release,
and to never skip any major releases. While this requirement is being worked on,
for the moment If you have skipped any major releases you can bring your
It is best to update your Nextcloud installation with every new point release,
and to never skip any major releases. While this requirement is being worked on,
for the moment If you have skipped any major releases you can bring your
Nextcloud current with these steps:
If you are using a Snap package:
@ -97,8 +97,8 @@ If you did **not** install via a Snap package:
#. Run upgrade routine
#. Repeat from step 2 until you reach the last available major release
You'll find previous Nextcloud releases in the `Nextcloud Server Changelog
You'll find previous Nextcloud releases in the `Nextcloud Server Changelog
<https://nextcloud.com/changelog/>`_.
If upgrading via your Snap package manager fails, then you must perform a
If upgrading via your Snap package manager fails, then you must perform a
:doc:`manual_upgrade`.

30
admin_manual/maintenance/update.rst
View file

@ -78,43 +78,37 @@ steps:
section as well as the update notification is only available if the update
notication app is enabled in the apps management.
.. image:: images/updater-1-update-available.png
:alt:
.. figure:: images/updater-1-update-available.png
2. Click the button "Open updater".
.. image:: images/updater-2-open-updater.png
:alt:
.. figure:: images/updater-2-open-updater.png
3. Verify the information that is shown and click the button "Start update"
to start the update.
.. image:: images/updater-3-running-step.png
:alt:
.. figure:: images/updater-3-running-step.png
4. In case an error happens or the check failed the updater stops processing
and gives feedback. You can now try to solve the problem and click the
"Retry update" button. This will continue the update and re-run the failed
step. It will not re-run the previous succeeded steps.
.. image:: images/updater-4-failed-step.png
:alt:
.. figure:: images/updater-4-failed-step.png
5. In case you close the updater, before it finished you can just open the
updater page again and proceed at the last succeeded step. Closing the web
page will still execute the running step but will not continue with the next
one, because this is triggered by the open updater page.
.. image:: images/updater-5-continue-update.png
:alt:
.. figure:: images/updater-5-continue-update.png
6. Once all steps are executed the updater will ask you a final question:
"Keep maintenance mode active?". This allows you to use either the web based
upgrade page or the command line based upgrade procedure (``occ upgrade``).
Command line access is required if the maintenance mode is kept active.
.. image:: images/updater-6-maintenance-mode.png
:alt:
.. figure:: images/updater-6-maintenance-mode.png
7. Done. You now can continue either to the web based upgrade page or run
``occ upgrade``. The two examples "Web based upgrade" and "Command line
@ -126,17 +120,14 @@ steps:
This is how the web based update would continue:
.. image:: images/updater-7-disable-maintenance.png
:alt:
.. image:: images/updater-9-upgrade-page.png
:alt:
**Command line based upgrade**
This is how the command line based update would continue:
.. image:: images/updater-8-keep-maintenance.png
:alt:
.. code::
@ -178,7 +169,6 @@ The steps are basically the same as for the web based updater:
notication app is enabled in the apps management.
.. image:: images/updater-1-update-available.png
:alt:
2. Instead of clicking that button you can now invoke the command line based
updater by going into the `updater/` directory in the Nextcloud directory
@ -186,17 +176,14 @@ The steps are basically the same as for the web based updater:
``sudo -u www-data php /var/www/nextcloud/updater/updater.phar``)
.. image:: images/updater-cli-2-start-updater.png
:alt:
:class: terminal-image
3. Verify the information that is shown and enter "Y" to start the update.
.. image:: images/updater-cli-3-running-step.png
:alt:
:class: terminal-image
.. image:: images/updater-cli-4-failed-step.png
:alt:
:class: terminal-image
4. In case an error happens or the check failed the updater stops processing
@ -205,7 +192,6 @@ The steps are basically the same as for the web based updater:
It will not re-run the previous succeeded steps.
.. image:: images/updater-cli-5-continue-update.png
:alt:
:class: terminal-image
6. Once all steps are executed the updater will ask you a final question:
@ -215,14 +201,12 @@ The steps are basically the same as for the web based updater:
`Please now execute "./occ upgrade" to finish the upgrade.`.
.. image:: images/updater-cli-6-run-command.png
:alt:
:class: terminal-image
7. Once the ``occ upgrade`` is done you get asked if the maintenance mode
should be kept active.
.. image:: images/updater-cli-7-maintenance.png
:alt:
:class: terminal-image
Batch mode for command line based updater
@ -239,5 +223,5 @@ To execute this, run the command with the ``--no-interaction`` option. (i.e.
``sudo -u www-data php /var/www/nextcloud/updater/updater.phar --no-interaction``)
.. image:: images/updater-cli-8-no-interaction.png
:alt:
:class: terminal-image

16
admin_manual/maintenance/upgrade.rst
View file

@ -18,11 +18,11 @@ When an update is available for your Nextcloud server, you will see a
notification at the top of your Nextcloud Web interface. When you click the
notification it brings you here, to this page.
**It is best to keep your Nextcloud server upgraded regularly**, and to install
all point releases and major releases.
Major releases are 18, 19 or 20. Point releases are intermediate releases for each major release. For example 18.0.4 and 19.0.2 are point releases.
**It is best to keep your Nextcloud server upgraded regularly**, and to install
all point releases and major releases.
Major releases are 18, 19 or 20. Point releases are intermediate releases for each major release. For example 18.0.4 and 19.0.2 are point releases.
Nextcloud must be upgraded step by step:
Nextcloud must be upgraded step by step:
* Before you can upgrade to the next major release, Nextcloud upgrades to the latest point release.
* Then run the upgrade again to upgrade to the next major release's latest point release.
* **You cannot skip major releases.** Please re-run the upgrade until you have reached the highest available (or applicable) release.
@ -45,11 +45,11 @@ Update notifications
Nextcloud has an update notification app, that informs the administrator about
the availability of an update. Then you decide which update method to use.
.. image:: images/2-updates.png
:alt:
.. figure:: images/2-updates.png
:alt: Both update notifications displayed on Admin page.
The update notification is shown on every page, and the Updates section can be
found on the admin page*
*Figure 1: The top banner is the update notification that is shown on every
page, and the Updates section can be found in the admin page*
From there the web based updater can be used to fetch this new code. There is
also an CLI based updater available, that does exactly the same as the web

8
build/generateIconsDoc.php
View file

@ -104,7 +104,7 @@ foreach($icons as $class => $icon) {
$outPath = $destinationDirectory . 'img/' . $path . '.png';
// filling the rst file
$rst .= ".. image:: img/$path.*\n";
$rst .= ".. figure:: img/$path.*\n";
if ($isWhite) {
$rst .= " :class: white-icon\n";
}
@ -118,7 +118,7 @@ foreach($icons as $class => $icon) {
print(" - creating dir $dir \n");
mkdir($dir, 0777, true);
}
// ! can't use svg in rst
// copy original icon
// if (!@copy($sourceDirectory . $icon . '.svg', $destinationDirectory . 'img/' . $path . '.svg')) {
@ -159,5 +159,7 @@ print(" - done! \n");
// path = path.split('/')
// localpath = '/'.join(path[3:5])
// result += ".. image:: img/" + localpath + ".*\n :height: 32\n :width: 32\n\n " + icon[1:] + "\n\n"
// result += ".. figure:: img/" + localpath + ".*\n :height: 32\n :width: 32\n\n " + icon[1:] + "\n\n"
// os.system('inkscape -z img/' + localpath + '.svg -e img/' + localpath + '.png')

15
developer_manual/design/html.rst
View file

@ -13,8 +13,9 @@ Nextcloud support and provides an already themed progress bar.
Please use the html5 ``progress`` element.
.. image:: ../images/progress.png
:alt:
.. figure:: ../images/progress.png
:alt: Progress html5
:figclass: figure-with-code
.. code-block:: html
@ -39,8 +40,9 @@ Requirements:
* To use the white theme, you **need** to also add the ``checkbox--white`` or ``radio--white`` class.
* Your label **must** have an associated text for accessibility.
.. image:: ../images/checkboxes.png
:alt:
.. figure:: ../images/checkboxes.png
:alt: Nextcloud's themed checkboxes
:figclass: figure-with-code
.. code-block:: html
@ -55,8 +57,9 @@ Requirements:
<input type="checkbox" id="test4" class="checkbox">
<label for="test4">Hovered</label><br>
.. image:: ../images/radios.png
:alt:
.. figure:: ../images/radios.png
:alt: Nextcloud's themed radios
:figclass: figure-with-code
.. code-block:: html

11
developer_manual/design/list.rst
View file

@ -15,8 +15,8 @@ We provide a standardized structure for this specific purpose.
Basic layout
=============
.. image:: ../images/list.png
:alt:
.. figure:: ../images/list.png
:alt: Content list screenshot
.. code-block:: html
@ -83,7 +83,7 @@ Rules and information
* In case of a popovermenu, see the :ref:`popover menu <popovermenulist>`.
* As always, the **JS** is still needed to toggle the ``open`` class on this menu
* If you use the ``app-content-list`` standard, the ``app-content-details`` div will be hidden in mobile mode (full screen).
You will need to add the ``showdetails`` class to the ``app-content-list`` to show the main content.
You will need to add the ``showdetails`` class to the ``app-content-list`` to show the main content.
On mobile view, the whole list/details section (depending on which is shown) will scroll the body.
.. _popovermenulist:
@ -93,8 +93,9 @@ Popovermenu in item
If you need a menu inside an item, you need to wrap it with the ``icon-more`` ``div`` inside a ``app-content-list-menu`` div.
.. image:: ../images/list-menu.png
:alt:
.. figure:: ../images/list-menu.png
:alt: Content list with menu
:figclass: figure-with-code
.. code-block:: html

60
developer_manual/design/navigation.rst
View file

@ -31,8 +31,9 @@ The goal is to have an homogeneity of design across all apps using this button.
Basic layout
-------------
.. image:: ../images/newbutton.png
:alt:
.. figure:: ../images/newbutton.png
:alt: Navigation with a new button
:figclass: figure-with-code
.. code-block:: html
@ -80,8 +81,9 @@ We implemented various essential functions and provide easy way of using them.
Basic layout
------------
.. image:: ../images/navigation.png
:alt:
.. figure:: ../images/navigation.png
:alt: Navigation screenshot
:figclass: figure-with-code
.. code-block:: html
@ -145,8 +147,9 @@ The menu needs to be placed after the ``app-navigation-entry-utils``.
For the global rules and/or layout, you can check the dedicated :ref:`popover menu section <popovermenu>`.
.. image:: ../images/navigation-menu.png
:alt:
.. figure:: ../images/navigation-menu.png
:alt: Navigation menu
:figclass: figure-with-code
.. code-block:: html
@ -215,8 +218,9 @@ Counter
If you need to add a counter to your menu entry, you can simply use this structure.
Do not change the alignment of the text. If you're using
.. image:: ../images/navigation-counter.png
:alt:
.. figure:: ../images/navigation-counter.png
:alt: Navigation entry with counter
:figclass: figure-with-code
.. code-block:: html
@ -247,8 +251,9 @@ Highlighted counter
The counter can also be highlighted to attract some focus, e.g. for unread chat messages
.. image:: ../images/navigation-counter-highlighted.png
:alt:
.. figure:: ../images/navigation-counter-highlighted.png
:alt: Navigation entry with highlighted counter
:figclass: figure-with-code
.. code-block:: html
@ -264,8 +269,9 @@ The same way we display the menu three-dot-icon button, you're allowed to use up
* The icon class goes directly on the ``button`` element.
* If no class is set, the three-dot-icon will be used by default
.. image:: ../images/navigation-buttons.png
:alt:
.. figure:: ../images/navigation-buttons.png
:alt: Navigation entry with counter
:figclass: figure-with-code
.. code-block:: html
@ -320,8 +326,9 @@ The opening of the menu is activated and animated by the class ``open`` on the m
* If your top-level link is only used as a header, the **entire** ``a`` needs to be used to toggle the ``open`` class.
* If your top-level link is used to redirect the user or to trigger something else, you **need** to add the collapsible button and use it as the ``open`` class toggle trigger.
.. image:: ../images/navigation-collapsible.*
:alt:
.. figure:: ../images/navigation-collapsible.*
:alt: Collapsible navigation entry
:figclass: figure-with-code
.. code-block:: html
@ -350,8 +357,9 @@ We call it a `bullet`.
* You can **not** combine an icon with a bullet.
* You need to use the CSS to define the bullet color.
.. image:: ../images/navigation-bullet.png
:alt:
.. figure:: ../images/navigation-bullet.png
:alt: Navigation entry with bullet
:figclass: figure-with-code
.. code-block:: html
@ -368,8 +376,9 @@ Undo entry
* Please use the sentence *Deleted XXXX* as the feedback message.
* You need to use the ``deleted`` class to trigger the animated hide/show of the undo entry.
.. image:: ../images/navigation-undo.*
:alt:
.. figure:: ../images/navigation-undo.*
:alt: Navigation entry with undo action
:figclass: figure-with-code
.. code-block:: html
@ -397,8 +406,9 @@ Edit entry
* You're allowed to use only one submit input. It **must** be the validation button.
* The input **must** have the same value as the entry link text.
.. image:: ../images/navigation-edit.*
:alt:
.. figure:: ../images/navigation-edit.*
:alt: Editable navigation entry
:figclass: figure-with-code
.. code-block:: html
@ -429,8 +439,9 @@ Every top-level entry can be `pinned` at the bottom.
* All the pinned entries **must** have the ``pinned`` class.
* The **first** pinned entry **must** also have the ``first-pinned`` class.
.. image:: ../images/navigation-pinned.png
:alt:
.. figure:: ../images/navigation-pinned.png
:alt: Pinned navigation entries
:figclass: figure-with-code
.. code-block:: html
@ -471,8 +482,9 @@ To create a settings area create a div with the id ``app-settings`` inside the `
Basic layout
-------------
.. image:: ../images/settings.*
:alt:
.. figure:: ../images/settings.*
:alt: Settings
:figclass: figure-with-code
.. code-block:: html

10
developer_manual/design/popovermenu.rst
View file

@ -9,15 +9,16 @@ Popover menu
What is a popover menu
----------------------
This is a quick menu that opens on click. For menus, we use the three-dot-icon.
This is a quick menu that open on click. For menus, we use the three-dot-icon.
This is exactly the same as the :ref:`navigation menu <navigation_menu>`. The only difference is the popovermenu class.
Basic layout
------------
.. image:: ../images/popovermenu.png
:alt:
.. figure:: ../images/popovermenu.png
:alt: Popover image example
:figclass: figure-with-code
.. code-block:: html
@ -91,11 +92,10 @@ Technical details
* The required **right** distance to the border (or padding, whatever you want to use) of the three-dot icon should be 14px (5 for menu margin and 6 for arrow position)
* The ``span`` element **must** have the ``menuitem`` class.
* The checkbox/radio must use the :ref:`nextcloud custom <checkboxes-and-radios>`
* The form element is optional if you're using inputs.
* The form element is optionnal if you're using inputs.
* Supported inputs are all text based ones and buttons type ones
.. image:: ../images/popover-position.png
:alt:
Alignment
---------

7
developer_manual/prologue/bugtracker/triaging.rst
View file

@ -67,8 +67,7 @@ Much content from https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging
The goal of triaging is to have only useful bug reports for the developers. And you don't have to know much to be able to judge at least some bug reports to be less than useful. There are duplications, incomplete reports and so on. Here is the work flow for each bug:
.. image:: ../images/triageworkflow.png
:alt:
.. figure:: ../images/triageworkflow.png
:scale: 50
Let's go over each step.
@ -85,7 +84,7 @@ If you can't find anything, look in closed bug reports. The problem might be sol
When the issue is a feature request, you can be helpful in the same way: merge related requests by adding information of one to the other and closing the first.
.. note:: Be polite: when you need to request information or feedback be clear and polite, and you will get more information in less time. Think about how you'd like to be treated, were you to report a bug!
.. note:: You can answer more quickly and friendly using one of `these templates <https://gist.github.com/jancborchardt/6155185#clean-up-inactive-issues>`_.
.. note:: You can answer more quickly and friendly using one of `these templates <https://gist.github.com/jancborchardt/6155185#clean-up-inactive-issues>`_.
.. note:: Often our GitHub issue tracker is a place for discussions about solutions. Be friendly, inclusive and respect other people's position.
Determining relevance of issue
@ -130,3 +129,5 @@ Now, the developers can pick the issue up. Note that while we wish we would alwa
**Credit:** this document is in debt to the extensive `KDE guide to bug triaging <https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging>`_.

82
style_guide.rst
View file

@ -6,22 +6,22 @@ Nextcloud manuals style guide
See the `Documentation README <https://github.com/nextcloud/documentation/blob/master/README.rst>`_ for information on setting up your documentation build environment
See `reStructuredText Primer <http://sphinx-doc.org/rest.html>`_ for a complete
See `reStructuredText Primer <http://sphinx-doc.org/rest.html>`_ for a complete
Sphinx/RST markup reference.
This is the official style guide for the Nextcloud Administration and User
manuals. Please follow these conventions for consistency, and easier
This is the official style guide for the Nextcloud Administration and User
manuals. Please follow these conventions for consistency, and easier
proofreading and copyediting.
When you are writing your text, make it as literal and specific as possible. Put
yourself in the place of the person who is using Nextcloud and looking for
instructions on performing a task. Don't make them guess, but spell
out every step in order, and tell exactly what buttons to click or what form
fields to fill out. Give complete information; for example, when configuring a
timeout value be sure to say if it is in seconds or some other value. Say
``config.php`` rather than "the configuration file". When you are describing
features of a GUI administration form use the exact literal names of buttons,
form fields, and menus. Specify if menus are dropdown, right-click,
When you are writing your text, make it as literal and specific as possible. Put
yourself in the place of the person who is using Nextcloud and looking for
instructions on performing a task. Don't make them guess, but spell
out every step in order, and tell exactly what buttons to click or what form
fields to fill out. Give complete information; for example, when configuring a
timeout value be sure to say if it is in seconds or some other value. Say
``config.php`` rather than "the configuration file". When you are describing
features of a GUI administration form use the exact literal names of buttons,
form fields, and menus. Specify if menus are dropdown, right-click,
left-click, or mouseover.
Page filenames
@ -32,8 +32,8 @@ Use lowercase filenames with underscores, for example file_name_config.rst.
Page titles and headings
------------------------
There are many ways to markup headings and subheadings. This is the official
Nextcloud way. Use sentence case. Three levels is enough; if you find that you want more,
There are many ways to markup headings and subheadings. This is the official
Nextcloud way. Use sentence case. Three levels is enough; if you find that you want more,
then re-think the organization of your text::
==============
@ -45,7 +45,7 @@ then re-think the organization of your text::
Subhead, h3
^^^^^^^^^^^
This is how they render:
==============
@ -61,9 +61,9 @@ Subhead, h3
Labels and code
---------------
Elements in a GUI configuration form are in bold, and should be described as
literally as possible, so that your description matches what your reader sees
on the screen. For example, on the User listing page describe the various
Elements in a GUI configuration form are in bold, and should be described as
literally as possible, so that your description matches what your reader sees
on the screen. For example, on the User listing page describe the various
elements like these examples::
**Username** field
@ -72,9 +72,9 @@ elements like these examples::
**Create** button
**Full Name** field
**Quota** dropdown menu
This is how they render:
**Username** field
**Password** field
@ -87,21 +87,23 @@ This is how they render:
**Quota** dropdown menu
.. image:: users-config.png
:alt:
.. figure:: users-config.png
:alt: User listings and administration page.
*Figure 1: The Nextcloud user listing and administration page.*
Use double-backticks for inline code and command examples::
``sudo -u www-data php occ files:scan --help``
``maintenance:install``
This is how they render:
``sudo -u www-data php occ files:scan --help``
``maintenance:install``
When you are giving hyperlinks as examples, use double-backticks rather than
When you are giving hyperlinks as examples, use double-backticks rather than
creating a live hyperlink::
``https://example.com``
@ -111,22 +113,26 @@ Images
Use lowercase with hyphens for image names, for example image-name.png.
Images should be in .png format. Keep your screenshots focused on the items you
are describing. When you need an image of something large like a configuration
form on the Nextcloud admin page, narrow your Web browser to fold the fields
into a smaller space, because a long skinny graphic is not very readable. Think
Images should be in .png format. Keep your screenshots focused on the items you
are describing. When you need an image of something large like a configuration
form on the Nextcloud admin page, narrow your Web browser to fold the fields
into a smaller space, because a long skinny graphic is not very readable. Think
square.
The text should be readable and accessible without the need of the images.
This is why we use the image element instead of figure, with a present but empty
alt tag because it would duplicate info when read out by a screen reader::
Both images and figures must have brief and descriptive alt tags and all
figures must have captions with figure numbers. Sphinx RST markup does not
have a tag for figure numbers, so you must
use the caption element. You may use simple numbering like "Figure 1, Figure 2",
or add a caption. Captions must follow a blank line and be italicized, like this example::
.. image:: images/users-config.png
:alt:
.. figure:: images/users-config.png
:alt: User listings and administration page.
*Figure 1: The Nextcloud user listing and administration page.*
Images must go into a sub-directory of the directory containing your manual
page. Currently the manuals have both a single master images directory, and
image directories local to each chapter. A single master images directory is
Images must go into a sub-directory of the directory containing your manual
page. Currently the manuals have both a single master images directory, and
image directories local to each chapter. A single master images directory is
difficult to maintain and inevitably becomes cluttered with obsolete images. Eventually
the single master directories will be gone.

60
user_manual/_templates/versions.html
View file

@ -9,66 +9,6 @@
<div class="rst-other-versions">
<dl>
<dt>Languages</dt>
<dd><a href="/server/latest/user_manual/ar/">ar</a></dd>
<dd><a href="/server/latest/user_manual/br/">br</a></dd>
<dd><a href="/server/latest/user_manual/ca/">ca</a></dd>
<dd><a href="/server/latest/user_manual/cs/">cs</a></dd>
<dd><a href="/server/latest/user_manual/da/">da</a></dd>
<dd><a href="/server/latest/user_manual/de/">de</a></dd>
<dd><a href="/server/latest/user_manual/el/">el</a></dd>
<dd><a href="/server/latest/user_manual/en/">en</a></dd>
<dd><a href="/server/latest/user_manual/es/">es</a></dd>
<dd><a href="/server/latest/user_manual/fr/">fr</a></dd>
<dd><a href="/server/latest/user_manual/gl/">gl</a></dd>
<dd><a href="/server/latest/user_manual/it/">it</a></dd>
<dd><a href="/server/latest/user_manual/nl/">nl</a></dd>
<dd><a href="/server/latest/user_manual/pl/">pl</a></dd>
<dd><a href="/server/latest/user_manual/pt_BR/">pt_BR</a></dd>
<dd><a href="/server/latest/user_manual/ru/">ru</a></dd>
<dd><a href="/server/latest/user_manual/sk_SK/">sk_SK</a></dd>
<dd><a href="/server/latest/user_manual/sv/">sv</a></dd>
<dd><a href="/server/latest/user_manual/zh_CN/">zh_CN</a></dd>
<dd><a href="/server/latest/user_manual/zh_HK/">zh_HK</a></dd>
<dd><a href="/server/latest/user_manual/ar/">ar</a></dd>
<dd><a href="/server/latest/user_manual/br/">br</a></dd>
<dd><a href="/server/latest/user_manual/ca/">ca</a></dd>
<dd><a href="/server/latest/user_manual/cs/">cs</a></dd>
<dd><a href="/server/latest/user_manual/da/">da</a></dd>
<dd><a href="/server/latest/user_manual/de/">de</a></dd>
<dd><a href="/server/latest/user_manual/el/">el</a></dd>
<dd><a href="/server/latest/user_manual/en/">en</a></dd>
<dd><a href="/server/latest/user_manual/es/">es</a></dd>
<dd><a href="/server/latest/user_manual/fr/">fr</a></dd>
<dd><a href="/server/latest/user_manual/gl/">gl</a></dd>
<dd><a href="/server/latest/user_manual/it/">it</a></dd>
<dd><a href="/server/latest/user_manual/nl/">nl</a></dd>
<dd><a href="/server/latest/user_manual/pl/">pl</a></dd>
<dd><a href="/server/latest/user_manual/pt_BR/">pt_BR</a></dd>
<dd><a href="/server/latest/user_manual/ru/">ru</a></dd>
<dd><a href="/server/latest/user_manual/sk_SK/">sk_SK</a></dd>
<dd><a href="/server/latest/user_manual/sv/">sv</a></dd>
<dd><a href="/server/latest/user_manual/zh_CN/">zh_CN</a></dd>
<dd><a href="/server/latest/user_manual/zh_HK/">zh_HK</a></dd>
<dd><a href="/server/latest/user_manual/ar/">ar</a></dd>
<dd><a href="/server/latest/user_manual/br/">br</a></dd>
<dd><a href="/server/latest/user_manual/ca/">ca</a></dd>
<dd><a href="/server/latest/user_manual/cs/">cs</a></dd>
<dd><a href="/server/latest/user_manual/da/">da</a></dd>
<dd><a href="/server/latest/user_manual/de/">de</a></dd>
<dd><a href="/server/latest/user_manual/el/">el</a></dd>
<dd><a href="/server/latest/user_manual/en/">en</a></dd>
<dd><a href="/server/latest/user_manual/es/">es</a></dd>
<dd><a href="/server/latest/user_manual/fr/">fr</a></dd>
<dd><a href="/server/latest/user_manual/gl/">gl</a></dd>
<dd><a href="/server/latest/user_manual/it/">it</a></dd>
<dd><a href="/server/latest/user_manual/nl/">nl</a></dd>
<dd><a href="/server/latest/user_manual/pl/">pl</a></dd>
<dd><a href="/server/latest/user_manual/pt_BR/">pt_BR</a></dd>
<dd><a href="/server/latest/user_manual/ru/">ru</a></dd>
<dd><a href="/server/latest/user_manual/sk_SK/">sk_SK</a></dd>
<dd><a href="/server/latest/user_manual/sv/">sv</a></dd>
<dd><a href="/server/latest/user_manual/zh_CN/">zh_CN</a></dd>
<dd><a href="/server/latest/user_manual/zh_HK/">zh_HK</a></dd>
<!--Here goes the Langs-->
</dl>
</div>

14
user_manual/files/access_webdav.rst
View file

@ -74,7 +74,7 @@ share::
of ``davs://``:
.. image:: ../images/webdav_gnome3_nautilus.png
:alt:
:alt: screenshot of configuring Nautilus file manager to use WebDAV
.. note:: The same method works for other file managers that use GVfs,
such as MATE's Caja and Cinnamon's Nepomuk.
@ -89,7 +89,7 @@ the ``webdav://`` protocol::
webdav://example.com/nextcloud/remote.php/dav/files/USERNAME/
.. image:: ../images/webdav_dolphin.png
:alt:
:alt: screenshot of configuring Dolphin file manager to use WebDAV
You can create a permanent link to your Nextcloud server:
@ -216,14 +216,14 @@ To access files through the macOS Finder:
1. From the Finder’s top menu bar, choose **Go > Connect to Server…**:
.. image:: ../images/osx_webdav1.png
:alt:
:alt: Screenshot of entering your Nextcloud server address on macOS
2. When the **Connect to Server…** window opens, enter your Nextcloud server’s WebDAV address in the **Server Address:** field, i.e.::
https://cloud.YOURDOMAIN.com/remote.php/dav/files/USERNAME/
.. image:: ../images/osx_webdav2.png
:alt:
:alt: Screenshot: Enter Nextcloud server address in “Connect to Server...” dialog box
3. Click **Connect**. Your WebDAV server should appear on the Desktop as a shared disk drive.
@ -239,7 +239,7 @@ Using this feature requires network connectivity. If you want to store your
files offline, use the Desktop Client to sync all files on your
Nextcloud to one or more directories of your local hard drive.
.. note:: Windows 10 now defaults to allow Basic Authentication if HTTPS is
.. note:: Windows 10 now defaults to allow Basic Authentication if HTTPS is
enabled prior to mapping your drive. On older versions of Windows,
you must permit the use of Basic Authentication in the Windows
Registry: launch “regedit“ and navigate to
@ -301,9 +301,9 @@ To map a drive using the Microsoft Windows Explorer:
connect to the Nextcloud server as a different user, check **Connect using
different credentials**.
.. image:: ../images/explorer_webdav.png
.. figure:: ../images/explorer_webdav.png
:scale: 80%
:alt:
:alt: screenshot of mapping WebDAV on Windows Explorer
5. Click the ``Finish`` button.

50
user_manual/files/access_webgui.rst
View file

@ -7,8 +7,8 @@ preview, edit, delete, share, and re-share files. Your Nextcloud administrator
has the option to disable these features, so if any of them are missing on your
system ask your server administrator.
.. image:: ../images/users-files.png
:alt:
.. figure:: ../images/users-files.png
:alt: The Files view screen.
Tagging files
-------------
@ -18,13 +18,13 @@ Then type your tags. To enter more than one tag press the return key after
creating each tag. All tags are system tags, and are shared by all users on your
Nextcloud server.
.. image:: ../images/files_page-7.png
:alt:
.. figure:: ../images/files_page-7.png
:alt: Creating file tags.
Then use the Tags filter on the left sidebar to filter files by tags:
.. image:: ../images/files_page-8.png
:alt:
.. figure:: ../images/files_page-8.png
:alt: Viewing file tags.
Comments
--------
@ -32,8 +32,8 @@ Comments
Use the Details view to add and read comments on any file or folder. Comments
are visible to everyone who has access to the file:
.. image:: ../images/file_menu_comments_2.png
:alt:
.. figure:: ../images/file_menu_comments_2.png
:alt: Creating and viewing comments.
Video player
------------
@ -43,8 +43,8 @@ the file. Video streaming by the native Nextcloud video player depends on your W
and the video format. If your Nextcloud administrator has enabled video
streaming, and it doesn't work in your Web browser, it may be a browser issue. See https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats#Browser_compatibility for supported multimedia formats in Web browsers.
.. image:: ../images/video_player_2.png
:alt:
.. figure:: ../images/video_player_2.png
:alt: Watching a movie.
File controls
-------------
@ -55,10 +55,10 @@ over a file or folder to expose the controls for the following operations:
Favorites
Click the star to the left of the file icon to mark it as a favorite:
.. image:: ../images/files_page-1.png
:alt:
.. figure:: ../images/files_page-1.png
:alt: Marking Favorite files.
You can also quickly find all of your favorites with the Favorites filter on the left
sidebar.
@ -66,13 +66,13 @@ Overflow Menu
The Overflow menu (three dots) displays file details, and allows you to
rename, download, or delete files:
.. image:: ../images/files_page-3.png
:alt:
.. figure:: ../images/files_page-3.png
:alt: Overflow menu.
The Details view shows Activities, Sharing, and Versions information:
.. image:: ../images/files_page-4.png
:alt:
.. figure:: ../images/files_page-4.png
:alt: Details screen.
The **Settings** gear icon at the lower left allows you to show or hide hidden
files in your Nextcloud Web interface. These are also called dotfiles, because
@ -81,8 +81,8 @@ system to hide these files in your file browsers, unless you choose to display
them. Usually these are configuration files, so having the option to hide them
reduces clutter.
.. image:: ../images/hidden_files.png
:alt:
.. figure:: ../images/hidden_files.png
:alt: Hiding or displaying hidden files.
Previewing files
----------------
@ -107,8 +107,8 @@ Sharing status icons
Any folder that has been shared is marked with the ``Shared`` overlay icon.
Public link shares are marked with a chain link. Unshared folders are not marked:
.. image:: ../images/files_page-5.png
:alt:
.. figure:: ../images/files_page-5.png
:alt: Share status icons.
Creating or uploading files and directories
-------------------------------------------
@ -116,8 +116,8 @@ Creating or uploading files and directories
Upload or create new files or folders directly in a Nextcloud folder by clicking
on the *New* button in the Files app:
.. image:: ../images/files_page-6.png
:alt:
.. figure:: ../images/files_page-6.png
:alt: The New file/folder/upload menu.
The *New* button provides the following options:
@ -179,5 +179,5 @@ Creating or connecting to a Federation Share link
-------------------------------------------------
Federated Cloud Sharing allows you to mount file shares from remote Nextcloud
servers, and manage them just like a local share. See :doc:`federated_cloud_sharing`
servers, and manage them just like a local share. See :doc:`federated_cloud_sharing`
to learn to how to create and connect to new Federated Cloud shares.

9
user_manual/files/encrypting_files.rst
View file

@ -77,14 +77,12 @@ out and then log back in to create your encryption keys and encrypt your files.
When encryption has been enabled on your Nextcloud server you will see a yellow
banner on your Files page warning you to log out and then log back in:
.. image:: ../images/encryption1.png
:alt:
.. figure:: ../images/encryption1.png
When you log back in it takes a few minutes to work, depending on how many
files you have, and then you are returned to your default Nextcloud page.
.. image:: ../images/encryption2.png
:alt:
.. figure:: ../images/encryption2.png
.. note:: You must never lose your Nextcloud password, because you will lose
@ -119,8 +117,7 @@ enables the administrator to recover your files in the event you lose your
Nextcloud password. If the recovery key is not enabled, then there is no way to
restore your files if you lose your login password.
.. image:: ../images/encryption3.png
:alt:
.. figure:: ../images/encryption3.png
Files not encrypted
-------------------

44
user_manual/files/federated_cloud_sharing.rst
View file

@ -2,8 +2,8 @@
Using Federation Shares
=======================
Federation Sharing allows you to mount file shares from remote Nextcloud servers, in effect
creating your own cloud of Nextclouds. You can create direct share links with
Federation Sharing allows you to mount file shares from remote Nextcloud servers, in effect
creating your own cloud of Nextclouds. You can create direct share links with
users on other Nextcloud servers.
Creating a new Federation Share
@ -12,20 +12,19 @@ Creating a new Federation Share
Federation sharing is enabled on new or upgraded Nextcloud installations
by default. Follow these steps to create a new share with other Nextcloud or ownCloud 9+ servers:
1. Go to your ``Files`` page and click the **Share** icon on the file or directory
1. Go to your ``Files`` page and click the **Share** icon on the file or directory
you want to share. In the sidebar enter the username and URL of the remote user
in this form: ``<username>@<oc-server-url>``. The form automatically confirms the address
that you type and labels it as "remote". Click on the label.
.. image:: ../images/direct-share-1.png
:alt:
.. figure:: ../images/direct-share-1.png
2. When your local Nextcloud server makes a successful connection with the remote
Nextcloud server you'll see a confirmation. Your only share option is **Can
edit**.
Click the Share button anytime to see who you have shared your file with. Remove
your linked share anytime by clicking the trash can icon. This only unlinks the
Nextcloud server you'll see a confirmation. Your only share option is **Can
edit**.
Click the Share button anytime to see who you have shared your file with. Remove
your linked share anytime by clicking the trash can icon. This only unlinks the
share, and does not delete any files.
Creating a new Federated Cloud Share via email
@ -33,28 +32,25 @@ Creating a new Federated Cloud Share via email
Use this method when you are sharing with users on ownCloud 8.x and older.
What if you do not know the username or URL? Then you can have Nextcloud create
the link for you and email it to your recipient.
What if you do not know the username or URL? Then you can have Nextcloud create
the link for you and email it to your recipient.
.. image:: ../images/create_public_share-6.png
:alt:
.. figure:: ../images/create_public_share-6.png
When your recipient receives your email they will have to take a number of
steps to complete the share link. First they must open the link you sent them in
When your recipient receives your email they will have to take a number of
steps to complete the share link. First they must open the link you sent them in
a Web browser, and then click the **Add to your Nextcloud** button.
.. image:: ../images/create_public_share-8.png
:alt:
.. figure:: ../images/create_public_share-8.png
The **Add to your Nextcloud** button changes to a form field, and your recipient
The **Add to your Nextcloud** button changes to a form field, and your recipient
needs to enter the URL of their Nextcloud or ownCloud server in this field and press the
return key, or click the arrow.
.. image:: ../images/create_public_share-9.png
:alt:
.. figure:: ../images/create_public_share-9.png
Next, they will see a dialog asking to confirm. All they have to do is click
Next, they will see a dialog asking to confirm. All they have to do is click
the **Add remote share** button and they're finished.
Remove your linked share anytime by clicking the trash can icon. This only
Remove your linked share anytime by clicking the trash can icon. This only
unlinks the share, and does not delete any files.

4
user_manual/files/file_drop.rst
View file

@ -16,12 +16,10 @@ Go to Files and create or choose the folder, the anonymous upload should be
made to:
.. image:: ../images/anonym_click_sharing.png
:alt:
Check Share Link, Allow editing, Hide file listing:
.. image:: ../images/anonym_hide_file_listing.png
:alt:
Now you can send the link to the upload folder manually or by using the
Nextcloud send function, if your administrator has enabled it.
@ -35,7 +33,6 @@ folder, click the link, and then you'll see a Nextcloud page with a "**Click to
upload**" button:
.. image:: ../images/anonym_upload.png
:alt:
This opens a file picker, and you select the file or directory you want to
upload. You're also able to just drop files into the window.
@ -43,4 +40,3 @@ upload. You're also able to just drop files into the window.
When your upload is completed, the filenames are listed:
.. image:: ../images/anonym_uploaded_files.png
:alt:

14
user_manual/files/projects.rst
View file

@ -7,20 +7,17 @@ Users can associate files, chats and other items with each other in projects. Th
Create a new project
--------------------
A new project can be created by linking two items together. Start off by opening a file or folders sharing sidebar.
A new project can be created by linking two items together. Start off by opening a file or folders sharing sidebar.
.. image:: ../images/projects1.png
:alt:
.. figure:: ../images/projects1.png
Click *Add to a project* and select the type of item you want to link with the current file/folder. A selector will open that allows you selecting a Talk conversation for example.
.. image:: ../images/projects2.png
:alt:
.. figure:: ../images/projects2.png
Once the item has been selected a new project is being created and listed in the sharing tab of the sidebar. The same project will also appear in the sharing sidebar of the linked items.
.. image:: ../images/projects3.png
:alt:
.. figure:: ../images/projects3.png
The list entry shows quick links to a limited number of items. By opening the context menu, the project can be renamed and the full list of items can be expanded.
@ -30,8 +27,7 @@ Adding more entries to a project
If another item should be added to an already existing project this can be done by searching for the project name in the *Add to a project* picker.
.. image:: ../images/projects4.png
:alt:
.. figure:: ../images/projects4.png
Visibility of projects
----------------------

33
user_manual/files/quota.rst
View file

@ -5,35 +5,34 @@ Storage quota
Your Nextcloud admin has the option to set a storage quota on users. Look at
your the Personal page to see what your quota is, and how much you have used.
.. image:: ../images/quota1.png
:alt:
.. figure:: ../images/quota1.png
It may be helpful to understand how your quota is calculated.
It may be helpful to understand how your quota is calculated.
Metadata (thumbnails, temporary files, cache, and encryption keys) takes up
about 10% of disk space, but is not counted against user quotas. Some apps
store information in the database, such as the Calendar and Contacts apps. This
Metadata (thumbnails, temporary files, cache, and encryption keys) takes up
about 10% of disk space, but is not counted against user quotas. Some apps
store information in the database, such as the Calendar and Contacts apps. This
data is excluded from your quota.
When other users share files with you, the shared files count against the
original share owner's quota. When you share a folder and allow other users or
groups to upload files to it, all uploaded and edited files count against your
quota. When you re-share files shared with you, the re-share still counts
When other users share files with you, the shared files count against the
original share owner's quota. When you share a folder and allow other users or
groups to upload files to it, all uploaded and edited files count against your
quota. When you re-share files shared with you, the re-share still counts
against the quota of the original share owner.
Encrypted files are a little larger than unencrypted files; the unencrypted size
Encrypted files are a little larger than unencrypted files; the unencrypted size
is calculated against your quota.
Deleted files that are still in the trash bin do not count against quotas. The
trash bin is set at 50% of quota. Deleted file aging is set at 30 days. When
deleted files exceed 50% of quota then the oldest files are removed until the
Deleted files that are still in the trash bin do not count against quotas. The
trash bin is set at 50% of quota. Deleted file aging is set at 30 days. When
deleted files exceed 50% of quota then the oldest files are removed until the
total is below 50%.
.. note:: Your administrator may have configured the trash bin retention period
.. note:: Your administrator may have configured the trash bin retention period
to override the storage space management. See `admin documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#deleted-items-trash-bin>`_ for more details.
When version control is enabled, the older file versions are not counted against
When version control is enabled, the older file versions are not counted against
quotas.
If you create a public share via URL and allow uploads, any uploaded files
If you create a public share via URL and allow uploads, any uploaded files
count against your quota.

40
user_manual/files/sharing.rst
View file

@ -24,8 +24,7 @@ A random 15-digit token will be created. The link will look like ``https://cloud
A number of options are available for public *folder* shares:
.. image:: ../images/sharing_public_folder.png
:alt:
.. figure:: ../images/sharing_public_folder.png
* **Read only** to allow viewing and downloading
* **Allow upload and editing**
@ -39,8 +38,7 @@ A number of options are available for public *folder* shares:
For public *file* shares, you may allow editing the file with one of Nextcloud's collaborative editing solutions:
.. image:: ../images/sharing_public_file.png
:alt:
.. figure:: ../images/sharing_public_file.png
Internal shares with users and groups
@ -48,35 +46,30 @@ Internal shares with users and groups
When sharing with users, groups, circles or members of a Talk conversation, rights for the files or folder contents are adjustable:
.. image:: ../images/sharing_internal.png
:alt:
.. figure:: ../images/sharing_internal.png
As a sharee, you can configure if you automatically want to accept all incoming shares and have them added to your root folder, or if you
As a sharee, you can configure if you automatically want to accept all incoming shares and have them added to your root folder, or if you
want to be asked each time if you want to accept or decline the share.
.. image:: ../images/sharing_internal_acceptNotification.png
:alt:
.. figure:: ../images/sharing_internal_acceptNotification.png
For adjusting the acceptance setting, go to **Settings** > **Personal** > **Sharing**:
.. image:: ../images/sharing_autoAcceptSetting.png
:alt:
.. figure:: ../images/sharing_autoAcceptSetting.png
Others with access
------------------
In order to find out if a file or folder is accessible to others through sharing of a superior folder
In order to find out if a file or folder is accessible to others through sharing of a superior folder
hierarchy level, click on **Others with access** in the sharing tab:
.. image:: ../images/sharing_others-with-access__collapsed.png
:alt:
.. figure:: ../images/sharing_others-with-access__collapsed.png
The list shows all users, groups, chats etc. that the current object has been given access to through
sharing of a superior folder in the hierarchy:
.. image:: ../images/sharing_others-with-access__details.png
:alt:
.. figure:: ../images/sharing_others-with-access__details.png
Click on the three dots to:
@ -92,8 +85,8 @@ Click on the three dots to:
Federated Shares
================
Federation Sharing allows you to mount file shares from remote Nextcloud servers, in effect
creating your own cloud of Nextclouds. You can create direct share links with
Federation Sharing allows you to mount file shares from remote Nextcloud servers, in effect
creating your own cloud of Nextclouds. You can create direct share links with
users on other Nextcloud servers.
Creating a new Federation Share
@ -101,18 +94,16 @@ Creating a new Federation Share
Federation sharing is enabled by default. Follow these steps to create a new share with other Nextcloud or ownCloud servers:
Go to your ``Files`` page and click the Share icon on the file or directory
Go to your ``Files`` page and click the Share icon on the file or directory
you want to share. In the sidebar enter the username and URL of the remote user
in this form: ``<username>@<nc-server-url>``. In this example, that is
``bob@cloud.example.com``:
.. image:: ../images/share-federation-1.png
:alt:
.. figure:: ../images/share-federation-1.png
The sharee is receiving a notification in their Nextcloud, allowing them to either accept or decline the incoming share:
.. image:: ../images/share-federation-2-notification.png
:alt:
.. figure:: ../images/share-federation-2-notification.png
Adding a public share to your Nextcloud
@ -121,5 +112,4 @@ Adding a public share to your Nextcloud
Nextcloud public link share pages offer an option to add that file or folder as a federated share into your own Nextcloud instance.
Just enter your ``<username>@<nc-server-url>`` just like shown for outbound shares above:
.. image:: ../images/share-federation-3-public.png
:alt:
.. figure:: ../images/share-federation-3-public.png

7
user_manual/files/transfer_ownership.rst
View file

@ -2,7 +2,7 @@
Transfer Ownership
==================
Users can transfer the ownership of files and folders to other users. Share
Users can transfer the ownership of files and folders to other users. Share
ownerships of those transfered files/folders will also be transferred.
#. Navigate to *Settings* > *Personal* > *Sharing* > *Files*.
@ -18,9 +18,8 @@ ownerships of those transfered files/folders will also be transferred.
#. The target user receives a notification where they are being asked whether to
accept or reject the incoming transfer.
.. image:: ../images/transfer_ownership-accept.png
:alt:
.. figure:: ../images/transfer_ownership-accept.png
#. If accepted, the target user finds the transferred files and folders in their
#. If accepted, the target user finds the transferred files and folders in their
root under a folder *Transferred from [user] on [timestamp]*.
#. The source user gets informed about the acceptance or rejection by a notification.

3
user_manual/files/version_control.rst
View file

@ -8,8 +8,7 @@ sidebar. This tab contains the history of the file where you can roll back a
file to any previous version. Changes made at intervals greater than two minutes
are saved in **data/[user]/files_versions**.
.. image:: ../images/files_versioning.png
:alt:
.. figure:: ../images/files_versioning.png
To restore a specific version of a file, click the circular arrow to the left.
Click on the timestamp to download it.

33
user_manual/pim/calendar.rst
View file

@ -11,8 +11,7 @@ sync your Nextcloud calendars and events with.
When you first access the Calendar app, a default first calendar will be
pre-generated for you.
.. image:: images/calendar_application.png
:alt:
.. figure:: images/calendar_application.png
Managing your calendars
-----------------------
@ -23,8 +22,7 @@ Import a Calendar
If you want to transfer your calendar and their respective events to your Nextcloud
instance, importing is the best way to do so.
.. image:: images/calendar_settings.png
:alt:
.. figure:: images/calendar_settings.png
:scale: 50%
1. Click on the settings-icon labeled with ``Settings & Import`` at the left-bottom.
@ -46,8 +44,7 @@ previous calendar, creating a new calendar is the way you should go.
.. only:: html
.. image:: images/calendar_create.gif
:alt:
.. figure:: images/calendar_create.gif
1. Click on ``+ New Calendar`` in the left sidebar.
@ -68,14 +65,12 @@ hard drive or delete it forever.
After deletion, there is no way of restoring the calendar unless you
have a local backup.
.. image:: images/calendar_dropdown.png
:alt:
.. figure:: images/calendar_dropdown.png
:scale: 50%
1. Click on the three-dot-menu of the respective calendar.
.. image:: images/calendar_editing.png
:alt:
.. figure:: images/calendar_editing.png
:scale: 50%
2. Click on ``Edit``, ``Download`` or ``Delete``.
@ -126,15 +121,13 @@ cursor over the area when the event is taking place.
.. only:: html
.. image:: images/calendar_new-event_week.gif
:alt:
.. figure:: images/calendar_new-event_week.gif
The month-view only requires a single click into the area of the specific day.
.. only:: html
.. image:: images/calendar_new-event_month.gif
:alt:
.. figure:: images/calendar_new-event_month.gif
After that, you can type in the events name (e.g. **Meeting with Lukas**), choose
the calendar in which you want to choose the event (e.g. **Personal**, **Work**)
@ -161,8 +154,7 @@ Clicking on the ``Update``-button will update the event. To cancel your changes,
If you open the sidebar view and click the three dot menu next to the event name, you have an option to export the event as an ``.ics`` file or remove the event from your calendar.
.. image:: images/calendar_event_menu.png
:alt:
.. figure:: images/calendar_event_menu.png
Invite attendees to an event
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -170,8 +162,7 @@ Invite attendees to an event
You may add attendees to an event to let them know they're invited. They will receive an email confirmation and will be able to confirm or cancel their participation to the event.
Attendees may be other users on your Nextcloud instances, contacts in your addressbooks and direct email addresses. You also may change the level of participation per-attendees, or disable email confirmation for a specific attendee.
.. image:: images/calendar_event_invitation_level.png
:alt:
.. figure:: images/calendar_event_invitation_level.png
.. tip:: When adding other Nextcloud users as attendees to an event, you may access their FreeBusy information if it's available, helping you to determine when is the best time slot for your event.
@ -187,8 +178,7 @@ You can set up reminders to be notified before an event occurs. Currently suppor
You may set reminders at a time relative to the event or at a specific date.
.. image:: images/calendar_event_reminders.png
:alt:
.. figure:: images/calendar_event_reminders.png
.. note:: Only the calendar owner and people or groups with whom the calendar is shared with write access will get notifications. If you don't get any notifications but think you should, your Administrator could also have disabled this for your server.
@ -202,8 +192,7 @@ An event may be set as "recurring", so that it can happen every day, week, month
You can also tell when the recurrence ends.
.. image:: images/calendar_event_repeat.png
:alt:
.. figure:: images/calendar_event_repeat.png
Birthday calendar
-----------------

51
user_manual/pim/contacts.rst
View file

@ -6,12 +6,12 @@ The Contacts app is not enabled by default in Nextcloud |version| and needs to
be installed separately from our App Store.
The Nextcloud Contacts app is similar to other mobile contact applications, but
with more functionality.
with more functionality.
Let's run through basic features that will help you maintain your address book
in the application.
in the application.
Below, you will learn how to add contacts, edit or remove contacts, upload a
contact picture and manage your Contact app address books.
Below, you will learn how to add contacts, edit or remove contacts, upload a
contact picture and manage your Contact app address books.
Adding Contacts
@ -19,14 +19,13 @@ Adding Contacts
When you first access the Contacts app, an empty default address book becomes available:
.. image:: ../images/contacts_empty.png
:alt:
.. figure:: ../images/contacts_empty.png
*Default Address Book (empty)*
To add contacts into your address book, you can use one of the following methods:
* Import contacts using a Virtual Contact File (VCF/Vcard) file
* Import contacts using a Virtual Contact File (VCF/Vcard) file
* Add contacts manually
The fastest way to add a contact is to use a Virtual Contact File
@ -40,19 +39,19 @@ To Import Contacts Using a VCF/Vcard File:
1. Find "Settings" at the bottom of the left sidebar, next to the gear button:
.. image:: ../images/contact_bottombar.png
:alt:
.. figure:: ../images/contact_bottombar.png
:alt: Contact settings gear button
2. Click the gear button. The Contacts app "Import" button will appear:
.. image:: ../images/contact_uploadbutton.png
:alt:
.. figure:: ../images/contact_uploadbutton.png
:alt: Contacts Upload Field
.. note:: The Contacts app only supports import of vCards version 3.0 and 4.0.
3. Click the "Import" button and upload your VCF/Vcard file.
3. Click the "Import" button and upload your VCF/Vcard file.
After the import is complete, you will see your new contact in your address book.
After the import is complete, you will see your new contact in your address book.
Adding Contacts Manually
@ -65,10 +64,9 @@ To Create a New Contact:
1. Click the ``+ New contact`` button.
An empty new contact configuration opens in the Application View field:
.. image:: ../images/contact_new.png
:alt:
.. figure:: ../images/contact_new.png
2. Specify the new contact information. Changes that you made are implemented immediately.
@ -91,19 +89,18 @@ Contact Picture
To add a picture for your new contacts, click on the upload button:
.. image:: ../images/contact_picture.png
:alt:
.. figure:: ../images/contact_picture.png
:alt: Contact picture (upload button)
After you have set a contact picture, it will look like this:
.. image:: ../images/contact_picture_set.png
:alt:
.. figure:: ../images/contact_picture_set.png
:alt: Contact picture (set)
If you want to upload a new one, remove it, view it in full size or download it,
click on the contacts picture for the following options to appear:
.. image:: ../images/contact_picture_options.png
:alt:
.. figure:: ../images/contact_picture_options.png
Adding and Managing Address Books
@ -114,8 +111,8 @@ provides access to Contacts app settings. This field shows all
available address books, certain options for each address book, and enables you
to create new address books, simply by specifying an address books name:
.. image:: ../images/contact_manageaddressbook.png
:alt:
.. figure:: ../images/contact_manageaddressbook.png
:alt: Add address book in the contacts settings
The Contacts settings is also where you can share, export and delete address
books. You will find the CardDAV URLs there.

12
user_manual/pim/sync_gnome.rst
View file

@ -6,7 +6,7 @@ The `GNOME desktop <https://www.gnome.org>`_ has built-in support for Nextcloud'
contacts and tasks which will be displayed by the Evolution PIM or the
Calendar, Tasks and Contacts app as well has for files, which it
integrates into the Nautilus file manager via WebDAV. The latter works
only while the computer is connected.
only while the computer is connected.
This can be done by following these steps:
@ -14,7 +14,6 @@ This can be done by following these steps:
2. Under "Add an account" pick ``Nextcloud``:
.. image:: ../images/gnome-online-accounts.png
:alt:
3. Enter your server URL, username and password. If you have enabled two
factor authentification, you need to generate an app-password/token, because GNOME Online Accounts
@ -22,13 +21,11 @@ This can be done by following these steps:
(`Learn more <https://docs.nextcloud.com/server/stable/user_manual/session_management.html#managing-devices>`_):
.. image:: ../images/goa-add-nextcloud-account.png
:alt:
4. In the next window, select which resources GNOME should access and
press the cross in the top left to close:
.. image:: ../images/goa-nextcloud-select.png
:alt:
Nextcloud tasks, calendars and contacts should now be visible in the
Evolution PIM, the task, contacts and calendars app.
@ -39,4 +36,5 @@ dialogues). Documents should be integrated into the GNOME Documents
app.
All resources should also be searchable from anywhere by pressing the Windows key and entering a
search term.
search term.

11
user_manual/pim/sync_kde.rst
View file

@ -9,47 +9,36 @@ This can be done by following these steps:
1. Open KOrganizer and in the calendar list (bottom left) right-click and choose ``Add Calendar``:
.. image:: ../images/KOrganizer_add_calendar.png
:alt:
2. In the resulting list of resources, pick ``DAV groupware resource``:
.. image:: ../images/korganizer_resource_choice.png
:alt:
3. Enter your username. As password, you need to generate an app-password/token (`Learn more <https://docs.nextcloud.com/server/stable/user_manual/session_management.html#managing-devices>`_):
.. image:: ../images/korganizer_credentials.png
:alt:
4. Choose ``ownCloud`` or ``Nextcloud`` as Groupware server option:
.. image:: ../images/KOrganizer_groupware_server.png
:alt:
5. Enter your Nextcloud server URL and, if needed, installation path (anything that comes after the first /, for example ``mynextcloud`` in ``https://exampe.com/mynextcloud``). Then click next:
.. image:: ../images/KOrganizer_server_address.png
:alt:
6. You can now test the connection, which can take some time for the initial connection. If it does not work, you can go back and try to fix it with other settings:
.. image:: ../images/KOrganizer_test1.png
:alt:
.. image:: ../images/KOrganizer_test2.png
:alt:
7. Pick a name for this resource, for example ``Work`` or ``Home``. By default, both CalDAV (Calendar) and CardDAV (Contacts) are synced:
.. image:: ../images/KOrganizer_pick_resources.png
:alt:
.. note:: You can set a manual refresh rate for your calendar and contacts resources. By default this setting is set to 5 minutes and should be fine for the most use cases. When you create a new appointment it is synced to Nextcloud right away. You may want to change this for saving your power or cellular data plan, that you can update with a right-click on the item in the calendar list.
8. After a few seconds to minutes depending on your internet connection, you will find your calendars and contacts inside the KDE Kontact applications KOrganizer and KAddressBook:
.. image:: ../images/KOrganizer.png
:alt:
.. image:: ../images/KAddressBook.png
:alt:

18
user_manual/pim/sync_osx.rst
View file

@ -5,21 +5,19 @@ Synchronizing with macOS
Setup your Accounts
-------------------
In the following steps you will add your server resources for **CalDAV** (Calendar)
In the following steps you will add your server resources for **CalDAV** (Calendar)
and **CardDAV** (Contacts) to your Nextcloud.
1. Open the **system preferences** of your macOS device.
2. Navigate to **Internet Accounts**:
.. image:: ./images/macos_1.png
:alt:
.. figure:: ./images/macos_1.png
3. Click on **Add Other Account…** and click on **CalDAV Account** for Calendar
or **CardDAV Account** for Contacts:
.. image:: ./images/macos_2.png
:alt:
.. figure:: ./images/macos_2.png
.. note:: You can not setup Calendar/Contacts together. You need to setup them
in **separate accounts**.
@ -27,13 +25,12 @@ and **CardDAV** (Contacts) to your Nextcloud.
4. Select **Manual** as Account-Type and type in your respective credentials:
**Username**: Your Nextcloud username or email
**Password**: Your generated app-password/token (`Learn more <https://docs.nextcloud.com/server/stable/user_manual/session_management.html#managing-devices>`_).
**Server Address**: URL of your Nextcloud server (e.g. ``https://cloud.example.com``)
.. image:: ./images/macos_3.png
:alt:
.. figure:: ./images/macos_3.png
5. Click on **Sign In**.
@ -41,8 +38,7 @@ For **CalDAV (Calendar)**: You can now select, with which applications you want
to use this resource. In the most cases, this will be the "Calendar" application,
sometimes you may also want to use it for your **Tasks and reminders**.
.. image:: ./images/macos_4.png
:alt:
.. figure:: ./images/macos_4.png
Troubleshooting
---------------

10
user_manual/pim/sync_thunderbird.rst
View file

@ -3,7 +3,7 @@ Synchronizing with Thunderbird
==============================
`Thunderbird <https://www.thunderbird.net>`_ is a feature-rich and mature mail client that can be turned into a full-fledged PIM. However, it lacks support for address book synchronisation via CardDAV and it also lacks the ability to automatically discover calendars and address books available on the server. Therefore, to synchronise with Nextcloud, add-ons are required, which can be easily installed through Thunderbird's add-on manager.
Recommended method
------------------
@ -28,11 +28,10 @@ When they are installed, if you are on Windows, go to **Extras**/**Synchronisati
Alternative: Using the CardBook add-on (Contacts only)
------------------------------------------------------
`CardBook <https://addons.thunderbird.net/en/thunderbird/addon/cardbook/>`_ is an advanced alternative to Thunderbird's address book, which supports CardDAV. You can have TBSync and CardBook installed in parallel.
1. Click the CardBook icon in the upper right corner of Thunderbird:
.. image:: ../images/cardbook_icon.png
:alt:
2. In CardBook:
@ -40,17 +39,14 @@ Alternative: Using the CardBook add-on (Contacts only)
- Select **CardDAV**, fill in the address of your Nextcloud server, your user name and password
.. image:: ../images/new_addressbook.png
:alt:
4. Click on "Validate", click Next, then choose the name of the address book and click Next again:
.. image:: ../images/addressbook_name.png
:alt:
5. When you are finished, CardBook synchronizes your address books. You can always trigger a synchronisation manually by clicking "Synchronize" in the top left corner of CardBook:
.. image:: ../images/synchronize_cardbook.png
:alt:
The old method: Manually subscribing to calendars
-------------------------------------------------
@ -65,12 +61,10 @@ This method is only needed if you don't want to install TBSync.
3. Choose **On the Network**:
.. image:: ../images/new_calendar.png
:alt:
4. Choose **CalDAV** and fill in the missing information:
.. image:: ../images/CalDAV_calendar.png
:alt:
Fix for Thunderbird 60
----------------------

1
user_manual/pim/sync_windows10.rst
View file

@ -27,7 +27,6 @@ Contacts
1. In the bottom left of the Contacts View (in Nextcloud Contacts) look for a little impeller symbol that looks like this:
.. image:: ../images/contacts_link.png
:alt:
which will display a URL that looks something like this:
https://cloud.nextcloud.com/remote.php/dav/addressbooks/users/daniel/Thunderbird/

12
user_manual/session_management.rst
View file

@ -11,8 +11,8 @@ Managing connected browsers
In the list of connected browsers you see which browsers connected to your
account recently:
.. image:: images/settings_sessions.png
:alt:
.. figure:: images/settings_sessions.png
:alt: List of browser sessions.
You can use the trash icon to disconnect any of the browsers in the list.
@ -22,8 +22,8 @@ Managing devices
In the list of connected devices you see all the devices and clients you
generated a device password for and their last activity:
.. image:: images/settings_devices.png
:alt:
.. figure:: images/settings_devices.png
:alt: List of connected devices.
You can use the trash icon to disconnect any of the devices in the list.
@ -33,8 +33,8 @@ password is used for configuring the new client. Ideally, generate individual
tokens for every device you connect to your account, so you can disconnect
those individually if necessary:
.. image:: images/settings_devices_add.png
:alt:
.. figure:: images/settings_devices_add.png
:alt: Adding a new device.
.. note:: You have only access to the device password when creating it,
Nextcloud will not save the plain password, hence it's recommended to

27
user_manual/user_2fa.rst
View file

@ -4,7 +4,7 @@ Using two-factor authentication
Two-factor authentication (2FA) is a way to protect your Nextcloud account
against unauthorized access. It works by requiring two different 'proofs' of
your identity. For example, *something you know* (like a password) and
your identity. For example, *something you know* (like a password) and
*something you have* like a physical key. Typically, the first factor is a
password like you already have and the second can be a text message you
receive or a code you generate on your phone or another device
@ -21,8 +21,8 @@ Configuring two-factor authentication
In your Personal Settings look up the Second-factor Auth setting. In this
example this is TOTP, a Google Authenticator compatible time-based code:
.. image:: images/totp_enable.png
:alt:
.. figure:: images/totp_enable.png
:alt: TOTP configuration.
You will see your secret and a QR code which can be scanned by the TOTP app
on your phone (or another device). Depending on the app or tool, type in the
@ -38,13 +38,13 @@ unlock your account. It effectively functions as a backup 2nd factor. To
get the backup codes, go to your Personal Settings and look under Second-factor
Auth settings. Choose *Generate backup codes*:
.. image:: images/2fa_backupcode_1.png
:alt:
.. figure:: images/2fa_backupcode_1.png
:alt: 2FA backup code generator
You will then be presented with a list of one-time-use backup codes:
.. image:: images/2fa_backupcode_2.png
:alt:
.. figure:: images/2fa_backupcode_2.png
:alt: 2FA backup codes
You should put these codes in a safe spot, somewhere you can find them. Don't
put them together with your 2nd factor like your mobile phone but make sure that
@ -59,13 +59,13 @@ enter the TOTP code in your browser. If you enable not only the TOTP factor
but another one, you will see a selection screen on which you can choose
two-factor method for this login. Select TOTP:
.. image:: images/totp_login_1.png
:alt:
.. figure:: images/totp_login_1.png
:alt: Choosing a two-factor authentication method.
Now, just enter your code:
.. image:: images/totp_login_2.png
:alt:
.. figure:: images/totp_login_2.png
:alt: Entering TOTP code at login.
If the code was correct you will be redirected to your Nextcloud account.
@ -91,5 +91,6 @@ Using client applications with two-factor authentication
Once you have enabled 2FA, your clients will no longer be able to connect with
just your password unless they also have support for two-factor authentication.
To solve this, you should generate device specific passwords for them. See
To solve this, you should generate device specific passwords for them. See
:doc:`session_management` for more information on how to do this.

8
user_manual/userpreferences.rst
View file

@ -10,15 +10,15 @@ To access your personal settings:
The Personal Settings Menu opens:
.. image:: images/oc_personal_settings_dropdown.png
:alt:
.. figure:: images/oc_personal_settings_dropdown.png
:alt: screenshot of user menu at top-right of Nextcloud Web GUI
*Personal Settings Menu*
2. Choose *Settings* from the drop down menu:
.. image:: images/personal_settings.png
:alt:
.. figure:: images/personal_settings.png
:alt: screenshot of user's Personal settings page
.. note:: If you are an administrator, you can also manage users and administer
the server. These links do not appear to a non-admin user.

18
user_manual/webinterface.rst
View file

@ -5,13 +5,13 @@ The Nextcloud Web interface
You can connect to your Nextcloud server using any Web browser. Just point it to
your Nextcloud server URL (e.g. cloud.example.com) and enter your username and password:
.. image:: images/login_page.png
:alt:
.. figure:: images/login_page.png
:alt: Nextcloud login screen.
Web browser requirements
------------------------
For the best experience with the Nextcloud web interface, we recommend that you use the
For the best experience with the Nextcloud web interface, we recommend that you use the
latest and supported version of a browser from this list:
.. No need to translate
@ -26,7 +26,7 @@ latest and supported version of a browser from this list:
* Apple **Safari**
.. note:: If you want to use Nextcloud Talk you need to run Mozilla **Firefox** 52+
or Google **Chrome**/Chromium 49+ to have the full experience with video calls and
or Google **Chrome**/Chromium 49+ to have the full experience with video calls and
screensharing. Google **Chrome**/Chromium requires a additional plugin for screensharing.
Navigating the main user interface
@ -34,10 +34,10 @@ Navigating the main user interface
By default, the Nextcloud Web interface opens to your Dashboard or Files page:
.. image:: images/files_page.png
.. figure:: images/files_page.png
:scale: 75%
:alt:
:alt: The main Files view.
In Files you can add, remove, and share files, and make changes based on the access privileges
set by you (if you are administering the server) or by your server administrator.
@ -64,9 +64,9 @@ The Nextcloud user interface contains the following fields and functions:
enables you to create new files, new folders, or upload files.
.. note:: You can also drag and drop files from your file manager into the
Files Application View to upload them to your instance.
Files Application View to upload them to your instance.
* **Search** field (6): Click on the Magnifier in the upper right corner
* **Search** field (6): Click on the Magnifier in the upper right corner
to search for files and entries of the current app.
* **Contacts Menu** (7): Gives you an overview about your contacts and users on

18
user_manual/whats_new.rst
View file

@ -4,22 +4,22 @@ What's new for users in Nextcloud |version|
1. Easier way to select a new app:
.. image:: images/apps_menu.png
:alt:
.. figure:: images/apps_menu.png
:alt: screenshot of apps menu at top-left of Nextcloud Web GUI
2. New Contacts menu to reach your colleagues or friends easier:
.. image:: images/contacts_menu.png
:alt:
.. figure:: images/contacts_menu.png
:alt: screenshot of contacts menu at top-right of Nextcloud Web GUI
3. A contact popup menu over avatars everywhere:
.. image:: images/contacts_popup.png
:alt:
.. figure:: images/contacts_popup.png
:alt: screenshot of popup over avatar
4. Ability to send multiple unique sharing links each with their own settings, by entering email addresses (the recipient will receive an email):
.. image:: images/multi_sharing.png
:alt:
.. figure:: images/multi_sharing.png
:alt: screenshot of multiple sharing links
5. Many other improvements and new apps, like screensharing in Video calls, new Circles app for user defined groups, push notifications, notifications of file changes even when shared to another server, undo removal of files from a shared folder even if the removal was done by a recipient, directly sharing to social media and much more.