Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add info about album sync&folder view #12371

Merged
merged 13 commits into from
Oct 29, 2024
Binary file added docs/docs/features/img/folder-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/docs/features/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,22 @@ If you get an error here, please rename the other external library to something

Within seconds, the assets from the old-pics and videos folders should show up in the main timeline.

### Folder view

:::info
This feature also exists for assets uploaded other than through external libraries.
:::tip
You can use the storage template migration feature for the best experience with uploaded assets in this view.
:::

You can browse your photos and videos by folder like in a file explorer.

Enable this feature from the Users Settings > Features > Folders.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a my.immich.app link here?


The UI is currently only available for the web; mobile will come in a subsequent release.

<img src={require('./img/folder-view.png').default} width="75%" title='Folder-view' />

### Set Custom Scan Interval

:::note
Expand Down
36 changes: 36 additions & 0 deletions docs/docs/features/mobile-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,39 @@ The beta release channel allows users to test upcoming changes before they are o
:::info
You can enable automatic backup on supported devices. For more information see [Automatic Backup](/docs/features/automatic-backup.md).
:::

## Album Sync

You can sync or mirror an album from your phone to the Immich server on your account. For example, if you select Recents, Camera and Videos album for backup, the corresponding album with the same name will be created on the server. Once the assets from those albums are uploaded, they will be put into the target albums automatically.

### Album Synchronization Highlights

- **One-Way Sync:** Synchronization is one-way, from the device to the server.

- **Name Matching:** If an album on the server has the same name as the album on the device, images from the device will be merged with the existing images in the server album.

- **Shared Albums:** If the matching album on the server is shared, the new photos merged into the album will also be shared.

- **Album Structure:** When an album is created for the first time, its structure is based on the initial state. Future updates made on the phone (such as deleting or repositioning photos) will not be reflected in Immich.

- **User-Specific Sync:** Album synchronization is unique to each server user and does not sync between different users or partners.

- **Mobile-Only Feature:** Album synchronization is currently only available on mobile. For similar options on a computer, refer to [Libraries](/docs/features/libraries) for further details.

### Synchronizing albums from the past

Albums can be synchronized to the server even if they did not exist on the server before, in order to apply this setting you have to:
alextran1502 marked this conversation as resolved.
Show resolved Hide resolved
Enter the cloud on the top right -> cog wheel on the top right -> and select the sync option under Sync albums.
alextran1502 marked this conversation as resolved.
Show resolved Hide resolved

:::info Sync albums delete/move photos
If you delete/move photos in the local album on your device, it will not be reflected in the album on the server **even if** you click Sync albums
It will only reflect files you add.
:::

If the same asset is in more than one album it will only sync to the first album it's in, after that it won't sync again even if the user clicks sync albums manually.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first album it's in

I actually don't really know if this will necessarily be the first album he appears on
And if so, how does he know what the first album he appeared on was.

To overcome this limitation, the files must be removed from the blacklist by
App settings -> Advanced -> Duplicate Assets -> Clear

:::info
Cleaning duplicate assets from the list will cause all the previously uploaded duplicate files to be re-uploaded, the files will not actually be uploaded and will be rejected on the server side (due to duplication) but will be synchronized to the album and at the end will be added to the black list again at the end of the synchronization.
:::
Loading