Skip to content

Latest commit

 

History

History
130 lines (111 loc) · 3.08 KB

Install_Web.md

File metadata and controls

130 lines (111 loc) · 3.08 KB
Raw

🔙 Back

Go back to the Full Readme

🌐 ImmichFrame Web

✨ Demo

ImmichFrame Web

🔧 Installation

ImmichFrame Web is installed via Docker 🐋

🐋 Docker Compose

Docker Compose with environment variables

Note

Not every setting is needed. Only configure what you need!

name: immichframe
services:
  immichframe:
    container_name: immichframe
    image: ghcr.io/immichframe/immichframe:latest
    restart: on-failure
    ports:
      - "8080:8080"
    environment:
      TZ: "Europe/Berlin"
      # Required
      ImmichServerUrl: "URL"
      ApiKey: "KEY"
      # Image
      ImageZoom: "true"  
      Interval: "10"
      TransitionDuration: "2"
      # Filters
      Albums: "ALBUM1,ALBUM2"
      ExcludedAlbums: "ALBUM3,ALBUM4"
      People: "PERSON1,PERSON2"
      ShowMemories: "false"
      ImagesFromDays: ""
      ImagesFromDate: ""
      ImagesUntilDate: ""
      # Clock
      ShowClock: "true"
      ClockFormat: "HH:mm"
      # Weather
      WeatherApiKey: "API-KEY"
      UnitSystem: "imperial"
      Language: "en"
      ShowWeatherDescription: "true"
      WeatherLatLong: "40.730610, -73.935242"
      # Metadata
      ShowImageDesc: "true"
      ShowImageLocation: "true"
      ShowPhotoDate: "true"
      PhotoDateFormat: "yyyy-MM-dd"
      # Caching
      RenewImagesDuration: "30"
      DownloadImages: "false"
      RefreshAlbumPeopleInterval: "12"
      # UI
      PrimaryColor: "#FF5733"
      BaseFontSize: "17px"
      # Misc
      ImmichFrameAlbumName: ""

Docker Compose with Settings.json

An example of the Settings.json can be found here.

Important

Change PATH/TO/CONFIG to the correct path!

name: immichframe
services:
  immichframe:
    container_name: immichframe
    image: ghcr.io/immichframe/immichframe:latest
    restart: on-failure
    volumes:
      - PATH/TO/CONFIG:/app/Config
    ports:
      - "8080:8080"
    environment:
      TZ: "Europe/Berlin"

Docker Compose with env file

An example of the .env can be found here.

name: immichframe
services:
  immichframe:
    container_name: immichframe
    image: ghcr.io/immichframe/immichframe:latest
    restart: on-failure
    ports:
      - "8080:8080"
    env_file:
      - .env
    environment:
      TZ: "Europe/Berlin"

⚙️ Configuration

For more information, read here.

🆘 Help

Discord Channel