From 97d5aab085c9af01c96de94964dcb434ee5fc790 Mon Sep 17 00:00:00 2001 From: Dante F Date: Fri, 27 Jun 2025 08:46:45 -0400 Subject: [PATCH 1/3] Update configuration.md --- docs/docs/getting-started/configuration.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.md index e6e5c918..7d094c10 100644 --- a/docs/docs/getting-started/configuration.md +++ b/docs/docs/getting-started/configuration.md @@ -7,7 +7,8 @@ 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. @@ -159,4 +160,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" -``` \ No newline at end of file +``` From 783f7901d65382541da656b3441c18116cc094bb Mon Sep 17 00:00:00 2001 From: Dante F Date: Fri, 27 Jun 2025 08:49:13 -0400 Subject: [PATCH 2/3] Update configuration.md Fixed some description comments in the JSON --- docs/docs/getting-started/configuration.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.md index 7d094c10..a407c1c5 100644 --- a/docs/docs/getting-started/configuration.md +++ b/docs/docs/getting-started/configuration.md @@ -15,13 +15,13 @@ Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are req ```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[] @@ -29,6 +29,7 @@ Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are req "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 From ca27355425ce8d574c5810c8580e598bb1e04b8e Mon Sep 17 00:00:00 2001 From: Dante F Date: Fri, 27 Jun 2025 11:27:05 -0400 Subject: [PATCH 3/3] Remove unused config options from example json Remove ``Margin`` and ``UnattendedMode`` unused options from the example json --- docs/docs/getting-started/configuration.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.md index a407c1c5..b2b4bcb5 100644 --- a/docs/docs/getting-started/configuration.md +++ b/docs/docs/getting-started/configuration.md @@ -41,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. @@ -73,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.