c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-01 08:31:59 +00:00
Code Releases Activity

fix(docs): document vector extension env variable (#7220)

Browse source
This commit is contained in:
Mert 2024-02-19 21:32:55 -05:00 committed by GitHub
parent 14ca471dea
commit 6690e8edf2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/docs/install/environment-variables.md
View file

@ -61,13 +61,16 @@ These environment variables are used by the `docker-compose.yml` file and do **N
## Database ## Database
| Variable | Description | Default | Services | | Variable | Description | Default | Services |
| :------------ | :---------------- | :---------: | :-------------------- | | :---------------------------------- | :------------------------------------------------------------ | :----------: | :-------------------- |
| `DB_URL` | Database URL | | server, microservices | | `DB_URL` | Database URL | | server, microservices |
| `DB_HOSTNAME` | Database Host | `localhost` | server, microservices | | `DB_HOSTNAME` | Database Host | `localhost` | server, microservices |
| `DB_PORT` | Database Port | `5432` | server, microservices | | `DB_PORT` | Database Port | `5432` | server, microservices |
| `DB_USERNAME` | Database User | `postgres` | server, microservices | | `DB_USERNAME` | Database User | `postgres` | server, microservices |
| `DB_PASSWORD` | Database Password | `postgres` | server, microservices | | `DB_PASSWORD` | Database Password | `postgres` | server, microservices |
| `DB_DATABASE` | Database Name | `immich` | 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 :::info

2
server/src/domain/database/database.service.ts
View file

@ -72,7 +72,7 @@ export class DatabaseService {
In this case, please run 'CREATE EXTENSION IF NOT EXISTS ${this.vectorExt}' manually as a superuser. In this case, please run 'CREATE EXTENSION IF NOT EXISTS ${this.vectorExt}' manually as a superuser.
See https://immich.app/docs/guides/database-queries for how to query the database. See https://immich.app/docs/guides/database-queries for how to query the database.
Alternatively, if your Postgres instance has ${extName[otherExt]}, you may use this instead by setting the environment variable 'VECTOR_EXTENSION=${otherExt}'. Alternatively, if your Postgres instance has ${extName[otherExt]}, you may use this instead by setting the environment variable 'DB_VECTOR_EXTENSION=${otherExt}'.
Note that switching between the two extensions after a successful startup is not supported. Note that switching between the two extensions after a successful startup is not supported.
The exception is if your version of Immich prior to upgrading was 1.90.2 or earlier. The exception is if your version of Immich prior to upgrading was 1.90.2 or earlier.
In this case, you may set either extension now, but you will not be able to switch to the other extension following a successful startup. In this case, you may set either extension now, but you will not be able to switch to the other extension following a successful startup.

2
server/src/domain/domain.config.ts
View file

@ -18,12 +18,12 @@ export const immichAppConfig: ConfigModuleOptions = {
DB_PASSWORD: WHEN_DB_URL_SET, DB_PASSWORD: WHEN_DB_URL_SET,
DB_DATABASE_NAME: WHEN_DB_URL_SET, DB_DATABASE_NAME: WHEN_DB_URL_SET,
DB_URL: Joi.string().optional(), DB_URL: Joi.string().optional(),
DB_VECTOR_EXTENSION: Joi.string().optional().valid('pgvector', 'pgvecto.rs').default('pgvecto.rs'),
LOG_LEVEL: Joi.string() LOG_LEVEL: Joi.string()
.optional() .optional()
.valid(...Object.values(LogLevel)), .valid(...Object.values(LogLevel)),
MACHINE_LEARNING_PORT: Joi.number().optional(), MACHINE_LEARNING_PORT: Joi.number().optional(),
MICROSERVICES_PORT: Joi.number().optional(), MICROSERVICES_PORT: Joi.number().optional(),
SERVER_PORT: Joi.number().optional(), SERVER_PORT: Joi.number().optional(),
VECTOR_EXTENSION: Joi.string().optional().valid('pgvector', 'pgvecto.rs').default('pgvecto.rs'),
}), }),
}; };

2
server/src/infra/database.config.ts
View file

@ -30,4 +30,4 @@ export const databaseConfig: PostgresConnectionOptions = {
export const dataSource = new DataSource(databaseConfig); export const dataSource = new DataSource(databaseConfig);
export const vectorExt = export const vectorExt =
process.env.VECTOR_EXTENSION === 'pgvector' ? DatabaseExtension.VECTOR : DatabaseExtension.VECTORS; process.env.DB_VECTOR_EXTENSION === 'pgvector' ? DatabaseExtension.VECTOR : DatabaseExtension.VECTORS;