damongolding / immich-kiosk

Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source.
GNU Affero General Public License v3.0
477 stars 18 forks source link

Some parameters are ignored from the docker compose #155

Open johndoe0815 opened 4 days ago

johndoe0815 commented 4 days ago

Describe the bug When calling immich kiosk only by IP and port, without any parameters in the URL, some parameters are been taken from the docker-compose file, but others aren't

To Reproduce Steps to reproduce the behavior: Change KIOSK_REFRESH parameter in the docker-compose file. Refesh time is reflected accordingly in the browser. Change KIOSK_TRANSITION or KIOSK_IMAGE_EFFECT in the docker compose file. Effect is not shown in the browser slideshow, unless explicitely defined in the URL.

Expected behavior URL parameters should overwrite the docker compose default values. If nothing is specified in the URL, standard values should be taken, for ALL parameters.

Your Kiosk version 0.12.0

Your Kiosk installation

Your Kiosk ENV or config file services: immich-kiosk: image: damongolding/immich-kiosk:latest container_name: immich-kiosk environment: TZ: "Europe/London"

Required settings

  KIOSK_IMMICH_API_KEY: "abc12345"
  KIOSK_IMMICH_URL: "http://192.168.178.99:2283/"
  # Clock
  KIOSK_SHOW_TIME: FALSE
  KIOSK_TIME_FORMAT: 24
  KIOSK_SHOW_DATE: FALSE
  KIOSK_DATE_FORMAT: DD.MM.YYYY
  # Kiosk behaviour
  KIOSK_REFRESH: 30
  KIOSK_DISABLE_SCREENSAVER: FALSE
  # Asset sources
  KIOSK_SHOW_ARCHIVED: FALSE
  KIOSK_ALBUM: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
  KIOSK_PERSON: "PERSON_ID,PERSON_ID,PERSON_ID"
  # UI
  KIOSK_DISABLE_UI: FALSE
  KIOSK_HIDE_CURSOR: FALSE
  KIOSK_FONT_SIZE: 100
  KIOSK_BACKGROUND_BLUR: TRUE
  KIOSK_THEME: FADE
  KIOSK_LAYOUT: SPLITVIEW
  # Sleep mode
  KIOSK_SLEEP_START: 22
  KIOSK_SLEEP_END: 7
  # Transistion options
  KIOSK_TRANSITION: CROSS-FADE
  KIOSK_FADE_TRANSITION_DURATION: 3
  KIOSK_CROSS_FADE_TRANSITION_DURATION: 3
  # Image display settings
  KIOSK_SHOW_PROGRESS: FALSE
  KIOSK_IMAGE_FIT: COVER
  KIOSK_IMAGE_EFFECT: ZOOM
  KIOSK_IMAGE_EFFECT_AMOUNT: 300
  # Image metadata
  KIOSK_SHOW_IMAGE_TIME: FALSE
  KIOSK_IMAGE_TIME_FORMAT: 24
  KIOSK_SHOW_IMAGE_DATE: FALSE
  KIOSK_IMAGE_DATE_FORMAT: YYYY-MM-DD
  KIOSK_SHOW_IMAGE_EXIF: FALSE
  KIOSK_SHOW_IMAGE_LOCATION: FALSE
  KIOSK_HIDE_COUNTRIES: "HIDDEN_COUNTRY,HIDDEN_COUNTRY"
  KIOSK_SHOW_IMAGE_ID: FALSE
  # Kiosk settings
  KIOSK_WATCH_CONFIG: FALSE
  KIOSK_PASSWORD: ""
  KIOSK_CACHE: TRUE
  KIOSK_PREFETCH: TRUE
  KIOSK_ASSET_WEIGHTING: TRUE
  KIOSK_PORT: 3000
ports:
  - 3000:3000
restart: always

Any parms passed to the URL used to access Kiosk

Desktop:

damongolding commented 4 days ago

How are you restarting the container? Try docker compose down then docker compose up -d. Using docker compose restart can retain ENV settings.

johndoe0815 commented 3 days ago

I use a docker LXC in Proxmox, managed with Portainer. So far I just updated the stack in portainer, which is sufficient with all other services I am using. I now even restarted the whole LXC, but that still does not change anything.

damongolding commented 3 days ago

Ok something doesn't sound quite right. I'm on vacation this week so I won't be able to look at this till I'm back I'm afraid.

steveb166 commented 3 days ago

I noticed certain environment variables being ignored when they were written in uppercase i.e. "KIOSK_LAYOUT: SPLITVIEW", but if I changed them to lowercase i.e. "KIOSK_LAYOUT: splitview", they worked. Seems to apply to a variety of the newer features.

damongolding commented 2 days ago

I noticed certain environment variables being ignored when they were written in uppercase i.e. "KIOSK_LAYOUT: SPLITVIEW", but if I changed them to lowercase i.e. "KIOSK_LAYOUT: splitview", they worked. Seems to apply to a variety of the newer features.

If this is the case then that's definitely a bug.

johndoe0815 commented 1 day ago

I now checked that and can confirm what steveb166 said. As soon as I switched to lowercase letters for the env variable values, it immediately was considered as default in the slideshows.

damongolding commented 1 day ago

I've created a branch to patch this issue