Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
damongolding committed Oct 10, 2024
1 parent e7f1890 commit 37dff75
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ services:
KIOSK_IMAGE_DATE_FORMAT: YYYY-MM-DD
KIOSK_SHOW_IMAGE_EXIF: FALSE
KIOSK_SHOW_IMAGE_LOCATION: FALSE
KIOSK_SHOW_IMAGE_ID: FALSE
# Kiosk settings
KIOSK_PASSWORD: ""
KIOSK_CACHE: TRUE
Expand Down Expand Up @@ -226,6 +227,8 @@ See the file config.example.yaml for an example config file
| [image_date_format](#date-format) | KIOSK_IMAGE_DATE_FORMAT | string | DD/MM/YYYY | The format of the image date. default is day/month/year. See [date format](#date-format) for more information. |
| show_image_exif | KIOSK_SHOW_IMAGE_EXIF | bool | false | Display image Fnumber, Shutter speed, focal length, ISO from METADATA (if available). |
| show_image_location | KIOSK_SHOW_IMAGE_LOCATION | bool | false | Display the image location from METADATA (if available). |
| show_image_id | KIOSK_SHOW_IMAGE_ID | bool | false | Display the image Immich ID. |


### Additional options
The below options are NOT configurable through URL params. In the `config.yaml` file they sit under `kiosk` (demo below and in example `config.yaml`)
Expand Down
1 change: 1 addition & 0 deletions config.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ show_image_date: false # true or false
image_date_format: YYYY-MM-DD
show_image_exif: false
show_image_location: false
show_image_id: false

# options that can NOT be changed via url params
kiosk:
Expand Down

0 comments on commit 37dff75

Please sign in to comment.