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: backup only selected photos #14225

Merged
merged 4 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/docs/features/mobile-app.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import Icon from '@mdi/react';
import { mdiCloudOffOutline, mdiCloudCheckOutline } from '@mdi/js';
import MobileAppDownload from '/docs/partials/_mobile-app-download.md';
import MobileAppLogin from '/docs/partials/_mobile-app-login.md';
import MobileAppBackup from '/docs/partials/_mobile-app-backup.md';
import { cloudDonePath, cloudOffPath } from '@site/src/components/svg-paths';

# Mobile App

Expand Down Expand Up @@ -28,6 +31,22 @@ The beta release channel allows users to test upcoming changes before they are o
You can enable automatic backup on supported devices. For more information see [Automatic Backup](/docs/features/automatic-backup.md).
:::

## Sync only selected photos
If you have large number of photos on the device, and you would prefer not to backup all the photos, then it might be prudent to only backup selected photos from device to the Immich server.
zackpollard marked this conversation as resolved.
Show resolved Hide resolved

First, you need to enable the Storage Indicator in your app's settings. Navigate to **<ins>Settings -> Photo Grid</ins>** and enable **"Show Storage indicator on asset tiles"**; this makes it easy to distinguish local-only assets and synced assets.
:::note
This will enable a small cloud icon on the bottom right corner of the asset tile, indicating that the asset is synced to the server:


1. <Icon path={mdiCloudOffOutline} size={1} /> - Local-only asset; not synced to the server
2. <Icon path={mdiCloudCheckOutline} size={1} /> - Asset is synced to the server
:::

Now make sure that the local album is selected in the backup screen (steps 1-2 above). You can find these albums listed in **<ins>Library -> On this device</ins>**. To selectively upload photos from these albums, simply select the local-only photos and tap on "Upload" button in the dynamic bottom menu.
<img src={require('./img/mobile-upload-open-photo.png').default} width='50%' title='Upload button on local asset preview' />
<img src={require('./img/mobile-upload-selected-photos.png').default} width='40%' title='Upload button after photos selection' />

## 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.
Expand Down
1 change: 1 addition & 0 deletions docs/docs/overview/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ import MobileAppBackup from '/docs/partials/_mobile-app-backup.md';

The backup time differs depending on how many photos are on your mobile device. Large uploads may
take quite a while.
To quickly get going, you can selectively upload few photos first, by following this [guide](/docs/features/mobile-app#sync-only-selected-photos).

You can select the **Jobs** tab to see Immich processing your photos.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/partials/_mobile-app-backup.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.
1. Navigate to the backup screen by clicking on the cloud icon in the top right corner of the screen.

<img src={require('./img/backup-header.png').default} width='50%' title='Backup button' />

You can select which album(s) you want to back up to the Immich server from the backup screen.
2. You can select which album(s) you want to back up to the Immich server from the backup screen.

<img src={require('./img/album-selection.png').default} width='50%' title='Backup button' />

Scroll down to the bottom and press "**Start Backup**" to start the backup process.
3. Scroll down to the bottom and press "**Start Backup**" to start the backup process. This will upload all the assets in the selected albums.