mirror of
https://github.com/immich-app/immich.git
synced 2024-12-29 15:11:58 +00:00
docs: remove read-only related content (#4781)
* docs: remove read-only related content * format * broken link
This commit is contained in:
Alex
GitHub
parent
1d35965d03
commit
d8903de92e
3 changed files with 0 additions and 167 deletions
|
|
@ -33,8 +33,6 @@ To be concise, Immich can now read in the gallery files, register the path into
|
||||||
- Only new files that are added to the gallery will be detected.
|
- Only new files that are added to the gallery will be detected.
|
||||||
- Deleted and moved files will not be detected.
|
- Deleted and moved files will not be detected.
|
||||||
|
|
||||||
You can find more information on how to use the feature by reading the documentation [here](/docs/features/read-only-gallery).
|
|
||||||
|
|
||||||
## Memory feature
|
## Memory feature
|
||||||
|
|
||||||
This is considered a fun feature that the team and I wanted to build for so long, but we had to put it off because of the refactoring of the code base. The code base is now in a good enough form to circle back and add more exciting features.
|
This is considered a fun feature that the team and I wanted to build for so long, but we had to put it off because of the refactoring of the code base. The code base is now in a good enough form to circle back and add more exciting features.
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,6 @@ immich
|
||||||
| --server / -s | Immich's server address |
|
| --server / -s | Immich's server address |
|
||||||
| --threads / -t | Number of threads to use (Default 5) |
|
| --threads / -t | Number of threads to use (Default 5) |
|
||||||
| --album/ -al | Create albums for assets based on the parent folder or a given name |
|
| --album/ -al | Create albums for assets based on the parent folder or a given name |
|
||||||
| --import/ -i | Import gallery (assets are not uploaded) |
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
|
@ -108,70 +107,3 @@ npm run build
|
||||||
```bash title="Run the command"
|
```bash title="Run the command"
|
||||||
node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive your/asset/directory
|
node bin/index.js upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive your/asset/directory
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Importing existing libraries
|
|
||||||
|
|
||||||
If you do not wish to upload files into the server, existing files can be imported into the immich gallery through the use of the `--import` flag.
|
|
||||||
|
|
||||||
```
|
|
||||||
immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive directory/ --import
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api file1.jpg file2.jpg --import
|
|
||||||
```
|
|
||||||
|
|
||||||
The `immich-server` and `immich-microservices` containers must be able to access the files, or directories at the path referenced in the command. The directories referenced must be set under a user's `External Path` setting. More detailed instructions can be found [here](/docs/features/read-only-gallery).
|
|
||||||
|
|
||||||
:::tip Matching volume references
|
|
||||||
The import command is most easily run on the machine running the immich service, as the path to the files on the machine running the command and the server much match identically.
|
|
||||||
|
|
||||||
If you are running immich within docker, the volume pointing to your existing library should be identical with your host machine.
|
|
||||||
|
|
||||||
```diff title="docker-compose.yml"
|
|
||||||
immich-server:
|
|
||||||
container_name: immich_server
|
|
||||||
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
|
|
||||||
command: [ "start.sh", "immich" ]
|
|
||||||
volumes:
|
|
||||||
- ${UPLOAD_LOCATION}:/usr/src/app/upload
|
|
||||||
+ - /path/to/media:/path/to/media
|
|
||||||
env_file:
|
|
||||||
- .env
|
|
||||||
depends_on:
|
|
||||||
- redis
|
|
||||||
- database
|
|
||||||
- typesense
|
|
||||||
restart: always
|
|
||||||
|
|
||||||
immich-microservices:
|
|
||||||
container_name: immich_microservices
|
|
||||||
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
|
|
||||||
command: [ "start.sh", "microservices" ]
|
|
||||||
volumes:
|
|
||||||
- ${UPLOAD_LOCATION}:/usr/src/app/upload
|
|
||||||
+ - /path/to/media:/path/to/media
|
|
||||||
env_file:
|
|
||||||
- .env
|
|
||||||
depends_on:
|
|
||||||
- redis
|
|
||||||
- database
|
|
||||||
- typesense
|
|
||||||
restart: always
|
|
||||||
```
|
|
||||||
|
|
||||||
The proper command for above would be as shown below. You should have access to `/path/to/media` exactly on the environment the CLI command is being run on
|
|
||||||
|
|
||||||
```
|
|
||||||
immich upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive /path/to/media --import
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are running the import using the docker command, please note that the volumes should point to the `/path/to/media` exactly on the environment the CLI command is being run on
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -it --rm -v "/path/to/media:/path/to/media" ghcr.io/immich-app/immich-cli:latest upload --key HFEJ38DNSDUEG --server http://192.168.1.216:2283/api --recursive /path/to/media --import
|
|
||||||
```
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
|
||||||
|
|
@ -1,97 +0,0 @@
|
||||||
# Read-only Gallery [Deprecated]
|
|
||||||
|
|
||||||
:::caution
|
|
||||||
|
|
||||||
This feature is being deprecated in favor of [Libraries](/docs/features/libraries.md).
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
This feature enables users to use an existing gallery without uploading the assets to Immich.
|
|
||||||
|
|
||||||
Upon syncing the file information, it will be read by Immich to generate supported files.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
:::tip Example scenario
|
|
||||||
|
|
||||||
On the VM/system that Immich is running, I have 2 galleries that I want to use with Immich.
|
|
||||||
|
|
||||||
- My gallery is stored at `/mnt/media/precious-memory`
|
|
||||||
- My wife's gallery is stored at `/mnt/media/childhood-memory`
|
|
||||||
|
|
||||||
We will use those values in the steps below.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Mount the gallery to the containers.
|
|
||||||
|
|
||||||
`immich-server` and `immich-microservices` containers will need access to the gallery. Mount the directory path as in the example below
|
|
||||||
|
|
||||||
```diff title="docker-compose.yml"
|
|
||||||
immich-server:
|
|
||||||
container_name: immich_server
|
|
||||||
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
|
|
||||||
command: [ "start.sh", "immich" ]
|
|
||||||
volumes:
|
|
||||||
- ${UPLOAD_LOCATION}:/usr/src/app/upload
|
|
||||||
+ - /mnt/media/precious-memory:/mnt/media/precious-memory:ro
|
|
||||||
+ - /mnt/media/childhood-memory:/mnt/media/childhood-memory:ro
|
|
||||||
env_file:
|
|
||||||
- .env
|
|
||||||
depends_on:
|
|
||||||
- redis
|
|
||||||
- database
|
|
||||||
- typesense
|
|
||||||
restart: always
|
|
||||||
|
|
||||||
immich-microservices:
|
|
||||||
container_name: immich_microservices
|
|
||||||
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
|
|
||||||
command: [ "start.sh", "microservices" ]
|
|
||||||
volumes:
|
|
||||||
- ${UPLOAD_LOCATION}:/usr/src/app/upload
|
|
||||||
+ - /mnt/media/precious-memory:/mnt/media/precious-memory:ro
|
|
||||||
+ - /mnt/media/childhood-memory:/mnt/media/childhood-memory:ro
|
|
||||||
env_file:
|
|
||||||
- .env
|
|
||||||
depends_on:
|
|
||||||
- redis
|
|
||||||
- database
|
|
||||||
- typesense
|
|
||||||
restart: always
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip
|
|
||||||
Internal and external path have to be identical.
|
|
||||||
:::
|
|
||||||
|
|
||||||
_Remember to bring the container down/up to register the changes. Make sure you can see the mounted path in the container._
|
|
||||||
|
|
||||||
### Register the path for the user.
|
|
||||||
|
|
||||||
This action is done by the admin of the instance.
|
|
||||||
|
|
||||||
- Navigate to `Administration > Users` page on the web.
|
|
||||||
- Click on the user edit button.
|
|
||||||
- Add the gallery path to the `External Path` field for the corresponding user and confirm the changes.
|
|
||||||
|
|
||||||
<img src={require('./img/me.png').default} width='33%' title='My Account Storage Path' />
|
|
||||||
|
|
||||||
<img src={require('./img/my-wife.png').default} width='33%' title='My Wifes Account Storage Path' />
|
|
||||||
|
|
||||||
### Sync with the CLI tool.
|
|
||||||
|
|
||||||
- Install or update the [CLI Tool](/docs/features/bulk-upload.md). The import feature is supported from version `v0.39.0` of the CLI
|
|
||||||
- Run the command below to sync the gallery with Immich.
|
|
||||||
|
|
||||||
```bash title="Import my gallery"
|
|
||||||
immich upload --key <my-api-key> --server http://my-server-ip:2283/api /mnt/media/precious-memory --recursive --import
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash title="Import my wife gallery"
|
|
||||||
immich upload --key <my-wife-api-key> --server http://my-server-ip:2283/api /mnt/media/childhood-memory --recursive --import
|
|
||||||
```
|
|
||||||
|
|
||||||
The `--import` flag will tell Immich to import the files by path instead of uploading them.
|
|
||||||
Loading…
Reference in a new issue