Matt Walsh
1c79b08228
correct environment variable escaping in readme
2025-11-10 04:33:42 +00:00
bparkin1283
20cab8c25e
Update README.md clarifying displays if you're within one of the highlight areas
2025-10-09 10:55:33 -05:00
Matt Walsh
0fd90feb7a
update community notes
2025-10-02 21:37:36 -05:00
Matt Walsh
bfc4bddfef
Add quick start to readme
2025-09-09 20:54:13 -05:00
Matt Walsh
12d068d740
playlist info in readme close #138
2025-09-04 21:26:01 -05:00
Matt Walsh
3eb571bed4
update community notes in readme close #135
2025-08-23 16:28:02 -05:00
Matt Walsh
c8a25e5d9a
Integrate no-data icon close #94 #128
2025-08-10 20:05:07 -05:00
Eddy G
a3c581aa93
Clarify instructions for iOS/iPadOS and Android
2025-07-07 12:43:32 -04:00
Eddy G
10baefc901
Merge remote-tracking branch 'upstream/main' into modernization-and-refactor
2025-07-02 09:08:07 -04:00
Eddy G
46edf1f7e2
Add "Settings" section to README
2025-07-02 08:44:12 -04:00
Matt Walsh
0a65221905
update readme for custom rss close #57
2025-06-30 23:29:39 -05:00
Eddy G
17585e97c4
Update README to clarify deployment modes and music handling
...
- Add clear distinction between Server and Static deployment modes
- Restructure run instructions with specific npm commands and their purposes
- Clarify Docker deployment scenarios (static vs server, with examples)
- Rewrite music section to explain server-side vs browser-side playlist generation
2025-06-26 20:39:18 -04:00
Eddy G
7f7cb96231
Add STATIC environment variable for browser-only deployment mode
...
Implement STATIC=1 environment variable to enable browser-only deployment
without proxy server infrastructure. Uses WS4KP_SERVER_AVAILABLE flag to
distinguish between server-backed and static deployments for proper URL
rewriting and User-Agent header handling.
- Add STATIC env var to skip proxy route registration at startup
- Inject WS4KP_SERVER_AVAILABLE flag via EJS template based on STATIC mode
- Update fetch.mjs to conditionally send User-Agent headers based on server availability
- Update url-rewrite.mjs to skip proxy rewriting when server is unavailable
- Use renderIndex helper for consistent template data across dev/prod modes
- Improve music playlist logging
Benefits of integrated approach:
- Single environment variable controls both server and client behavior
- Flag injection happens once at render time, not on every request
- No runtime HTML string manipulation overhead
- Clean separation between server-backed and static deployment logic
- Same codebase supports both deployment modes without duplication
Static mode (STATIC=1): Direct API calls to external services, no caching
Server mode (default): Local proxy with caching and API request observability
2025-06-26 20:10:11 -04:00
Mitchell Scott
51bb9696b0
add x-weatherstar header for specific 404 detection
2025-06-13 22:14:14 -06:00
Mitchell Scott
6ff7122844
env workaround for static build
2025-06-13 14:51:06 -06:00
Mitchell Scott
3236b2ecc3
radar fix for static deployment, slight spelling and grammer fixes in readme
2025-06-13 09:04:39 -06:00
Mitchell Scott
2827913d42
add client-side generation for playlist.json for static builds
2025-06-13 08:37:01 -06:00
Matt Walsh
9a55a6ec39
fix setting boolean-style query string parsing close #106
2025-06-06 16:40:08 -05:00
Matt Walsh
e01edc6972
Merge gordonthree-main to main
2025-06-03 13:38:27 -05:00
gordonthree
ab0249e6eb
forgot to replace hypen with underscore
2025-06-03 12:46:52 -04:00
gordonthree
c4c85b3b7b
shortened example content, revised comments to align with existing permalink example
2025-06-03 12:01:59 -04:00
Matt Walsh
e954033979
reorganize and update readme
2025-06-03 09:39:57 -05:00
gordonthree
ba39af9126
added ports info to the compose example
2025-06-03 09:42:51 -04:00
gordonthree
a814fde5b5
Added docker-compose example
2025-06-03 09:35:38 -04:00
Matt Walsh
18efd810bd
permalink coloring, readme additions close #88
2025-05-31 13:20:35 -05:00
Dylan Park
e9d603fbfc
update local run instructions in README
2025-05-29 14:24:05 -05:00
Matt Walsh
0ee7fdc9f8
Update README.md with ws3kp link
2025-05-20 18:02:25 -05:00
Matt Walsh
317883fc04
Add version number to bottom of page
2025-05-16 09:21:04 -05:00
Matt Walsh
72938671ac
spelling cleanup
2025-05-14 08:42:37 -05:00
Matt Walsh
e952d860dc
add environment variables for default configuration
2025-05-13 23:04:46 -05:00
Matt Walsh
91f669e828
add streaming to readme
2025-05-02 10:52:32 -05:00
thatguychuck
b40fe08465
Music player dockerfile and readme. ( #71 )
...
* Update Dockerfile, swapped index.js for index.mjs
* Update README.md with docker music instructions.
2025-03-27 10:22:52 -05:00
Matt Walsh
64215a117c
auto play music
2025-03-24 21:49:41 -05:00
Matt Walsh
e9164d8c36
Updates for default folder
2025-03-24 18:24:49 -05:00
mwood77
781128100e
Update README to include ws4kp-international ( #66 )
...
* Update README to include `ws4kp-international`
* adjust grammar in readme
* tidy links
2025-02-24 14:16:30 -06:00
Matt Walsh
af53cca45e
add si units close #52
2025-02-23 23:35:00 -06:00
Matt Walsh
9df6f6888f
Fix copy permalink when on non-secure source close #47
2024-07-07 20:15:29 -05:00
Matt Walsh
543d3f5196
Document custom.js close #43 close #44
2024-05-19 23:03:57 -05:00
Matt Walsh
9f9dafa30c
add community notes close #37
2024-04-19 21:23:54 -05:00
Matt Walsh
240cc416b2
complete kiosk mode and permalink close #33
2024-04-12 16:16:01 -05:00
Mitchell Scott
2d0af7a143
Swap to netbymatt GHCR
2023-04-13 16:35:54 -06:00
Matt Walsh
e13582b760
readme cleanup
2022-12-07 15:38:34 -06:00
Matt Walsh
6e2abf6720
index module
2022-11-22 10:45:17 -06:00
Matt Walsh
5429f835de
center fullscreen
2022-11-21 16:27:59 -06:00
Matt Walsh
47c7474dda
fix run example in readme
2022-11-14 14:09:59 -06:00
Matt Walsh
52efea0b67
run example in readme close #12
2022-09-05 19:54:35 -05:00
Matt Walsh
c3f62020a6
update dependencies
2020-11-01 22:13:41 -06:00
Matt Walsh
e031830654
update readme
2020-10-20 20:08:34 -05:00
Matt Walsh
e9b0e3bfcf
Update README.md
2020-09-23 10:25:10 -05:00
Matt Walsh
1f688318b5
update readme wish lists
2020-09-09 10:35:23 -05:00
