doc: Add content for usage section (#922)
This commit is contained in:
35
docs/docs/usage/automatic-backup.md
Normal file
35
docs/docs/usage/automatic-backup.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
|
||||
# Automatic Backup
|
||||
|
||||
A guide on how the foreground and background automatic backup works.
|
||||
|
||||
<img src={require('./img/background-foreground-backup.png').default} width="50%" title="Foreground&Background Backup" />
|
||||
|
||||
On iOS, there is only one option for automatic backup
|
||||
* [**Foreground backup**](#foreground-backup)
|
||||
|
||||
On Android, there are two options for automatic backup
|
||||
* [**Foreground backup**](#foreground-backup)
|
||||
* [**Background backup**](#background-backup)
|
||||
|
||||
## Foreground backup
|
||||
|
||||
If foreground backup is enabled. Whenever the app is opened or resumed, it will check if any photos or videos in the selected album(s) have yet to be uploaded to the cloud (the remainder count). If there are any, it will upload them to the cloud.
|
||||
|
||||
## Background backup
|
||||
|
||||
Background backup is only available on Android thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy).
|
||||
|
||||
If background backup is enabled. The app will periodically check if any photos or videos in the selected album(s) still need to be uploaded to the cloud. If there are any, it will upload them to the cloud in the background.
|
||||
|
||||
A native Android notification shows up when the background upload is in progress. You can further customize the notification by going to the app's settings.
|
||||
|
||||
:::note
|
||||
* The app must be in the background for the backup worker to start running.
|
||||
* It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone.
|
||||
* If you reopen the app and the first page you see is the backup page, the counts will reflect the background uploaded result. You have to navigate out of the page and come back to see the updated counts.
|
||||
:::
|
||||
75
docs/docs/usage/bulk-upload.md
Normal file
75
docs/docs/usage/bulk-upload.md
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Bulk Upload (Using the CLI)
|
||||
|
||||
You can use the CLI to upload the existing gallery to the Immich's server
|
||||
|
||||
[Immich CLI Repository](https://github.com/immich-app/CLI)
|
||||
|
||||
|
||||
## Requirements
|
||||
* Node.js 16 or above
|
||||
* Npm
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
npm i -g immich
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
Specify user's credential, Immich's server address and port and the directory you would like to upload videos/photos from.
|
||||
|
||||
```bash
|
||||
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Description |
|
||||
| ---------------- | ------------------------------------------------------------------- |
|
||||
| --yes / -y | Assume yes on all interactive prompts |
|
||||
| --delete / -da | Delete local assets after upload |
|
||||
| --email / -e | User's email |
|
||||
| --password / -pw | User's password |
|
||||
| --server / -s | Immich's server address |
|
||||
| --directory / -d | Directory to upload from |
|
||||
| --threads / -t | Number of threads to use (Default 5) |
|
||||
| --album/ -al | Create albums for assets based on the parent folder or a given name |
|
||||
|
||||
### Run via Docker
|
||||
|
||||
Be aware that as this runs inside a container, it mounts your current directory as a volume and for the -d flag you need to use the path inside the container.
|
||||
|
||||
```bash
|
||||
docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import
|
||||
```
|
||||
|
||||
Optionally, you can create an alias:
|
||||
|
||||
```bash
|
||||
alias immich="docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest"
|
||||
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import
|
||||
```
|
||||
|
||||
### Run from source
|
||||
|
||||
```bash title="Clone Repository"
|
||||
git clone https://github.com/alextran1502/immich-cli
|
||||
```
|
||||
|
||||
|
||||
```bash title="Install dependencies"
|
||||
npm install
|
||||
```
|
||||
|
||||
```bash title="Build the project"
|
||||
npm run build
|
||||
```
|
||||
|
||||
```bash title="Run the command"
|
||||
node bin/index.js upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory
|
||||
```
|
||||
BIN
docs/docs/usage/img/admin-registration-form.png
Normal file
BIN
docs/docs/usage/img/admin-registration-form.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/docs/usage/img/album-selection.png
Normal file
BIN
docs/docs/usage/img/album-selection.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
BIN
docs/docs/usage/img/background-foreground-backup.png
Normal file
BIN
docs/docs/usage/img/background-foreground-backup.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 220 KiB |
BIN
docs/docs/usage/img/backup-header.png
Normal file
BIN
docs/docs/usage/img/backup-header.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
docs/docs/usage/img/create-new-user.png
Normal file
BIN
docs/docs/usage/img/create-new-user.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
BIN
docs/docs/usage/img/sign-in-phone.jpeg
Normal file
BIN
docs/docs/usage/img/sign-in-phone.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 321 KiB |
57
docs/docs/usage/post-installation.md
Normal file
57
docs/docs/usage/post-installation.md
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Post Installation
|
||||
|
||||
This page contains information about what to do after you have installed the application.
|
||||
|
||||
## Step 1 - Download the mobile app
|
||||
|
||||
The mobile app can be downloaded from
|
||||
|
||||
- [Google Play Store](https://play.google.com/store/apps/details?id=app.alextran.immich)
|
||||
- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
|
||||
- [F-Droid](https://f-droid.org/packages/app.alextran.immich)
|
||||
|
||||
## Step 2 - Registering the admin user
|
||||
|
||||
The first user to register will be the admin user. The admin user will be able to add other users to the application.
|
||||
|
||||
To register for the admin user, access the web application at `http://<machine-ip-address>:2283` and click on the **Getting Started** button.
|
||||
|
||||
<img src={require('./img/admin-registration-form.png').default} width="500" title="Admin Registration" />
|
||||
|
||||
Follow the prompts to register as the admin user and log in to the application.
|
||||
|
||||
## Step 3 - Creating a new user (optional)
|
||||
|
||||
If you have a family member who wants to use the application, you can create a new account. The default password is `password`, and the user can change their password after logging in to the application for the first time.
|
||||
|
||||
<img src={require('./img/create-new-user.png').default} title="Admin Registration" />
|
||||
|
||||
## Step 4 - Access the mobile app
|
||||
|
||||
Login to the mobile app with the server endpoint URL at `http://<machine-ip-address>:2283/api`
|
||||
|
||||
<img src={require('./img/sign-in-phone.jpeg').default} width="50%" title="Mobile App Sign In" />
|
||||
|
||||
## Step 5 - Back up your photos and videos
|
||||
|
||||
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 the album you want to back up from the backup screen to the Immich server.
|
||||
|
||||
<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.
|
||||
|
||||
You can also enable auto foreground or background backup (only on Android). For more information about the app mechanism, please visit the next pages.
|
||||
|
||||
|
||||
:::tip Application Mechanism
|
||||
#### [Foreground and background backup](/docs/usage/automatic-backup)
|
||||
#### [Bulk upload (using the CLI)](/docs/usage/bulk-upload)
|
||||
:::
|
||||
Reference in New Issue
Block a user