From b54cd459cc981f64540ee966f6c7c223c345c8f1 Mon Sep 17 00:00:00 2001 From: Patrick762 Date: Sat, 21 Dec 2024 21:19:15 +0100 Subject: [PATCH] added docker image for server --- Dockerfile | 18 ++++++++++++++++++ README.md | 17 +++++++++++++++-- 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..79a7202 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +FROM python:3.9.18-bookworm + +# Get dependencies +RUN apt update +RUN apt install -y libudev-dev libusb-1.0-0-dev libhidapi-libusb0 libjpeg-dev zlib1g-dev libopenjp2-7 libtiff5-dev libgtk-3-dev +RUN apt clean +RUN rm -rf /var/lib/apt/lists/* + +COPY . /streamdeckapi +WORKDIR /streamdeckapi + +# Install the pip package +RUN pip install --no-cache-dir . + +EXPOSE 6153 + +# Run the server +CMD [ "streamdeckapi-server" ] diff --git a/README.md b/README.md index 75d59e2..e42bc02 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,21 @@ Stream Deck API Library for Home Assistant Stream Deck Integration Only compatible with separate [Stream Deck Plugin](https://github.com/Patrick762/streamdeckapi-plugin) or the bundled server. -## Server +## Server inside docker container +The docker image allows you to use the streamdeckapi server inside a docker container. + +### Usage +```shell +docker run -v /dev/hidraw7:/dev/hidraw7 -p 6153:6153 --privileged ghcr.io/patrick762/streamdeckapi +``` + +**Note:** You have to change `hidraw7` to the path of your Stream Deck. You can find this path by using `lshid` (https://pypi.org/project/lshid/). + +## Limitations +- No zeroconf discovery +- No `doubleTap` event + +## Server without docker This library also contains a server to use the streamdeck with Linux or without the official Stream Deck Software. For this to work, the following software is required: @@ -21,7 +35,6 @@ pipwin install cairocffi ``` ### Limitations -- Slow icon updates on Raspberry Pi Zero - No `doubleTap` event ### Installation on Linux / Raspberry Pi