Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 3.01 KB

README.md

File metadata and controls

90 lines (69 loc) · 3.01 KB
Raw

Frenchs.

A mustardy EXTM3U proxy!

The M3U URL for your bouquet maker/editor should now be:

http://127.0.0.1:<PORT>/?url=<ORIGINAL M3U URL>

where <PORT> comes from the settings, the default being 7290;

Required parameters:

  • url=<ORIGINAL M3U URL> is whatever your provider told you to use, but needs to be URL encoded; just use any online encoder that works; this parameter can be repeated if you want to concatenate various M3U files.

Optional parameters:

  • marker=<MARKER> indicates that the provided string should be used to mark catchup services; the default is not to mark them; this parameter will also require encoding;
  • prefix=<SOMETHING> indicates we want to use <MARKER> as a prefix to the channel name, instead of the default which is to use it as a suffix;
  • clean=<SOMETHING> indicates we want to cleanup the M3U data from possible UTF8 (or other) errors;
  • alfa=<SOMETHING> indicates we want to sort the services in ascending order; it assumes a minimal M3U, and can screw it up if it isn't formatted as expected, use with care;
  • vapi=<SOMETHING> forces use of VAPI. NOTE WELL: if you don't know what you're doing with this parameter, don't touch it, as your XC provider credentials may be leaked to the hardcoded VAPI provider.

Example of a typical XC API URL that would prefix a marker of '[+] ':

http://127.0.0.1:7290/?marker=%5B%2B%5D%20&prefix=1&url=http%3A%2F%2FHOST%3APORT%2Fget.php%3Fusername%3DUSERNAME%26password%3DPASSWORD%26type%3Dm3u_plus

Notice how only the "marker" and "url" parameter values (in bold) should be encoded, the remainder of the new/proxied URL should not.

Dev/Testing on OpenATV 6.2 and OpenPLi 6.2, Caveat Emptor.

Description

Frenchs is a plugin which proxies M3U requests so a bit of pre-processing is done. Originally written to add a marker to the names of channels supporting catchup, now it can do a bit more, as written above.

Generally a bouquet generator plugin (e.g., Suls/E2m3u2bouquet Maker), would be configured with the M3U URL of your provider.

Bouquet Generator + M3U URL of provider -> contacts provider M3U server

If you want to pre-process the contents (like marking catchup as mentioned) with Frenchs, the setup will now be:

Bouquet Generator + Frenchs M3U URL with encoded M3U URL of provider -> Frenchs -> contacts provider M3U server

Settings

"Port"

  • "EXTM3U URL port."
  • Default: 7290.
  • The TCP/IP port to listen on, and where to send the M3U requests to. Accessible only on the loopback (via localhost/127.0.0.1 host address).

"Buffer Size"

  • "Buffer size in MiB."
  • Default: 35 MBytes.
  • How much memory to use for storing and processing the retrieved M3U data. Some M3U are pretty large, these days, if you have issues, try and increase this value, up to a maximum of 256MB, but be careful not to exhaust the box memory.

"Debug"

  • "Activate debug log."
  • Default: False.
    • If set to True, debug information is recorded under the /tmp/frenchs-debug.log file.