v0.9.4
- feature: add SSID whitelist/blacklist as well as IP based SSID auth - Add user_config_README.md - Update user_config.example.json - Update README.md - update: wtv-1800:/finish-prereg: send tellyscript on relogin if tellyscripts are enabled, and wtv-script-id == 0 (no tellyscript) - Allow definition of custom ServiceVault paths - feature: app.js: add `bind_ip` option to specify an IP to bind to, instead of `0.0.0.0` - feature: custom service logos and better wtv-home:/splash
This commit is contained in:
85
user_config_README.md
Normal file
85
user_config_README.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# user_config.json Quick Guide
|
||||
`user_config.json` is an override file, you do not need to redefine everything that is in `config.json`, just override the values you wish to. You must use the same structure as `config.json`, but can override any value.
|
||||
|
||||
---
|
||||
|
||||
### `config` section
|
||||
Some values are available that are not defined in `config.json` by default. I will attempt to cover them here.
|
||||
```
|
||||
"service_logo": "WebTVLogoJewel.gif",
|
||||
"service_splash_logo": "file://ROM/images/SplashLogo1.gif"
|
||||
```
|
||||
You can set the image to be loaded in the top left in place of the WebTV or MSN logo, as well as the main Splash image shown on login.
|
||||
If an absolute path (`wtv-url:/`, `file://` url, or `http(s)://` url) is not passed, the server will search for the specified filename in `wtv-star/images` of any Service Vault. You'll want to keep the filesizes low.
|
||||
```
|
||||
"ssid_block_list": [
|
||||
"8100000000000000",
|
||||
"8100000000000010"
|
||||
]
|
||||
```
|
||||
This would ban the SSIDs `8100000000000000` and `8100000000000010` from the service, but allow all other SSIDs to connect.
|
||||
```
|
||||
"ssid_ip_allow_list": {
|
||||
"8100000000000000": [
|
||||
"192.168.1.0/24",
|
||||
"127.0.0.1"
|
||||
]
|
||||
}
|
||||
```
|
||||
This would allow `8100000000000000` to connect, despite being on the block list, if it was connecting from the 192.168.1.0/24 Subnet, or from 127.0.0.1.
|
||||
```
|
||||
"ssid_allow_list": [
|
||||
"8100000000000020",
|
||||
"8100000000000030"
|
||||
]
|
||||
```
|
||||
This would allow only the SSIDs `8100000000000020` and `8100000000000030` to use the service, and block all other SSIDs. Note that if you add an SSID/IP combo to the `ssid_ip_allow_list`, it will allow the SSID even if it is not in the whitelist. This is useful to allow a leaked SSID but only from trusted hosts.
|
||||
|
||||
---
|
||||
### `service` section
|
||||
|
||||
```
|
||||
"wtv-1800" {
|
||||
"send_tellyscripts": true,
|
||||
"send_tellyscript_ssid_whitelist": [
|
||||
"8100000000000000"
|
||||
]
|
||||
}
|
||||
```
|
||||
This override would enable sending of tellyscripts, but only to the box with SSID `8100000000000000`. The `send_tellyscript_ssid_whitelist` parameter is optional, and if not defined while `send_tellyscripts` is true, the server will simply send tellyscripts to all clients.
|
||||
```
|
||||
"wtv-log": {
|
||||
"write_logs_to_disk": true
|
||||
}
|
||||
```
|
||||
By default the wtv-log:/log service discards any submitted data from the WebTV units. You can override this by setting `write_logs_to_disk` to true, then it will save to the directory named `ServiceLogPost` in the same directory as `app.js`.
|
||||
|
||||
```
|
||||
"wtv-some-custom-service": {
|
||||
"port": 1609,
|
||||
"connections": 1
|
||||
}
|
||||
```
|
||||
You can easily define a custom service in your `user_config.json`
|
||||
|
||||
```
|
||||
"wtv-tricks": {
|
||||
"service_ip": "192.168.1.8",
|
||||
"port": 1702,
|
||||
"nobind": true
|
||||
}
|
||||
```
|
||||
The `wtv-tricks` example above shows how you could point a service to another minisrv.
|
||||
```
|
||||
"wtv-1800": {
|
||||
"port": 1715
|
||||
}
|
||||
```
|
||||
The `wtv-1800` example above shows how you could override the default port for a service.
|
||||
|
||||
```
|
||||
"wtv-music": {
|
||||
"disabled": true
|
||||
}
|
||||
```
|
||||
The `wtv-music` example above shows how you could disable a default service without modifying `config.json`
|
||||
Reference in New Issue
Block a user