diff --git a/images/interface/docker-based-rock-ons/immich_add_external_library.png b/images/interface/docker-based-rock-ons/immich_add_external_library.png index 59a0e6e..4de1131 100644 Binary files a/images/interface/docker-based-rock-ons/immich_add_external_library.png and b/images/interface/docker-based-rock-ons/immich_add_external_library.png differ diff --git a/images/interface/docker-based-rock-ons/immich_administration.png b/images/interface/docker-based-rock-ons/immich_administration.png deleted file mode 100644 index 423c29c..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_administration.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_afterinstall.png b/images/interface/docker-based-rock-ons/immich_afterinstall.png deleted file mode 100644 index e614d31..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_afterinstall.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_create_library.png b/images/interface/docker-based-rock-ons/immich_create_library.png deleted file mode 100644 index 675fce5..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_create_library.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_create_user.png b/images/interface/docker-based-rock-ons/immich_create_user.png deleted file mode 100644 index 1de3ae8..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_create_user.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_env_vars.png b/images/interface/docker-based-rock-ons/immich_env_vars.png deleted file mode 100644 index acd9dbb..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_env_vars.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_external_libraries.png b/images/interface/docker-based-rock-ons/immich_external_libraries.png deleted file mode 100644 index a06da1c..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_external_libraries.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_external_library_import.png b/images/interface/docker-based-rock-ons/immich_external_library_import.png deleted file mode 100644 index 93d4cb8..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_external_library_import.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_external_library_owner.png b/images/interface/docker-based-rock-ons/immich_external_library_owner.png deleted file mode 100644 index 62eb459..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_external_library_owner.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_external_library_validate.png b/images/interface/docker-based-rock-ons/immich_external_library_validate.png deleted file mode 100644 index df36ce2..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_external_library_validate.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_installing.png b/images/interface/docker-based-rock-ons/immich_installing.png deleted file mode 100644 index 753aa27..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_installing.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_preinstall.png b/images/interface/docker-based-rock-ons/immich_preinstall.png deleted file mode 100644 index 0d9cef4..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_preinstall.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_settings_for_external_library.png b/images/interface/docker-based-rock-ons/immich_settings_for_external_library.png deleted file mode 100644 index 74fd2fd..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_settings_for_external_library.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_shares.png b/images/interface/docker-based-rock-ons/immich_shares.png deleted file mode 100644 index 844c806..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_shares.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_user_form.png b/images/interface/docker-based-rock-ons/immich_user_form.png deleted file mode 100644 index 1837de0..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_user_form.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_verify.png b/images/interface/docker-based-rock-ons/immich_verify.png deleted file mode 100644 index dfb5d4b..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_verify.png and /dev/null differ diff --git a/images/interface/docker-based-rock-ons/immich_webUI_port.png b/images/interface/docker-based-rock-ons/immich_webUI_port.png deleted file mode 100644 index f9b0f5d..0000000 Binary files a/images/interface/docker-based-rock-ons/immich_webUI_port.png and /dev/null differ diff --git a/interface/docker-based-rock-ons/immich.rst b/interface/docker-based-rock-ons/immich.rst index 7dbe7b3..a6d7d92 100644 --- a/interface/docker-based-rock-ons/immich.rst +++ b/interface/docker-based-rock-ons/immich.rst @@ -50,76 +50,26 @@ Installing the Immich rock-on The Immich Rock-on requires 3 `shares to be created `_ before the installation can begin: - - - Library share: used by Immich to store uploaded photos/videos, - - Database share, - - Cache share: used by Immich's machine-learning functionality -We are now ready to start the installation of the Immich rock-on. - -Click the *Install* button next to the **Immich** listing on the *Rock-ons* -page. - -.. image:: /images/interface/docker-based-rock-ons/immich_preinstall.png - :width: 100% - :align: center - - -The install wizard has appeared. - -In the first step, please select the 3 shares that you created previously. - -Then click on **Next**. - -.. image:: /images/interface/docker-based-rock-ons/immich_shares.png - :width: 100% - :align: center - - -At this stage you will set the port used to reach Immich's web-UI. - -The default port is usually fine as long as it is free. - -Then click on **Next**. - -.. image:: /images/interface/docker-based-rock-ons/immich_webUI_port.png - :width: 100% - :align: center - - -At this stage you will set some environment variables. - -**Log level**: Input the desired log level. You will want to use **log** -for normal operations. Other available values: verbose, debug, warn, error. - -**Ignore error checks**: Input whether you want to skip mount error checks. -You will want to use **false**, unless you have -`issues with your Immich instance `_. - -Then click on **Next**. - -.. image:: /images/interface/docker-based-rock-ons/immich_env_vars.png - :width: 100% - :align: center - - -Verify the information you've provided is correct, then click **Submit**. - -.. image:: /images/interface/docker-based-rock-ons/immich_verify.png - :width: 100% - :align: center +- Library share: used by Immich to store uploaded photos/videos, +- Database share, +- Cache share: used by Immich's machine-learning functionality - -You'll see a screen indicating the Rock-on is being installed. Click *Close*. - -Congratulations! At this point Immich will be up-and-running. - -Click on the **Immich UI** button to open the web configuration and complete -the Immich-specific set-up. (See: :ref:`immich_setup`) +We are now ready to start the installation of the Immich rock-on. -.. image:: /images/interface/docker-based-rock-ons/immich_afterinstall.png - :width: 100% - :align: center +#. Click the *Install* button next to the **Immich** listing on the *Rock-ons* page. +#. In the first step, please select the 3 shares that you created previously. +#. Click **Next**. +#. Set the port used to reach Immich's WebUI. +#. Click **Next**. +#. Set environment variables. + - **Log level**: Input the desired log level. You will want to use **log** for normal operations. Other available values: verbose, debug, warn, error. + - **Ignore error checks**: Input whether you want to skip mount error checks. You will want to use **false**, unless you have `issues with your Immich instance `_. +#. Click **Next**. +#. Verify the information you've provided is correct, then click **Submit**. +#. You'll see a screen indicating the Rock-on is being installed. Click *Close*. +#. Click on the **Immich UI** button to open the web configuration and complete + the Immich-specific set-up. (See: :ref:`immich_setup`) .. _immich_mounting_external_library: @@ -131,97 +81,57 @@ In case you already have a share full of existing photos and videos, you probabl want to import them into Immich. You can `read more about them `_. -**WARNING: Write access!** - -Mounting an external library of photos/videos via the Web-UI will give Immich -write-access by default. This also means you will be able to delete files via Immich. - -If you want to restrict Immich to read-only-access, you will need to do the following instead: - - 1. download the `Immich Rock-on configuration file `_, - 2. save it under ``/opt/rockstor/rockons-metastore/``, - 3. edit the file: toward the end of the file, right after ``[ "-e", "DB_HOSTNAME=immich-database" ]``, insert the following line: ``, [ "-v", "/mnt2/MyPrivatePhotoCollection:/mnt2/MyPrivatePhotoCollection:ro" ]``, where ``/mnt2/MyPrivatePhotoCollection`` is the path to the share where you keep your existing photos/videos, - 4. save file, - 5. in case your Immich instance is already running: go into the "ROCK-ONS" menu, find the Immich Rock-on, set it to **OFF**, afterwards click on the **Uninstall** button, - 6. now re-install the rock-on. +.. warning:: + Mounting an external library of photos/videos via the Web-UI will give Immich + write-access by default. This also means you will be able to delete files via Immich. + If you want to restrict Immich to read-only-access, you will need to modify the + `Rock-on `_ + and insert your share via a bind-mount Docker command, including the :code:`:ro` postfix. -**If you want to continue with a write-access external library, read on.** - -To make the share available to Immich, you will need to first stop the running Immich instance. - -You do that by clicking on the green **ON** button (which will subsequently turn to a red **OFF** button). - -Now click on the small wrench icon right next to the red **OFF** button, and click on the **Add Storage** button. +1. To make the share available to Immich, you will need to first stop the running Immich instance. +2. Now click on the small wrench icon right next to the red **OFF** button, and click on the **Add Storage** button. .. image:: /images/interface/docker-based-rock-ons/immich_add_external_library.png - :width: 100% + :width: 70% :align: center - -**Storage**: select the share that contains your existing photos/videos. - -**Rock-on directory**: input a path under which your share will be available in the Immich instance. - -Then click on **Next**. - -.. image:: /images/interface/docker-based-rock-ons/immich_settings_for_external_library.png - :width: 100% - :align: center - - -If everything looks fine on the summary configuration page, then click on **Next** again, and then **Submit**. - -After the Immich will be up-and-running again, go into your admin **External Libraries** configuration page in Immich, and add the supplied path (i.e. ``/data/test1``). +3. **Storage**: select the share that contains your existing photos/videos. +4. **Rock-on directory**: input a path under which your share will be available in the Immich instance. +5. Click **Next**. +6. If everything looks fine on the summary configuration page, then click on **Next** again, and then **Submit**. +7. After the Immich will be up-and-running again, go into your admin **External Libraries** configuration page in Immich, and add the supplied path (i.e. ``/data/test1``). .. _immich_setup: Finishing the Immich set-up ------------------------------ -If you haven't already, click on the **Immich UI** button. At which point the web UI will load. - -Click on the **Getting Started** button. - -First you will create an admin account. - -If you intend to use the `email notification `_ feature, -then it is recommended to use your actual email address. -Otherwise, you can input any kind of email-like string into the *Admin Email* field. - -Click on the **Theme** button and choose the preferred theme. - -Click on the **Language** button and choose the preferred language. - -Click on the **Server Privacy** button. - -**Map**: if enabled, it will use Immich's map tile service to show the location of where the photo was taken on a world map. - -**Version Check**: if enabled, it will periodically check Immich's github repo, if a new release is available. - -Click on the **User Privacy** button. - -**Google Cast**: if enabled, it will load resources from Google to make Google Cast work. - -Click on the **Storage Template** button. - -This setting is about how files are organized on the disk. If you want to keep it simple, keep it disabled. -You can always migrate to storage templates at a later date. - -But if you want to custom define what kind of folder structure and filenames you want to have, -then you should enable this setting. - -You can also -`check the detailed differences of using storage templates or not `_. - -Click on the **Backups** button and consider if you have any special backup requirements for your Immich instance. - -Click on the **Mobile App** button and consider if you want to install their official mobile app. - -Having the mobile app will allow you to access your files, -but more importantly, you will also be able to set automatic, background uploading of photos/videos to your Immich instance. - -Click on the **Done** button to finish the set-up. +#. If you haven't already, click on the **Immich UI** button. At which point the web UI will load. +#. Click on the **Getting Started** button. +#. First you will create an admin account. + - If you intend to use the `email notification `_ feature, + then it is recommended to use your actual email address. + Otherwise, you can input any kind of email-like string into the *Admin Email* field. +#. Click on the **Theme** button and choose the preferred theme. +#. Click on the **Language** button and choose the preferred language. +#. Click on the **Server Privacy** button. + - **Map**: if enabled, it will use Immich's map tile service to show the location of where the photo was taken on a world map. + - **Version Check**: if enabled, it will periodically check Immich's github repo, if a new release is available. +#. Click on the **User Privacy** button. + - **Google Cast**: if enabled, it will load resources from Google to make Google Cast work. +#. Click on the **Storage Template** button. + - This setting is about how files are organized on the disk. If you want to keep it simple, keep it disabled. + You can always migrate to storage templates at a later date. + - But if you want to custom define what kind of folder structure and filenames you want to have, + then you should enable this setting. + - You can also + `check the detailed differences of using storage templates or not `_. +#. Click on the **Backups** button and consider if you have any special backup requirements for your Immich instance. +#. Click on the **Mobile App** button and consider if you want to install their official mobile app. + - Having the mobile app will allow you to access your files, + but more importantly, you will also be able to set automatic, background uploading of photos/videos to your Immich instance. +#. Click on the **Done** button to finish the set-up. .. _immich_new_user: @@ -231,30 +141,11 @@ New user account If you wish, you can simply use the Admin account for now. Otherwise, you can consider creating new user accounts. -Login to your Immich instance with your Admin account. - -Click on your profile image on the top-right corner of the page, then click on **Administration**. - -.. image:: /images/interface/docker-based-rock-ons/immich_administration.png - :width: 40% - :align: center - - -Click on the **Create user** link below your profile image on the top-right corner of the page. - -.. image:: /images/interface/docker-based-rock-ons/immich_create_user.png - :width: 40% - :align: center - - -Fill in the user account data. Note that files coming from external libraries do *not* count toward the Quota Size. - -.. image:: /images/interface/docker-based-rock-ons/immich_user_form.png - :width: 25% - :align: center - - -Click on the **Create** button to create the new user account. +1. Login to your Immich instance with your Admin account. +2. Click on your profile image on the top-right corner of the page, then click on **Administration**. +3. Click on the **Create user** link below your profile image on the top-right corner of the page. +4. Fill in the user account data. Note that files coming from external libraries do *not* count toward the Quota Size. +5. Click on the **Create** button to create the new user account. .. _immich_external_library_import: @@ -263,71 +154,33 @@ External Library Import If you have an existing collection of photos and videos, you are probably going to want to include it into your Immich instance. -**Note that there is currently no good central sharing solution present in Immich!** -If you wanted to have a central repository of photos/videos that is shared between different users, -`you will need to wait `_ until it's implemented. +.. note:: + **Note that there is currently no good central sharing solution present in Immich!** + If you wanted to have a central repository of photos/videos that is shared between different users, + `you will need to wait `_ until it's implemented. -Until then, here are some alternatives: + Until then, here are some alternatives: -#. Create a single user account that you share with other people: all people and devices will have access to the same library with all people/facial recognition data (and other metadata), and they will all be able to upload their own files to the library. Duplicates are detected on the whole library. -#. `Use partner sharing `_: other users will be able to view and download files (and their metadata) from your library, but won't also share the people/facial recognition data. You won't see other users' libraries automatically - they have to explicitly share back. Other users can't upload their files to your library. Duplicates are detected only on your library. Smart search and map features won't be shared. -#. Create user accounts for each family member and one additional account with the external library, then using the partner sharing feature, share the external library with other users. -#. Set-up the same external libraries for each user: causes unnecessary file metadata duplication. + #. Create a single user account that you share with other people: all people and devices will have access to the same library with all people/facial recognition data (and other metadata), and they will all be able to upload their own files to the library. Duplicates are detected on the whole library. + #. `Use partner sharing `_: other users will be able to view and download files (and their metadata) from your library, but won't also share the people/facial recognition data. You won't see other users' libraries automatically - they have to explicitly share back. Other users can't upload their files to your library. Duplicates are detected only on your library. Smart search and map features won't be shared. + #. Create user accounts for each family member and one additional account with the external library, then using the partner sharing feature, share the external library with other users. + #. Set-up the same external libraries for each user: causes unnecessary file metadata duplication. Here is how you can import your files into Immich. -Prerequisite is that you have made your share available to Immich. See: :ref:`immich_mounting_external_library`. -Also note that every external library must have an owner. If you haven't created your user account(s), do so now. See: :ref:`immich_new_user` - -Click on your profile image on the top-right corner of the page, then click on **Administration**. - -.. image:: /images/interface/docker-based-rock-ons/immich_administration.png - :width: 40% - :align: center - - -Click on the **External Libraries** item in the left-side menu. - -.. image:: /images/interface/docker-based-rock-ons/immich_external_libraries.png - :width: 40% - :align: center - - -Click on the **Create library** link below your profile image on the top-right corner of the page. - -.. image:: /images/interface/docker-based-rock-ons/immich_create_library.png - :width: 40% - :align: center - - -Choose a user that will be the owner of the external library. This means that -all files from the external library will be imported to the selected user's library. -The user may choose to -`share their library with other users with some limitations `_. - -Click on the **Create** Button. - -.. image:: /images/interface/docker-based-rock-ons/immich_external_library_owner.png - :width: 50% - :align: center - -Input the path to the external library that you've defined at :ref:`immich_mounting_external_library`. -E.g. ``/data/test1``... - -Click on the **Add** button. - -.. image:: /images/interface/docker-based-rock-ons/immich_external_library_import.png - :width: 50% - :align: center - -Click on the **Validate** button to check if the external library is correctly configured. - -.. image:: /images/interface/docker-based-rock-ons/immich_external_library_validate.png - :width: 30% - :align: center - -In case or problems, please refer to -`in-depth explanation and troubleshooting information `_. +1. Prerequisite is that you have made your share available to Immich. See: :ref:`immich_mounting_external_library`. + - Also note that every external library must have an owner. If you haven't created your user account(s), do so now. See: :ref:`immich_new_user` +2. Click on your profile image on the top-right corner of the page, then click on **Administration**. +3. Click on the **External Libraries** item in the left-side menu. +4. Click on the **Create library** link below your profile image on the top-right corner of the page. +5. Choose a user that will be the owner of the external library. This means that all files from the external library will be imported to the selected user's library. + - The user may choose to `share their library with other users with some limitations `_. +6. Click on the **Create** Button. +7. Input the path to the external library that you've defined at :ref:`immich_mounting_external_library`. + E.g. ``/data/test1``... +8. Click on the **Add** button. +9. Click on the **Validate** button to check if the external library is correctly configured. +10. In case or problems, please refer to `in-depth explanation and troubleshooting information `_. .. _immich_other_settings: