Skip to content

Commit

Permalink
Merge branch 'task/release' into fix/ios-wakelock
Browse files Browse the repository at this point in the history
  • Loading branch information
damongolding committed Oct 15, 2024
2 parents bf8f0fb + cbefc6d commit 1fb15e8
Show file tree
Hide file tree
Showing 18 changed files with 336 additions and 113 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ WORKDIR /app
COPY . .

RUN go mod download
RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -ldflags "-X main.version=${VERSION}" -o dist/kiosk .
RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -a -installsuffix cgo -ldflags "-X main.version=${VERSION}" -o dist/kiosk .


FROM alpine:latest
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ services:
TZ: "Europe/London"
volumes:
- ./config.yaml:/config.yaml
# OR you can mount a directory with config.yaml inside
- ./config:/config
restart: on-failure
ports:
- 3000:3000
Expand Down Expand Up @@ -179,10 +181,12 @@ services:
KIOSK_SHOW_IMAGE_LOCATION: FALSE
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: on-failure
Expand Down Expand Up @@ -251,6 +255,7 @@ kiosk:
| **yaml** | **ENV** | **Value** | **Default** | **Description** |
|-------------------|-------------------------|--------------|-------------|--------------------------------------------------------------------------------------------|
| port | KIOSK_PORT | int | 3000 | Which port Kiosk should use. NOTE that is port will need to be reflected in your compose file e.g. `KIOSK_PORT:HOST_PORT` |
| watch_config | KIOSK_WATCH_CONFIG | bool | false | Should Kiosk watch config.yaml file for changes. Reloads all connect clients if a change is detected. |
| password | KIOSK_PASSWORD | string | "" | Please see FAQs for more info. If set, requests MUST contain the password in the GET parameters e.g. `http://192.168.0.123:3000?password=PASSWORD`. |
| cache | KIOSK_CACHE | bool | true | Cache selective Immich api calls to reduce unnecessary calls. |
| prefetch | KIOSK_PREFETCH | bool | true | Pre fetch assets in the background so images load much quicker when refresh timer ends. |
Expand Down Expand Up @@ -439,7 +444,9 @@ Display one image.
> Kiosk attempts to determine the orientation of each image. However, if an image lacks EXIF data,
> it may be displayed in an incorrect orientation (e.g., a portrait image shown in landscape format).
When a portrait image is fetched, Kiosk automatically retrieves a second portrait image and displays them side by side vertically. Landscape and square images are displayed individually.
When a portrait image is fetched, Kiosk automatically retrieves a second portrait image\* and displays them side by side vertically. Landscape and square images are displayed individually.
\* If Kiosk is unable to retrieve a second unique image, the first image will be displayed individually.
![Kiosk layout splitview](/assets/layout-splitview.jpg)
Expand Down
2 changes: 2 additions & 0 deletions config.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ show_image_id: false

# options that can NOT be changed via url params
kiosk:
port: 3000
watch_config: false
password: ""
cache: true # cache select api calls
pre_fetch: true # fetch assets in the background
Expand Down
Loading

0 comments on commit 1fb15e8

Please sign in to comment.