Files
minisrv/README.md
zefie 6e9e84abf0 v0.9.9
- update: config.json: add DoNotEncrypt flags to http and https
- update: app.js: add ability to override service flags when using getServiceString
- update: app.js: add ability to disable 'wtv-star' while keeping 'wtv-*'
- update: app.js: add internal header 'minisrv-use-carriage-return', set to 'false' to disable `\r` in headers
- implement bf0app flashrom functionality
2021-08-02 14:47:11 -04:00

3.9 KiB

wtv minisrv node.js

The wtv minisrv, or "zefie_wtvp_minisrv" project is a node.js project that provides a mini WebTV Server, aiming for full WTVP (WebTV Protocol) support. This open source server is in alpha status. Use at your own risk.

License: GPL v3

Current status:

  • Supports most known WebTV service encryption scenarios, for full trusted box access
  • Can handle client "relogin" and "reconnect" events
  • Suports .js service files with synchronous or asynchronous requests
  • Supports multiple simultaneous users
  • WebTV-compatible HTTP(S) Proxy (via minisrv, or using an external proxy for enhanced features (such as WebOne)
  • Flashrom flashing support for all known units (including bf0app 'Old Classic')
  • Can flash anything on Ultra Willies with optional use_zefie_server flag set on wtv-flashrom service.
  • wtv-update:/sync for Download-o-Rama style file downloading

Current issues:

  • Satellite Receiver units reportedly cannot surf with http or https proxy.
  • Mis-configuring wtv-update:/sync DiskMaps may cause units to delete contents of partitions (need more info)

Won't fix:

  • wtv-encryption stream breaks when two different sessions have the same SSID (eg spoofing, won't fix (production did it too))
  • No intentions to support user accounts, registration, or any form of database system

Feature Todo:

  • wtv-lzpf support
  • TellyScript generation and/or manipulation (needed for Name Server configuration)
  • Flashrom flashing for bf0app old classic Done v0.9.9
  • SSID/IP black/whitelisting (including tying SSID to an IP or multiple IPs) Done v0.9.4
  • Flashrom flashing functionality (at least for LC2 and higher) Done v0.8.0
  • Implement HTTP proxy (needs to be able to defluff most of the web, think retro WAP converter) Done v0.7.1

How To Use:

  • Install node.js. Be sure to say Yes when asked about Chocolatey.
  • Download a snapshot (either of master, or of any commit/branch/relase/tag etc)
  • Extract zip somewhere and enter that directory with a command prompt
  • Enter zefie_wtvp_minisrv subdirectory
  • Verify you are in the same directory as app.js, then run npm install
  • Check any configuration. Create your override user_config.json. Especally service_ip. See user_config_README.md and user_config.example.json for more information.
    • Note: The intended use is for all custom config to be in user_config.json and any custom service files to go in UserServiceVault. If you do not care about potential issues with future git pull, and will manually add new upstream config.json entries, you could use the standard ServiceVault and config.json
  • Run node app.js
  • If you have trouble running it on Windows, try a Linux machine, Windows may need a full development enviroment or extra steps.
  • Test with a WebTV Viewer or connect with a real box
  • To connect with a real box, you will need to open ports in your firewall and have a way to connect your WebTV (and preferably reroute 10.0.0.1 to the server)
  • See ServiceVault.md for a brief introduction to how the service files work

How to Support the Project