From ee4877b0905b7852931fe8488df9bbe8d8b5c270 Mon Sep 17 00:00:00 2001 From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> Date: Mon, 29 Apr 2024 10:23:13 -0400 Subject: [PATCH] chore(docs): collapse some small sections and add a note on MEDIA_LOCATION variable (#9150) * Update environment-variables.md * Update config-file.md * Update config-file.md * Update command-line-interface.md * linting --- docs/docs/features/command-line-interface.md | 44 ++++++++++---------- docs/docs/install/config-file.md | 5 +++ docs/docs/install/environment-variables.md | 21 ++++++---- 3 files changed, 40 insertions(+), 30 deletions(-) diff --git a/docs/docs/features/command-line-interface.md b/docs/docs/features/command-line-interface.md index 094de609ff..d616f77e8f 100644 --- a/docs/docs/features/command-line-interface.md +++ b/docs/docs/features/command-line-interface.md @@ -44,11 +44,11 @@ Please modify the `IMMICH_INSTANCE_URL` and `IMMICH_API_KEY` environment variabl ## Usage -``` -immich -``` +
+Usage ``` +$ immich Usage: immich [options] [command] Command line interface for Immich @@ -69,44 +69,46 @@ Commands: help [command] display help for command ``` +
+ ## Commands The upload command supports the following options: +
+Options + ``` Usage: immich upload [paths...] [options] Upload assets Arguments: - paths One or more paths to assets to be uploaded +paths One or more paths to assets to be uploaded Options: - -r, --recursive Recursive (default: false, env: IMMICH_RECURSIVE) - -i, --ignore [paths...] Paths to ignore (default: [], env: IMMICH_IGNORE_PATHS) - -h, --skip-hash Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH) - -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) - -c, --concurrency Number of assets to upload at the same time (default: 4, env: IMMICH_UPLOAD_CONCURRENCY) - --delete Delete local assets after upload (env: IMMICH_DELETE_ASSETS) - --help display help for command +-r, --recursive Recursive (default: false, env: IMMICH_RECURSIVE) +-i, --ignore [paths...] Paths to ignore (default: [], env: IMMICH_IGNORE_PATHS) +-h, --skip-hash Don't hash files before upload (default: false, env: IMMICH_SKIP_HASH) +-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) +-c, --concurrency Number of assets to upload at the same time (default: 4, env: IMMICH_UPLOAD_CONCURRENCY) +--delete Delete local assets after upload (env: IMMICH_DELETE_ASSETS) +--help display help for command ``` +
+ Note that the above options can read from environment variables as well. ## Quick Start -You begin by authenticating to your Immich server. - -```bash -immich login [url] [key] -``` - -For instance, +You begin by authenticating to your Immich server. For instance: ```bash +# immich login [url] [key] immich login http://192.168.1.216:2283/api HFEJ38DNSDUEG ``` diff --git a/docs/docs/install/config-file.md b/docs/docs/install/config-file.md index 256f3619f1..ad354e2c93 100644 --- a/docs/docs/install/config-file.md +++ b/docs/docs/install/config-file.md @@ -7,6 +7,9 @@ A config file can be provided as an alternative to the UI configuration. In JSON format, create a new config file (e.g. `immich.json`) and put it in a location that can be accessed by Immich. The default configuration looks like this: +
+immich.json + ```json { "ffmpeg": { @@ -157,6 +160,8 @@ The default configuration looks like this: } ``` +
+ :::tip In Administration > Settings is a button to copy the current configuration to your clipboard. So you can just grab it from there, paste it into a file and you're pretty much good to go. diff --git a/docs/docs/install/environment-variables.md b/docs/docs/install/environment-variables.md index 0e6a278f3e..6826107893 100644 --- a/docs/docs/install/environment-variables.md +++ b/docs/docs/install/environment-variables.md @@ -31,15 +31,18 @@ These environment variables are used by the `docker-compose.yml` file and do **N ## General -| Variable | Description | Default | Services | -| :------------------------------ | :------------------------------------------- | :------------------: | :-------------------------------------- | -| `TZ` | Timezone | | microservices | -| `NODE_ENV` | Environment (production, development) | `production` | server, microservices, machine learning | -| `LOG_LEVEL` | Log Level (verbose, debug, log, warn, error) | `log` | server, microservices, machine learning | -| `IMMICH_MEDIA_LOCATION` | Media Location | `./upload` | server, microservices | -| `IMMICH_CONFIG_FILE` | Path to config file | | server, microservices | -| `IMMICH_WEB_ROOT` | Path of root index.html | `/usr/src/app/www` | server | -| `IMMICH_REVERSE_GEOCODING_ROOT` | Path of reverse geocoding dump directory | `/usr/src/resources` | microservices | +| Variable | Description | Default | Services | +| :------------------------------ | :------------------------------------------- | :----------------------: | :-------------------------------------- | +| `TZ` | Timezone | | microservices | +| `NODE_ENV` | Environment (production, development) | `production` | server, microservices, machine learning | +| `LOG_LEVEL` | Log Level (verbose, debug, log, warn, error) | `log` | server, microservices, machine learning | +| `IMMICH_MEDIA_LOCATION` | Media Location | `./upload`\*1 | server, microservices | +| `IMMICH_CONFIG_FILE` | Path to config file | | server, microservices | +| `IMMICH_WEB_ROOT` | Path of root index.html | `/usr/src/app/www` | server | +| `IMMICH_REVERSE_GEOCODING_ROOT` | Path of reverse geocoding dump directory | `/usr/src/resources` | microservices | + +\*1: With the default `WORKDIR` of `/usr/src/app`, this path will resolve to `/usr/src/app/upload`. +It only need to be set if the Immich deployment method is changing. :::tip `TZ` should be set to a `TZ identifier` from [this list][tz-list]. For example, `TZ="Etc/UTC"`.