Skip to content

Updating configuration.md descriptions in json #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LingTheBug wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Updating configuration.md descriptions in json #418

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97d5aab
Update configuration.md
LingTheBug Jun 27, 2025
783f790
Update configuration.md
LingTheBug Jun 27, 2025
ca27355
Remove unused config options from example json
LingTheBug Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/docs/getting-started/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,29 @@ sidebar_position: 2
### Full configuration reference:

:::warning
It is not recommended to copy this full configuration file. Only specify values that are different from the defaults. Configuration options and default values may change in future versions.
It is not recommended to copy this full configuration file. Only specify values that are different from the defaults. Configuration options and default values may change in future versions.
Make sure to remove any comments, inlcuding comments after the data, as JSON does not natively support them. Failure to do so will result in errors.
:::

Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are required.

```json
{
// settings applicable to the web client - when viewing with a browser or webview
// Settings applicable to the web client - when viewing with a browser or webview
"General": {
//When set, every client needs to authenticate via Bearer Token and this value.
// When set, every client needs to authenticate via Bearer Token and this value.
"AuthenticationSecret": null, // string, no default
// whether to download images to the server
// Whether to download images to the server
"DownloadImages": false, // boolean
// if images are downloaded, re-download if age (in days) is more than this
// If images are downloaded, re-download if age (in days) is more than this
"RenewImagesDuration": 30, // int
// A list of webcalendar URIs in the .ics format. e.g. https://calendar.google.com/calendar/ical/XXXXXX/public/basic.ics
"Webcalendars": [], // string[]
// Interval in hours. Determines how often images are pulled from a person in immich.
"RefreshAlbumPeopleInterval": 12, //int
// Date format. See https://date-fns.org/v4.1.0/docs/format for more information.
"PhotoDateFormat": "MM/dd/yyyy", // string
// Location format. Determines the way a location will be displayed.
"ImageLocationFormat": "City,State,Country",
// Get an API key from OpenWeatherMap: https://openweathermap.org/appid
"WeatherApiKey": "", // string
Expand All @@ -39,8 +41,6 @@ Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are req
"Language": "en", // string
//Webhook URL to be notified e.g. http://example.com/notify
"Webhook": null, // string
// whether to download images to the server
"Margin": "0,0,0,0",
// Image interval in seconds. How long a image is displayed in the frame.
"Interval": 45,
// Duration in seconds.
Expand Down Expand Up @@ -71,7 +71,6 @@ Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are req
"BaseFontSize": "17px", //string
// Displays the description of the current weather.
"ShowWeatherDescription": true, // boolean
"UnattendedMode": true, // boolean
// Zooms into or out of an image and gives it a touch of life.
"ImageZoom": true, // boolean
// Pans an image in a random direction and gives it a touch of life.
Expand Down Expand Up @@ -159,4 +158,4 @@ ImmichFrame can be customized even further using CSS. This will apply to browser
```
volumes:
- /PATH/TO/YOUR/custom.css:/app/wwwroot/static/custom.css"
```
```