Which environment variables are used by each container?

stavros-k · 2023-06-16T16:23:57.980Z

Hello, I'm trying to figure out which environment variables are used by each containers, but I don't see them anywhere documented (only what they do, but not which continer makes use of them). What I'm trying to accomplish: I want each container to have exactly the info it needs, no more no less. For example, I don't think the proxy needs the database credentials. Is there somewhere I can get this info? Thanks

B

bo0tzz•6/16/23, 4:25 PM

There is no good documentation of this yet, it's one of the things we've been putting off unfortunately

S

stavros-kOP•6/16/23, 4:26 PM

I don't mind looking into the code, assuming that for each service/container there is a "config init" file.
If there is such thing, can you point me to it?

J

jrasm91•6/16/23, 4:29 PM

The best way is to just do a search for

process.env.

process.env.

process.env.

process.env. that will show most of the variables.

S

stavros-kOP•6/16/23, 4:30 PM

Thanks

S

stavros-kOP•6/16/23, 4:30 PM

I'll see if I can create a small

.md

.md

.md

.md file with a table.
And you can update/fix/extend it afterwards

J

jrasm91•6/16/23, 4:31 PM

It would be great to add a section to the docs.

S

stavros-kOP•6/16/23, 4:32 PM

Sounds good!

J

jrasm91•6/16/23, 4:32 PM

In the

docs/

docs/

docs/

docs/ folder you can run the docs locally and they work with .md files. You could add a new section under administration for

Environment Variables

Environment Variables

Environment Variables

Environment Variables

J

jrasm91•6/16/23, 4:33 PM

We can help correct and update them if you put together an initial draft. I'd also like to simpliy/consolidate this and whitelist the specific env variables in the compose files as well.

S

stavros-kOP•6/16/23, 4:33 PM

Jjrasm91 In the `docs/` folder you can run the docs locally and they work with .md files....

B

bo0tzz•6/16/23, 4:34 PM

Nitpick but under the install section might be a better spot?

B

bo0tzz•6/16/23, 4:34 PM

Administration is mostly concerned with things in the UI

J

jrasm91•6/16/23, 4:34 PM

Fair enough, yeah that's probably better.

J

jrasm91•6/16/23, 4:35 PM

I'd also love to delete all the comments from the example.env and all the other places they show up (copied) in the docs.

J

jrasm91•6/16/23, 4:35 PM

Jjrasm91 I'd also love to delete all the comments from the example.env and all the other ...

B

bo0tzz•6/16/23, 4:35 PM

Yeah absolutely, I'd love for all that documentation to be in this new page instead

J

jrasm91•6/16/23, 4:35 PM

Yes, just link to the new page instead.

B

bo0tzz•6/16/23, 4:35 PM

So the example.env is only the vars that are strictly required, and nothing else

S

stavros-kOP•6/16/23, 4:48 PM

I suppose server + microservices use the same envs right?

B

bo0tzz•6/16/23, 4:49 PM

Mostly yes, I think there may be a handful that are different though?

J

jrasm91•6/16/23, 4:49 PM

There is a port one specific to each

S

stavros-kOP•6/16/23, 4:49 PM

Cool I'll keep an eye

J

jrasm91•6/16/23, 4:50 PM

Both use

NODE_ENV

NODE_ENV

NODE_ENV

NODE_ENV,

DB*

DB*

DB*

DB*,

REDIS*

REDIS*

REDIS*

REDIS*,

TYPESENSE*

TYPESENSE*

TYPESENSE*

TYPESENSE*

J

jrasm91•6/16/23, 4:51 PM

Both use

IMMICH_MEDIA_LOCATION

IMMICH_MEDIA_LOCATION

IMMICH_MEDIA_LOCATION

IMMICH_MEDIA_LOCATION and

IMMICH_MACHINE_LEARNING_URL

IMMICH_MACHINE_LEARNING_URL

IMMICH_MACHINE_LEARNING_URL

IMMICH_MACHINE_LEARNING_URL

Jjrasm91 Both use `NODE_ENV`, `DB*`, `REDIS*`, `TYPESENSE*`

S

stavros-kOP•6/16/23, 4:51 PM

and

TZ

TZ

TZ

TZ ?

J

jrasm91•6/16/23, 4:51 PM

That's just for testing

J

jrasm91•6/16/23, 4:52 PM

Some unit tests would fail depending on what timezone you were running them in

S

stavros-kOP•6/16/23, 4:52 PM

I see it's added in the FAQ
https://immich.app/docs/FAQ#why-does-my-uploaded-photo-show-up-with-the-wrong-date-or-time-in-immich

FAQ | Immich

What is the difference between the cloud icon on the mobile app?

J

jrasm91•6/16/23, 4:52 PM

REVERSE_GEOCODING*

