diff --git a/docs/docs/install/environment-variables.md b/docs/docs/install/environment-variables.md
index 09fadbf70..48d7219d1 100644
--- a/docs/docs/install/environment-variables.md
+++ b/docs/docs/install/environment-variables.md
@@ -61,13 +61,16 @@ These environment variables are used by the `docker-compose.yml` file and do **N
## Database
| Variable | Description | Default | Services |
-| :------------ | :---------------- | :---------: | :-------------------- |
+| :---------------------------------- | :------------------------------------------------------------ | :----------: | :-------------------- |
| `DB_URL` | Database URL | | server, microservices |
| `DB_HOSTNAME` | Database Host | `localhost` | server, microservices |
| `DB_PORT` | Database Port | `5432` | server, microservices |
| `DB_USERNAME` | Database User | `postgres` | server, microservices |
| `DB_PASSWORD` | Database Password | `postgres` | server, microservices |
| `DB_DATABASE` | Database Name | `immich` | server, microservices |
+| `DB_VECTOR_EXTENSION`<sup>\*1</sup> | Database Vector Extension (one of [`pgvector`, `pgvecto.rs`]) | `pgvecto.rs` | server, microservices |
+
+\*1: This setting cannot be changed after the server has successfully started up
:::info
diff --git a/docs/docs/features/command-line-interface.md b/docs/docs/features/command-line-interface.md
index ee7ca1c22..360b3c372 100644
--- a/docs/docs/features/command-line-interface.md
+++ b/docs/docs/features/command-line-interface.md
@@ -15,10 +15,12 @@ If you are looking to import your Google Photos takeout, we recommend this commu
## Requirements
-- Node.js 20.0 or above
+- Node.js 20 or above
- Npm
-## Installation
+If you can't install node/npm, there is also a Docker version available below.
+
+## Installation (NPM)
```bash
npm i -g @immich/cli
@@ -30,6 +32,16 @@ NOTE: if you previously installed the legacy CLI, you will need to uninstall it
npm uninstall -g immich
+## Installation (Docker)
+
+If npm is not available on your system you can try the Docker version
+
+bash +docker run -it -v "$(pwd)":/import:ro -e IMMICH_INSTANCE_URL=https://your-immich-instance/api -e IMMICH_API_KEY=your-api-key ghcr.io/immich-app/immich-cli:latest +
+
+Please modify the IMMICH_INSTANCE_URL and IMMICH_API_KEY environment variables as suitable. You can also use a Docker env file to store your sensitive API key.
+
Usage
@@ -39,10 +51,11 @@ immich
Usage: immich [options] [command]
-Immich command line interface
+Command line interface for Immich
Options:
-V, --version output the version number
-d, --config Configuration directory (env: IMMICH_CONFIG_DIR)
-h, --help display help for command
-H, --include-hidden Include hidden folders (default: false, env: IMMICH_INCLUDE_HIDDEN)
-a, --album Automatically create albums based on folder name (default: false, env: IMMICH_AUTO_CREATE_ALBUM)
-A, --album-name Add all assets to specified album (env: IMMICH_ALBUM_NAME)
-n, --dry-run Don't perform any actions, just show what will be done (default: false, env: IMMICH_DRY_RUN)
--delete Delete local assets after upload (env: IMMICH_DELETE_ASSETS)
--help display help for command
@@ -91,7 +106,7 @@ For instance,
immich login-key http://192.168.1.216:2283/api HFEJ38DNSDUEG
-This will store your credentials in a file in your home directory. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.
+This will store your credentials in a auth.yml file in the configuration directory which defaults to ~/.config/. The directory can be set with the -d option or the environment variable IMMICH_CONFIG_DIR. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.
Once you are authenticated, you can upload assets to your Immich server.
@@ -123,6 +138,12 @@ You can automatically create albums based on the folder name by passing the `--a
immich upload --album --recursive directory/
+You can also choose to upload all assets to a specific album with the `--album-name` option.
+
+```bash
+immich upload --album-name "My summer holiday" --recursive directory/
+```
+
It is possible to skip assets matching a glob pattern by passing the `--ignore` option. See [the library documentation](docs/features/libraries.md) on how to use glob patterns. You can add several exclusion patterns if needed.
```bash
@@ -133,6 +154,12 @@ immich upload --ignore **/Raw/** --recursive directory/
immich upload --ignore **/Raw/** **/*.tif --recursive directory/
+By default, hidden files are skipped. If you want to include hidden files, use the --include-hidden option:
+
+bash +immich upload --include-hidden --recursive directory/ +
+
Obtain the API Key
The API key can be obtained in the user setting panel on the web interface.
/home/runner/work/immich-distribution/immich-distribution
/tmp/tmp.SpCKD0rF8c removed
## Base image
Check the base images for recent relevant changes:
* https://github.com/immich-app/base-images/commits/main/
## Checklist
* Review the changes above
* Possible write a news entry (and push it to this PR)
* Wait for the CI to finish
* Merge the PR
ref #154
This PR bumps the version from v1.94.1 to v1.95.0. Please review the changes and merge this PR if everything looks good.
Upstream release notes
Monitored upstream files
Error, web/README.md do not exists
+## Installation (Docker) + +If npm is not available on your system you can try the Docker version + +
bash +docker run -it -v "$(pwd)":/import:ro -e IMMICH_INSTANCE_URL=https://your-immich-instance/api -e IMMICH_API_KEY=your-api-key ghcr.io/immich-app/immich-cli:latest +
+ +Please modify theIMMICH_INSTANCE_URL
andIMMICH_API_KEY
environment variables as suitable. You can also use a Docker env file to store your sensitive API key. +Usage
Usage: immich [options] [command]
-Immich command line interface +Command line interface for Immich
Options: -V, --version output the version number
-d, --config Configuration directory (env: IMMICH_CONFIG_DIR) -h, --help display help for command
Commands: @@ -69,7 +82,9 @@ Options: -r, --recursive Recursive (default: false, env: IMMICH_RECURSIVE) -i, --ignore [paths...] Paths to ignore (env: IMMICH_IGNORE_PATHS) -h, --skip-hash Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH)
-This will store your credentials in a file in your home directory. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually. +This will store your credentials in a
auth.yml
file in the configuration directory which defaults to~/.config/
. The directory can be set with the-d
option or the environment variableIMMICH_CONFIG_DIR
. Please keep the file secure, either by performing the logout command after you are done, or deleting it manually.Once you are authenticated, you can upload assets to your Immich server.
@@ -123,6 +138,12 @@ You can automatically create albums based on the folder name by passing the `--a immich upload --album --recursive directory/
+By default, hidden files are skipped. If you want to include hidden files, use the
--include-hidden
option: + +bash +immich upload --include-hidden --recursive directory/ +
+Obtain the API Key
The API key can be obtained in the user setting panel on the web interface.