Skip to content

Commit

Permalink
Add troubleshooting section about NFD file encoding
Browse files Browse the repository at this point in the history
Signed-off-by: Vincent Petry <vincent@nextcloud.com>
  • Loading branch information
PVince81 committed Jan 5, 2023
1 parent 8f02360 commit 3baa8ca
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions admin_manual/configuration_server/occ_command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,8 @@ File operations
sharing user holds the ownership of the respective files.
There is however an option to enable moving incoming shares.

.. _occ_files_scan_label:

Scan
^^^^

Expand Down
27 changes: 27 additions & 0 deletions admin_manual/issues/general_troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,33 @@ Users' Federated Cloud IDs not updated after a domain name change
| ``occ dav:sync-system-addressbook``
| ``occ federation:sync-addressbooks``
.. _trouble-file-encoding-ext-storages:

Troubleshooting file encoding on external storages
--------------------------------------------------

When using external storage, it can happen that some files with special characters will not
appear in the file listing, or they will appear and not be accessible.

When this happens, please run the :ref:`files scanner<occ_files_scan_label>`, for example with::

sudo -u www-data php occ files:scan --all

If the scanner tells about an encoding issue on the affected file, please enable Mac encoding compatibility in the :ref:`mount options<external_storage_mount_options_label>`
and then :ref:`rescan the external storage<occ_files_scan_label>`.

.. note::
This mode comes with a performance impact because Nextcloud will always try both encodings when detecting files
on external storages.

Mac computers are using the NFD Unicode Normalization for file names which is different than NFC, the one used
by other operating systems. Mac users might upload files directly to the external storage using NFD normalized
file names. When uploading through Nextcloud, file names will always be normalized to the NFC standard for consistency.

It is recommended to let Nextcloud use external storages exclusively to avoid such issues.

See also `technical explanation about NFC vs NFD normalizations <https://www.win.tue.nl/~aeb/linux/uc/nfc_vs_nfd.html>`_.

Troubleshooting contacts & calendar
-----------------------------------

Expand Down

0 comments on commit 3baa8ca

Please sign in to comment.