REVERSE_GEOCODING*

REVERSE_GEOCODING*

REVERSE_GEOCODING* is only used in microservices I believe

J

jrasm91•6/16/23, 4:53 PM

TZ

TZ

TZ

TZ is not specific to immich

S

stavros-kOP•6/16/23, 4:54 PM

Yea it's system specific, but for example microsservices use it, if I'm understanding correctly

J

jrasm91•6/16/23, 4:54 PM

No we don't.

J

jrasm91•6/16/23, 4:55 PM

We use exiftool to extract metadata and it uses the time zone of the container as a fallback in some situations.

J

jrasm91•6/16/23, 4:55 PM

Microservices uses exif tool and exif tool uses TZ in some situations. If you want to document that, that's fine with me.

J

jrasm91•6/16/23, 4:56 PM

It's not an "immich" envirionment variable in my opinion if we don't ever read it and do something based it being set to something.

J

jrasm91•6/16/23, 4:56 PM

But it's worth noting we use certain tools which can be configured with their own environment variables, which should have their own documentation somewhere.

S

stavros-kOP•6/16/23, 4:58 PM

This an initial draft so far.
Categories can be added for those tools
(Description could be expanded later)

# Environment Variables

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|       `TZ`       |    Timezone    |        `UTC`         | microservices   |
|       `NODE_ENV`       |    Node Environment    |        `production`         | server, microservices   |

> `TZ` is only used by the `exiftool` in the microservices container.
> It is considered as a fallback timezone if the timezone cannot be determined from the image metadata.

## Redis

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `REDIS_URL`    |   Redis URL    | `` | server, microservices   |
|   `REDIS_HOST`   |   Redis Host   |    `immich_redis`    | server, microservices   |
|   `REDIS_PORT`   |   Redis Port   |        `6379`        | server, microservices   |
|  `REDIS_INDEX`   |  Redis Index   |         `0`          | server, microservices   |
| `REDIS_USERNAME` | Redis Username |        ``        | server, microservices   |
| `REDIS_PASSWORD` | Redis Password |        ``        | server, microservices   |
| `REDIS_SOCKET`   | Redis Socket   |        ``        | server, microservices   |

`REDIS_SOCKET`

## Typesense

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `TYPESENSE_URL`    |   Typesense URL    | `` | server, microservices   |
|   `TYPESENSE_API_KEY`    |   Typesense API Key    | `` | server, microservices   |
|   `TYPESENSE_HOST`    |   Typesense Host    | `typesense` | server, microservices   |
|   `TYPESENSE_PORT`    |   Typesense Port    | `8108` | server, microservices   |
|   `TYPESENSE_PROTOCOL`    |   Typesense Protocol    | `http` | server, microservices   |

# Environment Variables

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|       `TZ`       |    Timezone    |        `UTC`         | microservices   |
|       `NODE_ENV`       |    Node Environment    |        `production`         | server, microservices   |

> `TZ` is only used by the `exiftool` in the microservices container.
> It is considered as a fallback timezone if the timezone cannot be determined from the image metadata.

## Redis

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `REDIS_URL`    |   Redis URL    | `` | server, microservices   |
|   `REDIS_HOST`   |   Redis Host   |    `immich_redis`    | server, microservices   |
|   `REDIS_PORT`   |   Redis Port   |        `6379`        | server, microservices   |
|  `REDIS_INDEX`   |  Redis Index   |         `0`          | server, microservices   |
| `REDIS_USERNAME` | Redis Username |        ``        | server, microservices   |
| `REDIS_PASSWORD` | Redis Password |        ``        | server, microservices   |
| `REDIS_SOCKET`   | Redis Socket   |        ``        | server, microservices   |

`REDIS_SOCKET`

## Typesense

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `TYPESENSE_URL`    |   Typesense URL    | `` | server, microservices   |
|   `TYPESENSE_API_KEY`    |   Typesense API Key    | `` | server, microservices   |
|   `TYPESENSE_HOST`    |   Typesense Host    | `typesense` | server, microservices   |
|   `TYPESENSE_PORT`    |   Typesense Port    | `8108` | server, microservices   |
|   `TYPESENSE_PROTOCOL`    |   Typesense Protocol    | `http` | server, microservices   |

# Environment Variables

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|       `TZ`       |    Timezone    |        `UTC`         | microservices   |
|       `NODE_ENV`       |    Node Environment    |        `production`         | server, microservices   |

> `TZ` is only used by the `exiftool` in the microservices container.
> It is considered as a fallback timezone if the timezone cannot be determined from the image metadata.

