mirror of
https://github.com/immich-app/immich.git
synced 2025-01-28 06:32:44 +01:00
docs: clean-up old references (#5697)
* docs: clean-up old references * chore: fix ref
This commit is contained in:
parent
3a2e9b6298
commit
9bb6befc92
7 changed files with 94 additions and 89 deletions
|
@ -42,6 +42,7 @@ Usage: immich [options] [command]
|
||||||
Immich command line interface
|
Immich command line interface
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
-V, --version output the version number
|
||||||
-h, --help display help for command
|
-h, --help display help for command
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
|
|
|
@ -2,6 +2,9 @@
|
||||||
sidebar_position: 30
|
sidebar_position: 30
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import CodeBlock from '@theme/CodeBlock';
|
||||||
|
import ExampleEnv from '!!raw-loader!../../../docker/example.env';
|
||||||
|
|
||||||
# Docker Compose [Recommended]
|
# Docker Compose [Recommended]
|
||||||
|
|
||||||
Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose.
|
Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose.
|
||||||
|
@ -40,89 +43,10 @@ Optionally, you can use the [`hwaccel.yml`][hw-file] file to enable hardware acc
|
||||||
### Step 2 - Populate the .env file with custom values
|
### Step 2 - Populate the .env file with custom values
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
<summary>
|
||||||
<summary>Example <code>.env</code> content</summary>
|
Example <code>.env</code> content
|
||||||
|
</summary>
|
||||||
```bash
|
<CodeBlock language="bash">{ExampleEnv}</CodeBlock>
|
||||||
###################################################################################
|
|
||||||
# Database
|
|
||||||
###################################################################################
|
|
||||||
|
|
||||||
DB_HOSTNAME=immich_postgres
|
|
||||||
DB_USERNAME=postgres
|
|
||||||
DB_PASSWORD=postgres
|
|
||||||
DB_DATABASE_NAME=immich
|
|
||||||
|
|
||||||
# Optional Database settings:
|
|
||||||
# DB_PORT=5432
|
|
||||||
|
|
||||||
###################################################################################
|
|
||||||
# Redis
|
|
||||||
###################################################################################
|
|
||||||
|
|
||||||
REDIS_HOSTNAME=immich_redis
|
|
||||||
|
|
||||||
# Optional Redis settings:
|
|
||||||
|
|
||||||
# Note: these parameters are not automatically passed to the Redis Container
|
|
||||||
# to do so, please edit the docker-compose.yml file as well. Redis is not configured
|
|
||||||
# via environment variables, only redis.conf or the command line
|
|
||||||
|
|
||||||
# REDIS_PORT=6379
|
|
||||||
# REDIS_DBINDEX=0
|
|
||||||
# REDIS_PASSWORD=
|
|
||||||
# REDIS_SOCKET=
|
|
||||||
|
|
||||||
###################################################################################
|
|
||||||
# Upload File Location
|
|
||||||
#
|
|
||||||
# This is the location where uploaded files are stored.
|
|
||||||
###################################################################################
|
|
||||||
|
|
||||||
UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup
|
|
||||||
|
|
||||||
|
|
||||||
###################################################################################
|
|
||||||
# Log message level - [simple|verbose]
|
|
||||||
###################################################################################
|
|
||||||
|
|
||||||
LOG_LEVEL=simple
|
|
||||||
|
|
||||||
###################################################################################
|
|
||||||
# Reverse Geocoding
|
|
||||||
#
|
|
||||||
# Reverse geocoding is done locally which has a small impact on memory usage
|
|
||||||
# This memory usage can be altered by changing the REVERSE_GEOCODING_PRECISION variable
|
|
||||||
# This ranges from 0-3 with 3 being the most precise
|
|
||||||
# 3 - Cities > 500 population: ~200MB RAM
|
|
||||||
# 2 - Cities > 1000 population: ~150MB RAM
|
|
||||||
# 1 - Cities > 5000 population: ~80MB RAM
|
|
||||||
# 0 - Cities > 15000 population: ~40MB RAM
|
|
||||||
####################################################################################
|
|
||||||
|
|
||||||
# DISABLE_REVERSE_GEOCODING=false
|
|
||||||
# REVERSE_GEOCODING_PRECISION=3
|
|
||||||
|
|
||||||
####################################################################################
|
|
||||||
# WEB - Optional
|
|
||||||
#
|
|
||||||
# Custom message on the login page, should be written in HTML form.
|
|
||||||
# For example:
|
|
||||||
# PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
|
|
||||||
####################################################################################
|
|
||||||
|
|
||||||
PUBLIC_LOGIN_PAGE_MESSAGE="My Family Photos and Videos Backup Server"
|
|
||||||
|
|
||||||
###################################################################################
|
|
||||||
# Immich Version - Optional
|
|
||||||
#
|
|
||||||
# This allows all immich docker images to be pinned to a specific version. By default,
|
|
||||||
# the version is "release" but could be a specific version, like "v1.59.0".
|
|
||||||
###################################################################################
|
|
||||||
|
|
||||||
#IMMICH_VERSION=
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
- Populate custom database information if necessary.
|
- Populate custom database information if necessary.
|
|
@ -18,7 +18,4 @@ search home.lan
|
||||||
nameserver 192.168.1.1
|
nameserver 192.168.1.1
|
||||||
```
|
```
|
||||||
|
|
||||||
When you encounter this bug, it will cause the immich-microservices to crash on startup because it cannot download
|
|
||||||
the geocoder data. This can be solved in one of two ways: Either reconfigure your nodes to remove the searchdomain from
|
|
||||||
`resolv.conf`, or set the `DISABLE_REVERSE_GEOCODING` environment variable for Immich to `true` to disable the geocoder.
|
|
||||||
:::
|
:::
|
||||||
|
|
|
@ -5,7 +5,7 @@ sidebar_position: 20
|
||||||
# Install Script [Experimental]
|
# Install Script [Experimental]
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
This method is experimental and not currently recommended for production use. For production, please refer to installing with [Docker Compose](/docs/install/docker-compose.md).
|
This method is experimental and not currently recommended for production use. For production, please refer to installing with [Docker Compose](/docs/install/docker-compose.mdx).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
In the shell, from a directory of your choice, run the following command:
|
In the shell, from a directory of your choice, run the following command:
|
||||||
|
|
84
docs/package-lock.json
generated
84
docs/package-lock.json
generated
|
@ -20,6 +20,7 @@
|
||||||
"docusaurus-preset-openapi": "^0.6.3",
|
"docusaurus-preset-openapi": "^0.6.3",
|
||||||
"postcss": "^8.4.25",
|
"postcss": "^8.4.25",
|
||||||
"prism-react-renderer": "^1.3.5",
|
"prism-react-renderer": "^1.3.5",
|
||||||
|
"raw-loader": "^4.0.2",
|
||||||
"react": "^17.0.2",
|
"react": "^17.0.2",
|
||||||
"react-dom": "^17.0.2",
|
"react-dom": "^17.0.2",
|
||||||
"tailwindcss": "^3.2.4",
|
"tailwindcss": "^3.2.4",
|
||||||
|
@ -11094,6 +11095,57 @@
|
||||||
"node": ">=0.10.0"
|
"node": ">=0.10.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/raw-loader": {
|
||||||
|
"version": "4.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-4.0.2.tgz",
|
||||||
|
"integrity": "sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==",
|
||||||
|
"dependencies": {
|
||||||
|
"loader-utils": "^2.0.0",
|
||||||
|
"schema-utils": "^3.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 10.13.0"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"type": "opencollective",
|
||||||
|
"url": "https://opencollective.com/webpack"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"webpack": "^4.0.0 || ^5.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/raw-loader/node_modules/ajv": {
|
||||||
|
"version": "6.12.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
|
"dependencies": {
|
||||||
|
"fast-deep-equal": "^3.1.1",
|
||||||
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
|
"json-schema-traverse": "^0.4.1",
|
||||||
|
"uri-js": "^4.2.2"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"type": "github",
|
||||||
|
"url": "https://github.com/sponsors/epoberezkin"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/raw-loader/node_modules/schema-utils": {
|
||||||
|
"version": "3.3.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz",
|
||||||
|
"integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==",
|
||||||
|
"dependencies": {
|
||||||
|
"@types/json-schema": "^7.0.8",
|
||||||
|
"ajv": "^6.12.5",
|
||||||
|
"ajv-keywords": "^3.5.2"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 10.13.0"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"type": "opencollective",
|
||||||
|
"url": "https://opencollective.com/webpack"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/rc": {
|
"node_modules/rc": {
|
||||||
"version": "1.2.8",
|
"version": "1.2.8",
|
||||||
"resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
|
"resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
|
||||||
|
@ -22929,6 +22981,38 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"raw-loader": {
|
||||||
|
"version": "4.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-4.0.2.tgz",
|
||||||
|
"integrity": "sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==",
|
||||||
|
"requires": {
|
||||||
|
"loader-utils": "^2.0.0",
|
||||||
|
"schema-utils": "^3.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"ajv": {
|
||||||
|
"version": "6.12.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
|
"requires": {
|
||||||
|
"fast-deep-equal": "^3.1.1",
|
||||||
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
|
"json-schema-traverse": "^0.4.1",
|
||||||
|
"uri-js": "^4.2.2"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"schema-utils": {
|
||||||
|
"version": "3.3.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz",
|
||||||
|
"integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==",
|
||||||
|
"requires": {
|
||||||
|
"@types/json-schema": "^7.0.8",
|
||||||
|
"ajv": "^6.12.5",
|
||||||
|
"ajv-keywords": "^3.5.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"rc": {
|
"rc": {
|
||||||
"version": "1.2.8",
|
"version": "1.2.8",
|
||||||
"resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
|
"resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
|
||||||
|
|
|
@ -29,6 +29,7 @@
|
||||||
"docusaurus-preset-openapi": "^0.6.3",
|
"docusaurus-preset-openapi": "^0.6.3",
|
||||||
"postcss": "^8.4.25",
|
"postcss": "^8.4.25",
|
||||||
"prism-react-renderer": "^1.3.5",
|
"prism-react-renderer": "^1.3.5",
|
||||||
|
"raw-loader": "^4.0.2",
|
||||||
"react": "^17.0.2",
|
"react": "^17.0.2",
|
||||||
"react-dom": "^17.0.2",
|
"react-dom": "^17.0.2",
|
||||||
"tailwindcss": "^3.2.4",
|
"tailwindcss": "^3.2.4",
|
||||||
|
|
|
@ -18,8 +18,6 @@ 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(),
|
||||||
DISABLE_REVERSE_GEOCODING: Joi.boolean().optional().valid(true, false).default(false),
|
|
||||||
REVERSE_GEOCODING_PRECISION: Joi.number().optional().valid(0, 1, 2, 3).default(3),
|
|
||||||
LOG_LEVEL: Joi.string().optional().valid('simple', 'verbose', 'debug', 'log', 'warn', 'error').default('log'),
|
LOG_LEVEL: Joi.string().optional().valid('simple', 'verbose', 'debug', 'log', 'warn', 'error').default('log'),
|
||||||
MACHINE_LEARNING_PORT: Joi.number().optional(),
|
MACHINE_LEARNING_PORT: Joi.number().optional(),
|
||||||
MICROSERVICES_PORT: Joi.number().optional(),
|
MICROSERVICES_PORT: Joi.number().optional(),
|
||||||
|
|
Loading…
Reference in a new issue