From 984e11c85a256227e96dd71cc0add58dd574eca8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kr=C3=BChlmann?= Date: Mon, 5 Jan 2026 14:04:43 +0100 Subject: [PATCH] Add missing env description to readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 301d820..f239d18 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A Spring Boot overlay server for Twitch broadcasters and their channel admins. B ## Running -Define the following environment variables: +Define the following required environment variables: | Variable | Description | Example Value | |----------|-------------|---------------| @@ -14,3 +14,11 @@ Define the following environment variables: | 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 | +| TWITCH_CLIENT_ID | Oauth2 client id | i1bjnh4whieht5kzn307nvu3rn5pqi | +| TWITCH_CLIENT_SECRET Oauth2 client secret | vpkn8cp7ona65l121j6q78l9gkmed3 | + +Optional: + +| Variable | Description | Example Value | +|----------|-------------|---------------| +| TWITCH_REDIRECT_URI | Override default redirect URI | http://localhost:8080/login/oauth2/code/twitch |