From a814fde5b50d1a529c0f6e9a8c5527bf2e8cd29a Mon Sep 17 00:00:00 2001 From: gordonthree Date: Tue, 3 Jun 2025 09:35:38 -0400 Subject: [PATCH 1/4] Added docker-compose example --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 08d2e7d..a048428 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,34 @@ docker run -p 8080:8080 ghcr.io/netbymatt/ws4kp ``` Open your web browser: http://localhost:8080/ +To run via Docker Compose: +``` +--- +services: + ws4kp: + image: ghcr.io/netbymatt/ws4kp + container_name: ws4kp + environment: + - WSQS_hazards_checkbox=true + - WSQS_current_weather_checkbox=true + - WSQS_latest_observations_checkbox=true + - WSQS_hourly_checkbox=false + - WSQS_hourly_graph_checkbox=true + - WSQS_travel_checkbox=true + - WSQS_regional_forecast_checkbox=true + - WSQS_local_forecast_checkbox=true + - WSQS_extended_forecast_checkbox=true + - WSQS_almanac_checkbox=true + - WSQS_spc_outlook_checkbox=true + - WSQS_radar_checkbox=true + - WSQS_settings_kiosk_checkbox=true + - WSQS_settings_units_select=us + - WSQS_latLonQuery="90210 Beverly Hills CA USA" + # There are more possibilities, check the permalink for a complete list + + restart: unless-stopped +``` + ## Updates in 5.0 The change to 5.0 changes from drawing the weather graphics on canvas elements and instead uses HTML and CSS to style all of the weather graphics. A lot of other changes and fixes were implemented at the same time. From ba39af912680d60f399b35a58e34a771e15f9efd Mon Sep 17 00:00:00 2001 From: gordonthree Date: Tue, 3 Jun 2025 09:42:51 -0400 Subject: [PATCH 2/4] added ports info to the compose example --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a048428..0e262a7 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,8 @@ services: - WSQS_settings_units_select=us - WSQS_latLonQuery="90210 Beverly Hills CA USA" # There are more possibilities, check the permalink for a complete list - + ports: + - 8080:8080 # change the first 8080 to meet your local network needs restart: unless-stopped ``` From c4c85b3b7ba2e263f777304379e80696c90a5264 Mon Sep 17 00:00:00 2001 From: gordonthree Date: Tue, 3 Jun 2025 12:01:59 -0400 Subject: [PATCH 3/4] shortened example content, revised comments to align with existing permalink example --- README.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0e262a7..852f7ef 100644 --- a/README.md +++ b/README.md @@ -40,30 +40,20 @@ docker run -p 8080:8080 ghcr.io/netbymatt/ws4kp ``` Open your web browser: http://localhost:8080/ -To run via Docker Compose: +To run via Docker Compose (docker-compose.yaml): ``` --- services: ws4kp: image: ghcr.io/netbymatt/ws4kp container_name: ws4kp - environment: - - WSQS_hazards_checkbox=true - - WSQS_current_weather_checkbox=true - - WSQS_latest_observations_checkbox=true - - WSQS_hourly_checkbox=false - - WSQS_hourly_graph_checkbox=true - - WSQS_travel_checkbox=true - - WSQS_regional_forecast_checkbox=true - - WSQS_local_forecast_checkbox=true - - WSQS_extended_forecast_checkbox=true - - WSQS_almanac_checkbox=true - - WSQS_spc_outlook_checkbox=true - - WSQS_radar_checkbox=true - - WSQS_settings_kiosk_checkbox=true - - WSQS_settings_units_select=us - - WSQS_latLonQuery="90210 Beverly Hills CA USA" - # There are more possibilities, check the permalink for a complete list + environment: + # Each argument in the permalink URL can become an environment variable on the Docker host by adding WSQS_ + # Following the "Sharing a Permalink" example below, here are a few environment variables defined. Visit that section for a + # more complete list of configuration options. + - WSQS_latLonQuery="Orlando International Airport Orlando FL USA" + - WSQS_hazards-checkbox=false + - WSQS_current-weather-checkbox=true ports: - 8080:8080 # change the first 8080 to meet your local network needs restart: unless-stopped From ab0249e6eb1bc1928f33f466a2f09c3b7bc54bfb Mon Sep 17 00:00:00 2001 From: gordonthree Date: Tue, 3 Jun 2025 12:46:52 -0400 Subject: [PATCH 4/4] forgot to replace hypen with underscore --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 852f7ef..7c37a33 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,8 @@ services: # Following the "Sharing a Permalink" example below, here are a few environment variables defined. Visit that section for a # more complete list of configuration options. - WSQS_latLonQuery="Orlando International Airport Orlando FL USA" - - WSQS_hazards-checkbox=false - - WSQS_current-weather-checkbox=true + - WSQS_hazards_checkbox=false + - WSQS_current_weather_checkbox=true ports: - 8080:8080 # change the first 8080 to meet your local network needs restart: unless-stopped