Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-07-09 03:04:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): collapse some small sections and add a note on MEDIA_LOCATION variable (#9150)

Browse Source 
* Update environment-variables.md

* Update config-file.md

* Update config-file.md

* Update command-line-interface.md

* linting
This commit is contained in:
Matthew Momjian 2024-04-29 10:23:13 -04:00 committed by GitHub
parent b4f6184aa6
commit ee4877b090
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 40 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/features/command-line-interface.md
View File

@ -44,11 +44,11 @@ Please modify the `IMMICH_INSTANCE_URL` and `IMMICH_API_KEY` environment variabl
## Usage
```
immich
```
<details>
<summary>Usage</summary>
```
$ immich
Usage: immich [options] [command]
Command line interface for Immich
@ -69,10 +69,15 @@ Commands:
help [command] display help for command
```
</details>
## Commands
The upload command supports the following options:
<details>
<summary>Options</summary>
```
Usage: immich upload [paths...] [options]
@ -94,19 +99,16 @@ Options:
--help display help for command
```
</details>
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
```

5
docs/docs/install/config-file.md
View File

@ -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:
<details>
<summary>immich.json</summary>
```json
{
"ffmpeg": {
@ -157,6 +160,8 @@ The default configuration looks like this:
}
```
</details>
:::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.

7
docs/docs/install/environment-variables.md
View File

@ -32,15 +32,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_MEDIA_LOCATION` | Media Location | `./upload`<sup>\*1</sup> | 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"`.