# How to set up and remotely access Immich using Meshnet
## What is Immich?
[Immich](https://immich.app/) is a self-hosted and open-source tool for backing up and managing your images and videos. It offers an intuitive solution with a wide range of features, including multi-user support, asset sharing, and [facial recognition](https://nordvpn.com/blog/facial-recognition/). Unlike other self-hosted picture libraries, such as [LibrePhotos](https://meshnet.nordvpn.com/how-to/remote-files-media-access/librephotos-picture-library), Immich is primarily focused on backup functionality, allowing you to easily upload pictures from desktop and mobile platforms.
By supplementing your Immich setup with [Meshnet](https://nordvpn.com/meshnet/), you can enable secure content backup and remote access over an encrypted [NordLynx](https://nordvpn.com/blog/nordlynx-protocol-wireguard/) tunnel. This configuration does not require [port forwarding](https://nordvpn.com/blog/port-forwarding/) or experience with [firewalls](https://nordvpn.com/cybersecurity/glossary/firewall/). Even if you are on the other side of the globe, simply turn on Meshnet and connect to your Immich server as if you were on the same[ local area network](https://nordvpn.com/blog/what-is-lan/) (LAN).
This guide will walk you through the process of setting up a personal Immich instance and showcase how Meshnet can be integrated to allow for seamless remote connections to the server.
## Before you begin
Make sure that you have [Docker](https://docs.docker.com/get-started/overview/) and [Docker Compose](https://docs.docker.com/compose/) installed on your device. You can find instructions on how to download and install these tools on the Docker website:
* [Docker Desktop instructions for Windows](https://docs.docker.com/desktop/install/windows-install/)
* [Docker Desktop instructions for macOS](https://docs.docker.com/desktop/install/mac-install/)
* [Docker Desktop Instructions for Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Docker Engine instructions for Linux (CLI only)](https://docs.docker.com/engine/install/)
* [Docker Compose instructions for Linux (CLI only)](https://docs.docker.com/compose/install/linux/)
{% hint style="info" %}
**Note**
Docker Compose comes pre-installed with Docker Desktop.
{% endhint %}
## Run Immich using Docker
Immich operates as a multi-container app, comprising Docker containers for the server, database, and machine learning, all working together seamlessly. The Docker Compose tool is used to manage the preparation, deployment, and operation of these interconnected containers.
### Prepare the Immich directory
To start, you need to prepare a folder that will hold all files and data required to run Immich.
{% tabs %}
{% tab title="Windows" %}
1. Open **PowerShell**.
2. In your preferred directory, create a new `immich` folder and navigate to it using the following command:
mkdir immich; cd immich
3. Run the two commands below to download the Docker Compose and the environmental variable files from the [Immich GitHub repository](https://github.com/immich-app/immich):
4. Use the `ls` command to check if both files have downloaded successfully.
{% endtab %}
{% tab title="macOS and Linux" %}
1. Open **Terminal**.
2. In your preferred directory, create a new `immich` folder and navigate to it using the following command:
mkdir immich && cd immich
3. Run the two commands below to download the Docker Compose and the environmental variable files from the [Immich GitHub repository](https://github.com/immich-app/immich):
4. Use the `ls -a` command to check if both files have downloaded successfully.
{% endtab %}
{% endtabs %}
### Modify environmental variables
Next, you need to alter some of the default values provided in the downloaded files to fit your setup.
{% tabs %}
{% tab title="Windows" %}
{% hint style="info" %}
**Note**
Immich relies on a [PostgreSQL database](https://www.postgresql.org/), which is incompatible with [NTFS ](https://en.wikipedia.org/wiki/NTFS)or [FAT](https://en.wikipedia.org/wiki/File_Allocation_Table) file systems used by Windows. To overcome this limitation, the database folder must be mapped as a [Docker volume](https://docs.docker.com/engine/storage/volumes/) rather than a standard system directory.
For more information, see the “Special requirements for Windows users” section of the [Immich requirements page](https://immich.app/docs/install/requirements#special-requirements-for-windows-users).
{% endhint %}
1. In **PowerShell**, run the following command to create a new volume that will be used for database storage.
docker volume create pgdata
2. Open the `.env` file using Notepad with the command below:
notepad .env
3. Make the following changes to the environmental file:
* Set the value of `UPLOAD_LOCATION` to the path where you want the uploaded pictures and videos to be saved, as shown:
\
If the path contains spaces, enclose it with single quotation marks.
* Change the `DB_DATA_LOCATION` location value to `postgres` to ensure the database uses the Docker volume.
* Uncomment the `TZ` line by removing the hash (#) symbol at the start. Then, replace the default `Etc/UTC` value with your current [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\
\
**Example**
4. Press **Ctrl** + **S** to save changes and then exit **Notepad**.
5. Open the `docker-compose.yml` file using Notepad using the command provided below:
notepad docker-compose.yml
6. At the end of the file, under the `volumes`, append a new `pgdata:` line, to map the Docker volume to the container.
7. Press **Ctrl** + **S** to save changes and then exit **Notepad**.
{% endtab %}
{% tab title="macOS and Linux" %}
1. From the terminal, open the `.env` file using the Nano text editor with the following command:
nano .env
2. Set the value of `UPLOAD_LOCATION` to the path where you want the uploaded pictures and videos to be saved, as shown:
\
If the path contains spaces, enclose it with single quotation marks.
3. Uncomment the `TZ` line by removing the hash (#) symbol at the start. Then, replace the default `Etc/UTC` value with your current [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\
\
**Example**
4. Press **Ctrl** + **X**, **Y**, and **Enter** to save changes and exit the text editor.
{% endtab %}
{% endtabs %}
### Start the Immich containers
While in the `immich` directory, execute the following command in the command line to deploy your Immich instance:
{% code overflow="wrap" %}
```bash
docker compose up -d
```
{% endcode %}
Docker will [pull the resources](https://docs.docker.com/engine/reference/commandline/pull/) and dependencies required for Immich and create the necessary containers.
#### Verify the containers' status
Run the `docker ps` command to check the state of the containers. In the output, under `STATUS`, you should see `Up` and the duration indicating how long the containers have been active.
## Configure your Immich access
Once the Immich server container completes initialization, it will start a web interface that allows you to manage your Immich instance.
### Set up the administrator user
Upon accessing the Immich web interface for the first time, you will be prompted to create an administrator user account.
1. Open your internet browser and navigate to the Immich web interface.
* If you’re accessing Immich from the same device that is hosting it, go to `localhost:2283/`.
* Otherwise, swap the `localhost` part with the server’s local IP address. For example, `192.168.1.50:2283/`.
2. Click **Getting started**.
3. Fill in the **Admin** **registration** form with the administrator user’s email address, password, and username. Then, click **Sign up**.
4. On the login page, enter your email and password and select **Login**.
5. Complete the onboarding process and click **Done**.
Now you should see the main page of the Immich app. This is where all the pictures you upload will be displayed.
### Create a new user account
With the available user management features, you can create user accounts for friends or family members who will be joining your server. It is recommended to set up individual accounts for each user to ensure their uploaded assets remain private and secure.
1. In the upper-right corner, click the user icon and choose **Administration**.
2. Select **Create user**.
3. Enter the email address, password, and username of the new user account.\
\
**Example**
4. Click **Create**.
The new user account has been created and you can see its details under the **User management** table.
{% hint style="info" %}
**Note**
To enhance account security, new users must change their password upon logging in for the first time. If you prefer to disable this feature, turn off the **Require user to change password on first login** toggle during account creation.
{% endhint %}
### Add Meshnet address as an external domain
The external domain specified in the Immich settings is used to generate links for media sharing. While this setting is not mandatory for allowing remote connections over Meshnet, entering your Meshnet address as the external domain simplifies the item-sharing process between Meshnet peers.
1. In the upper-right corner, click the user icon and choose **Administration**.
2. From the menu on the left, select **Settings**, locate **Server settings,** and expand the dropdown.
3. In the **External domain** field, enter `http://:2283`, replacing the `` placeholder with your server’s Nord name or Meshnet IP address.\
\
**Example**
4. Click **Save**.
## Access Immich over Meshnet
Depending on your device type, you can choose from two different methods to connect to your Immich server over Meshnet.
{% hint style="info" %}
**Note**
If you're hosting Immich on a Linux device, you must grant the [local network permission](https://meshnet.nordvpn.com/features/explaining-permissions/local-network-permissions) for the devices accessing it. For more information, see [Common issues on Linux](https://meshnet.nordvpn.com/troubleshooting/linux#cannot-access-docker-containers-over-meshnet).
{% endhint %}
### Method 1: Using the Immich mobile app
The Immich mobile app is developed alongside the server software and includes additional features tailored specifically for mobile devices.
1. Download and install the Immich app on your mobile device.
* On Android, you can download Immich from any of the following sources:
* [Google Play Store](https://play.google.com/store/apps/details?id=app.alextran.immich)
* [F-droid app catalog](https://f-droid.org/packages/app.alextran.immich/)
* [Immich GitHub repository](https://github.com/immich-app/immich/releases)
* On iPhone and iPad, you can get it from the [App Store](https://apps.apple.com/us/app/immich/id1613945652).
2. Launch **Immich** .
3. When requested, grant the Immich app access to your photo library.
4. In the **Server endpoint URL** field, enter `http://:2283/api`, where `` is the Nord name or Meshnet IP address of your Immich server device. Then, tap **Next**.\
\
**Example**\
`http://secret.meerkat-himalayas.nord:2283/api`\
5. Enter the email and password of your Immich account and select **Login**.
### Method 2: Using an internet browser
If you’re using a desktop device, you’ll need to access and use Immich through an internet browser.
1. Copy the Nord name of the Immich server directly from the NordVPN app.
2. Open your internet browser.
3. Paste the copied Nord name followed by `:2283` to the URL field and press **Enter**.
\
**Example**\
`secret.meerkat-himalayas.nord:2283/`\
4. Type in the authentication details of your Immich account and click **Login**.
## Upload your media
Once you have established a connection to your Immich instance, you can select and backup your photographs and recordings to your server.
{% tabs %}
{% tab title="Using the mobile app" %}
1. In the upper-right corner, tap the backup button.
2. Tap **Select** to choose the media folders you want to back up on your Immich server.
3. Return to the **Backup** screen and select **Start backup** to begin uploading items to Immich.
Your assets should immediately start being uploaded to Immich. The transfer statistics are displayed on the **Backup** screen and are updated in real time.
{% hint style="info" %}
**Tip**
You can configure the Immich mobile app to automatically upload media from the selected locations to the server. For further details and instructions, see the “Automatic backup” page of [Immich documentation](https://immich.app/docs/features/automatic-backup).
{% endhint %}
{% endtab %}
{% tab title="Using an internet browser" %}
1. Using your internet browser, open the Immich web interface.
2. In the upper-right corner, select **Upload**.
3. In the file explorer dialog, select the files you want to upload to Immich and click **Open**.
While uploading the media, a pop-up dialog will be displayed in the lower-right corner of the screen showcasing the upload progress.
Immich will notify you when the upload completes and inform you to refresh the page to view the content.
{% endtab %}
{% endtabs %}
## Organize and share your media
With all of the assets backed up on your Immich server, you can start organizing the media and sharing it with other users.
### Create a new album
All uploaded media is sorted by date and displayed on a single page. You may want to improve upon this layout by grouping content into albums. To create an album:
1. In Immich, select the items you want to include in your album by clicking the checkmark in the upper-left corner of the thumbnail.
2. In the upper-right corner, click the **Add to** button.
3. In the **Search** field, enter the name of your album and select **New album**.
A new album with your chosen title is now created. You can view and manage the album and its contents on the **Albums** page.
### Share an album between users
To simplify file management and conserve storage space, you can upload assets from a single account, organize them into an album, and grant access to other Immich users, allowing them to view the album from their accounts.
1. Open the Immich web interface.
2. From the menu on the left, select **Albums**.
3. Hover your cursor over the album you want to share and click the three-dot menu button.
4. Choose **Share**.
5. In the **Invite to album** dialog, select the user with whom you want to share the album.
6. Click **Add**.
The chosen user can now view the album you shared by navigating to their account’s **Albums** page.
{% hint style="info" %}
**Note**
By default, the invitees are granted editing permissions in the album. If you wish to share the album as view-only, in the **Invite to album** dialog, instead of **Editor**, select **Viewer**.
{% endhint %}
### Generate a sharing URL
If you want to share some content with a peer who doesn’t use Immich, you can use the integrated link-sharing feature.
{% tabs %}
{% tab title="Share selected items" %}
1. Open the Immich web interface.
2. Select the items you want to share by clicking the checkmark in the upper-left corner of the thumbnail.
3. In the upper-right corner, select **Share**.
4. Optionally, enter a description for the items you are sharing.
5. Click **Create link**.
6. Highlight the generated URL, right-click it, and choose **Copy**.
Since you set the server’s Meshnet address as its external domain earlier, Immich will generate links using this address. This means that the receiving Meshnet peer can simply paste the link to their browser to view the shared content without needing to modify the link.
{% hint style="info" %}
**Note**
When accessing Immich over HTTP, the integrated button for copying generated links is disabled. As a result, sharing links must be copied manually.
{% endhint %}
{% endtab %}
{% tab title="Share an album" %}
1. Open the Immich web interface.
2. Navigate to the **Albums** page.
3. Hover your cursor over the album you want to share and click the three-dot menu button.
4. Choose **Share** and select **Create link**.
5. Optionally, enter a description for the content you are sharing.
6. Click **Create link**.
7. Highlight the generated URL, right-click it, and choose **Copy**.
Since you set the server’s Meshnet address as its external domain earlier, Immich will generate links using this address. This means that the receiving Meshnet peer can simply paste the link to their browser to view the shared content without needing to modify the link.
{% hint style="info" %}
**Note**
When accessing Immich over HTTP, the integrated button for copying generated links is disabled. As a result, sharing links must be copied manually.
{% endhint %}
{% endtab %}
{% endtabs %}
## (Advanced) Import an external library
The [external libraries feature](https://immich.app/docs/features/libraries) enables you to import a folder pre-filled with content, eliminating the need to upload everything manually. This is especially useful for individuals who already store their footage in a centralized location but want to take advantage of the management features that Immich provides.
### Modify the Compose file
First, you must update the Docker Compose file with the path of the library you want to import.
1. Using a text editor, open the `docker-compose.yml` file of your Immich instance.
2. Under the `volumes` section, append a new line using this format:
- <library/host/path>:/mnt/media/<directory>:ro
\
Where:
* `` is the path to the media folder you want to import.
* `` is a custom name of the folder where the library will be mounted inside the Immich container.\
\
**Example**
3. Save changes and close the `docker-compose.yml` file.
4. Open **PowerShell** (on Windows) or **Terminal** (on macOS and Linux) and navigate to your Immich directory using the `cd` command.
5. Run the command below to recreate the Immich server container with the updated Compose file.
docker compose up -d
Once the container restarts, the newly mounted volume will be available for importing in Immich.
{% hint style="info" %}
**Note**
The `:ro` parameter at the end of the volume line assigns read-only permissions to the container for the specific folder, ensuring that the data cannot be modified or deleted.
{% endhint %}
### Create a library
On your Immich web interface, take the following steps to create a new external library:
1. In the upper-right corner, click the user icon and choose **Administration**.
2. From the menu on the left, select **External libraries** and click **Create library**.
3. Choose the owner of the library and select **Create**.
4. Next to your new external library, click the three-dot menu icon, choose **Edit import paths**, and click **Add path**.
5. In the **Path** field, enter the mounting path of the new volume you added in the Compose file.\
\
**Example**
6. Click **Add** and then **Save**.
7. From the three-dot menu next to your library, choose **Scan** to index the items stored in the imported folder.
You should now see all of the media placed in the folder of the external library on the **Photos** page.
#### Rename the library
All new external libraries are assigned the same default name. For more convenient management, it is recommended to assign a unique and identifiable name to each library.
1. Next to the external library, click the three-dot menu button and choose **Rename**.
2. In the **Name** field, enter a unique name for the library.
3. Click **Save**.
### Turn on periodic scanning
Lastly, to ensure that new files from the external library are detected and indexed in Immich, you should turn on the periodic library scanning feature.
1. In the upper-right corner, click the user icon and choose **Administration**.
2. From the menu on the left, select **Settings**, locate **External library**, and expand the dropdown.
3. Under **Periodic scanning**, ensure that the **Enable periodic library scanning** toggle is turned on.
4. Optionally, select a custom scanning time interval by adjusting the values in the **Cron expression** field.
5. Click **Save**.
{% hint style="info" %}
**Note**
With the version `v1.94.0`, Immich introduced a **Library watching** feature that can be used instead of periodic scanning. The feature automatically imports new files when the server’s operating system detects changes in the external library folder. However, as of version `v.1.24.2`, the feature is still experimental and should be used with caution.
{% endhint %}
is a self-hosted and open-source tool for backing up and managing your images and videos. It offers an intuitive solution with a wide range of features, including multi-user support, asset sharing, and [facial recognition](https://nordvpn.com/blog/facial-recognition/). Unlike other self-hosted picture libraries, such as [LibrePhotos](https://meshnet.nordvpn.com/how-to/remote-files-media-access/librephotos-picture-library), Immich is primarily focused on backup functionality, allowing you to easily upload pictures from desktop and mobile platforms.
By supplementing your Immich setup with [Meshnet](https://nordvpn.com/meshnet/), you can enable secure content backup and remote access over an encrypted [NordLynx](https://nordvpn.com/blog/nordlynx-protocol-wireguard/) tunnel. This configuration does not require [port forwarding](https://nordvpn.com/blog/port-forwarding/) or experience with [firewalls](https://nordvpn.com/cybersecurity/glossary/firewall/). Even if you are on the other side of the globe, simply turn on Meshnet and connect to your Immich server as if you were on the same[ local area network](https://nordvpn.com/blog/what-is-lan/) (LAN).
This guide will walk you through the process of setting up a personal Immich instance and showcase how Meshnet can be integrated to allow for seamless remote connections to the server.
## Before you begin
Make sure that you have [Docker](https://docs.docker.com/get-started/overview/) and [Docker Compose](https://docs.docker.com/compose/) installed on your device. You can find instructions on how to download and install these tools on the Docker website:
* [Docker Desktop instructions for Windows](https://docs.docker.com/desktop/install/windows-install/)
* [Docker Desktop instructions for macOS](https://docs.docker.com/desktop/install/mac-install/)
* [Docker Desktop Instructions for Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Docker Engine instructions for Linux (CLI only)](https://docs.docker.com/engine/install/)
* [Docker Compose instructions for Linux (CLI only)](https://docs.docker.com/compose/install/linux/)
{% hint style="info" %}
**Note**
Docker Compose comes pre-installed with Docker Desktop.
{% endhint %}
## Run Immich using Docker
Immich operates as a multi-container app, comprising Docker containers for the server, database, and machine learning, all working together seamlessly. The Docker Compose tool is used to manage the preparation, deployment, and operation of these interconnected containers.
### Prepare the Immich directory
To start, you need to prepare a folder that will hold all files and data required to run Immich.
{% tabs %}
{% tab title="Windows" %}
1. Open **PowerShell**.
2. In your preferred directory, create a new `immich` folder and navigate to it using the following command:
