From 547e25b4b5e7059b3f0e03dd04bad2b4fb91f58c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kr=C3=BChlmann?= Date: Mon, 5 Jan 2026 13:23:26 +0100 Subject: [PATCH] Add runtime requirements to readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 77f6a49..301d820 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # Imgfloat A Spring Boot overlay server for Twitch broadcasters and their channel admins. Broadcasters can authorize via Twitch OAuth and invite channel admins to manage images that float over a transparent canvas. Updates are pushed in real time over WebSockets so OBS browser sources stay in sync. + +## Running + +Define the following environment variables: + +| Variable | Description | Example Value | +|----------|-------------|---------------| +| IMGFLOAT_ASSETS_PATH | Filesystem path to store uploaded images | /var/imgfloat/assets | +| IMGFLOAT_PREVIEWS_PATH | Filesystem path to store generated image previews | /var/imgfloat/previews | +| IMGFLOAT_DB_PATH | Filesystem path to the SQLite database file | /var/imgfloat/imgfloat.db | +| IMGFLOAT_INITIAL_TWITCH_USERNAME_SYSADMIN | Twitch username of the initial sysadmin user | example_broadcaster | +| SPRING_SERVLET_MULTIPART_MAX_FILE_SIZE | Maximum upload file size | 10MB | +| SPRING_SERVLET_MULTIPART_MAX_REQUEST_SIZE | Maximum upload request size | 10MB |