## Redis

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `REDIS_URL`    |   Redis URL    | `` | server, microservices   |
|   `REDIS_HOST`   |   Redis Host   |    `immich_redis`    | server, microservices   |
|   `REDIS_PORT`   |   Redis Port   |        `6379`        | server, microservices   |
|  `REDIS_INDEX`   |  Redis Index   |         `0`          | server, microservices   |
| `REDIS_USERNAME` | Redis Username |        ``        | server, microservices   |
| `REDIS_PASSWORD` | Redis Password |        ``        | server, microservices   |
| `REDIS_SOCKET`   | Redis Socket   |        ``        | server, microservices   |

`REDIS_SOCKET`

## Typesense

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `TYPESENSE_URL`    |   Typesense URL    | `` | server, microservices   |
|   `TYPESENSE_API_KEY`    |   Typesense API Key    | `` | server, microservices   |
|   `TYPESENSE_HOST`    |   Typesense Host    | `typesense` | server, microservices   |
|   `TYPESENSE_PORT`    |   Typesense Port    | `8108` | server, microservices   |
|   `TYPESENSE_PROTOCOL`    |   Typesense Protocol    | `http` | server, microservices   |

# Environment Variables

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|       `TZ`       |    Timezone    |        `UTC`         | microservices   |
|       `NODE_ENV`       |    Node Environment    |        `production`         | server, microservices   |

> `TZ` is only used by the `exiftool` in the microservices container.
> It is considered as a fallback timezone if the timezone cannot be determined from the image metadata.

## Redis

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `REDIS_URL`    |   Redis URL    | `` | server, microservices   |
|   `REDIS_HOST`   |   Redis Host   |    `immich_redis`    | server, microservices   |
|   `REDIS_PORT`   |   Redis Port   |        `6379`        | server, microservices   |
|  `REDIS_INDEX`   |  Redis Index   |         `0`          | server, microservices   |
| `REDIS_USERNAME` | Redis Username |        ``        | server, microservices   |
| `REDIS_PASSWORD` | Redis Password |        ``        | server, microservices   |
| `REDIS_SOCKET`   | Redis Socket   |        ``        | server, microservices   |

`REDIS_SOCKET`

## Typesense

|    Variable    |  Description   |      Default       | Services |
| :------------: | :------------: | :----------------: | :------- |
|   `TYPESENSE_URL`    |   Typesense URL    | `` | server, microservices   |
|   `TYPESENSE_API_KEY`    |   Typesense API Key    | `` | server, microservices   |
|   `TYPESENSE_HOST`    |   Typesense Host    | `typesense` | server, microservices   |
|   `TYPESENSE_PORT`    |   Typesense Port    | `8108` | server, microservices   |
|   `TYPESENSE_PROTOCOL`    |   Typesense Protocol    | `http` | server, microservices   |

J

jrasm91•6/16/23, 5:02 PM

TZ does not default to UTC by default

S

stavros-kOP•6/16/23, 5:03 PM

Or we can remove the description from the table
And have after each section (

##

##

##

##), subsections (

###

###

###

###) for each env with a longer description

S

stavros-kOP•6/16/23, 5:03 PM

And instaeld of description on the table we have a

Required

Required

Required

Required column with yes/no value

J

jrasm91•6/16/23, 5:08 PM

I think different sections is good for groups of stuff, but tables for the actual envs like you have them for redis, typesense, etc. is good.

S

stavros-kOP•6/16/23, 5:38 PM

Is mapbox removed? I can only find refs in a

.env.test

.env.test

.env.test

.env.test file

B

bo0tzz•6/16/23, 5:39 PM

Indeed

S

stavros-kOP•6/16/23, 5:40 PM

Cool, I'll clean it up too

B

bo0tzz•6/16/23, 5:47 PM

Awesome stuff!

S

stavros-kOP•6/16/23, 5:49 PM

Is the

JWT_SECRET

JWT_SECRET

removed?

B

bo0tzz•6/16/23, 5:50 PM

A few notes from my first look through:

REVERSE_GEOCODING_DUMP_DIRECTORY

REVERSE_GEOCODING_DUMP_DIRECTORY

REVERSE_GEOCODING_DUMP_DIRECTORY

REVERSE_GEOCODING_DUMP_DIRECTORY can be moved to Paths, and that section might want a general note that these are all paths internal to the container?
If

DB_URL

DB_URL

DB_URL

DB_URL is set, none of the other

DB_*

DB_*

DB_*

DB_* vars are used. I'm not sure whether this also applies to the redis or typesense settings (can't check rn).

J

jrasm91•6/16/23, 6:07 PM

JWT secret is not used anymore.

J

jrasm91•6/16/23, 6:08 PM

Yes - if redis url is provided the rest of them are ignore. If typesense url is provided the rest of the are ignored.

S

stavros-kOP•6/16/23, 6:08 PM

Yep pushed some updates regarding those!
Do you know what happens with redis_socket?

Which environment variables are used by each container?

Similar Threads

Similar Threads

Similar Threads