diff --git a/Advanced-Configuration.md b/Advanced-Configuration.md new file mode 100644 index 0000000..3f89873 --- /dev/null +++ b/Advanced-Configuration.md @@ -0,0 +1,114 @@ +Here, we'll break down all of the configuration options per section. + +## Main +Here's the `main` section. +* `uuid` will be created automatically, you need not worry about this. +* `cache_dir` is handy for keeping cached files out of the script directory. This is helpful for reinstalls as well as development. + +```` +[main] +# uuid = +# cache_dir = +```` + +## empty +This section is regarding empty epg settings and is only used if the below `[fakehdhr]epg_method` is set to `empty`. "Empty EPG" is a basic xmltv schedule with an hour block per time of day. +* `epg_update_frequency` This setting is in seconds. + +```` +[empty] +# epg_update_frequency = +```` + +## NextPVR +The `nextpvr` section + + +```` +[nextpvr] +address = localhost +port = 8866 +ssl = +pin = +weight = 300 +sidfile = +epg_update_frequency = 43200 +```` + +The `fakehdhr` contains all the configuration options for interfacing between this script and your media platform. +* `address` and `port` are what we will allow the script to listen on. `0.0.0.0` is the default, and will respond to all. +* `discovery_address` may be helpful for making SSDP work properly. If `address` is not `0.0.0.0`, we will use that. If this is not set to a real IP, we won't run SSDP. SSDP is only really helpful for discovering in Plex/Emby. It's a wasted resource since you can manually add the `ip:port` of the script to Plex. +* `tuner_count` is a limit of devices able to stream from the script. The default is 3, as per Locast's documentation. A 4th is possible, but is not reccomended. +* `friendlyname` is to set the name that Plex sees the script as. +* `stream_type` can be set to `ffmpeg` or `direct`. Locast seems to work better with the `ffmpeg` method. +* `epg_method` defaults to `proxy` and will pull the xmltv data from Locast. Other Options include `empty` which is an hourly schedule with minimal channel information. Another option is `zap2it`, which is another source of EPG information. Channel Numbers may need to be manually mapped. + +## fakehdhr + +```` +[fakehdhr] +# address = 0.0.0.0 +# port = 5004 +# discovery_address = 0.0.0.0 +# tuner_count = 4 +# friendlyname = fHDHR-Locast +# stream_type = ffmpeg +# epg_method = proxy +```` + +## zap2it + +`zap2it` contains a ton of configuration options, and defaults to options that in my experience don't need to be adjusted. +* `postalcode` is a value of importance, and is helpful. If not set, the script will attempt to retrieve your postalcode automatically. +* `epg_update_frequency` determines how often we check zap2it for new scheduling information. + +```` +[zap2it] +# delay = 5 +# postalcode = None +# affiliate_id = gapzap +# country = USA +# device = - +# headendid = lineupId +# isoverride = True +# languagecode = en +# pref = +# timespan = 6 +# timezone = +# userid = - +# epg_update_frequency = 43200 +```` + +## ffmpeg + +The `ffmpeg` section includes: +* `ffmpeg_path` is useful if ffmpeg is not in your systems PATH, or you want to manually specify. +* `bytes_per_read` determines how many bytes of the stream to read before sending the data to your client. Increasing this value may cause longer load times, and lowering it may effect `stuttering`. + +```` +[ffmpeg] +# ffmpeg_path = ffmpeg +# bytes_per_read = 1152000 +```` + +## direct_stream + +The `direct_stream` section is for when you set the `[fakehdhr]stream_type` to `direct` +* `chunksize` is how much data to read at a time. + +```` +[direct_stream] +# chunksize = 1024*1024 +```` + +# Dev +The `dev` section contains options that are changeable, but are unsupported. Use at your own discretion. + +```` +[dev] +# reporting_model = HDHR4-2DT +# reporting_firmware_name = hdhomerun4_dvbt +# reporting_firmware_ver = 20150826 +# reporting_tuner_type = Antenna + +```` \ No newline at end of file