Warning, /documentation/digikam-doc/setup_application/collections_settings.rst is written in an unsupported language. File is not indexed.

0001 .. meta::
0002    :description: digiKam Collections Settings
0003    :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy, collection, setup, configure
0004 
0005 .. metadata-placeholder
0006 
0007    :authors: - digiKam Team
0008 
0009    :license: see Credits and License page for details (https://docs.digikam.org/en/credits_license.html)
0010 
0011 .. _collections_settings:
0012 
0013 Collections Settings
0014 ====================
0015 
0016 .. contents::
0017 
0018 Setup Root Album Folders
0019 ------------------------
0020 
0021 This view manages your **Album Collections** handled by the database. Each Collection represents a **Root Album Folder** containing your photographs or videos. Usually the root folder will contain sub folders. All these folders we call **Albums**. How to work with them, create, delete, rename them etc. is described in detail to :ref:`the Album section <albums_view>`.
0022 
0023 .. figure:: images/setup_collection_entries.webp
0024     :alt:
0025     :align: center
0026 
0027     The digiKam Collections Configuration Page with the List of Root Album Folders
0028 
0029 The **Root Album Folders** list three types of collection which can be referenced in digiKam:
0030 
0031     - **Local Collections**: these are root album folders stored physically on your computer drives.
0032 
0033     - **Collections on Removable Media**: these are root album folders stored on media which can be removed from your computer, as USB keys, external drives, DVD.
0034 
0035     - **Collections on Network Shares**: these are root album folders stored remote file systems as Samba or NFS and mounted as native on your system.
0036 
0037 For each type, the **Add Collection** button allows to append an entry in the list. Entry properties are the root album folder **Name** and the root album folder **Path**. You can change the collection name by double clicking with the mouse over the text on the left of an entry from the list.
0038 
0039 .. figure:: images/setup_collection_new.webp
0040     :alt:
0041     :align: center
0042 
0043     The digiKam Collections Configuration Page Appending a Root Album Folder
0044 
0045 To edit the properties of an entry, use the **Update button** on the right side of the path. To remove an entry, use the **Red trash button** on right side.
0046 
0047 .. figure:: images/setup_collection_category.webp
0048     :alt:
0049     :align: center
0050 
0051     The digiKam Collections Configuration Page Editing Category of a Root Album Folder
0052 
0053 .. important::
0054 
0055     The **Monitor the Albums for External Changes** option will trigger the database to update information. This can be a time-consuming operation especially under macOS and with network file system.
0056 
0057 .. note::
0058 
0059     **File write access** in collection is necessary to change items contents and metadata.
0060 
0061 .. _network_shares:
0062 
0063 The Network Shares Specificity
0064 ------------------------------
0065 
0066 For the **Collections on Network Shares**, the **Plus button** on the right side of the path allows to append a new mount path to a registered collection entry. This feature resolve the problematic collections and database data shared over a local network (here using a `Network Attached Storage - NAS <https://en.wikipedia.org/wiki/Network-attached_storage>`_), and accedes by different digiKam clients (here a Windows, Linux, and macOS). As each client will mount the shared collection to different paths on local computers, this allows to host all paths in the database referring to the same main shared collection path. As all client computers will share the same database, all information hosted in database and managed with each digiKam clients will not be duplicated on the NAS.
0067 
0068 The configuration can be set following steps listed below:
0069 
0070     - On the **Linux** client, user adds the first entry to the network collection: :file:`/mnt/nas`
0071 
0072     - On the **macOS** client, with the "+" icon user now adds its base path to the collection: :file:`/Volumes/data/NAS`
0073 
0074     - On the **Windows** client, user adds the shared path: :file:`X:\\NAS-digiKam`
0075 
0076 Later, other extra digiKam clients would also be conceivable if the NAS has a different mount point or used by `UNC path <https://en.wikipedia.org/wiki/Path_(computing)>`_. On each digiKam clients it's important that all base paths then refer to the same network shared collection in the setup dialog.
0077 
0078 .. important::
0079 
0080     This kind of resources shared on the local network do not permit to use each client at the same time with a common database.
0081 
0082 .. figure:: images/setup_collection_network_shares.webp
0083     :alt:
0084     :align: center
0085 
0086     Collection and Database Shared on Local Network Using NAS to 3 Different digiKam Clients
0087 
0088 .. warning::
0089 
0090     digiKam does not support virtual placeholder folders as OneDrive or GoogleDrive within the image collection specified in setup.
0091 
0092 .. _ignored_directories:
0093 
0094 Ignore Directories from your Collections
0095 ----------------------------------------
0096 
0097 The **Ignored Directories** view allows to setup the list of the directories to ignore while scanning collection contents. The directory names are case sensitive and must be separated by semicolon. The list of ignored directories does not support paths intentionally. Press on the **Currently ignored directories** link to show the list of directories already knows by digiKam internally.
0098 
0099 .. figure:: images/setup_ignored_directories.webp
0100     :alt:
0101     :align: center
0102 
0103     The digiKam Collections Configuration Page with the List of Ignored Directories