Usage¶
Author Notes¶
- All Testing is currently done in Proxmox LXC, Ubuntu 20.04, Python 3.8
Prerequisites¶
- A Linux or Mac "Server". Windows currently does not work. A "Server" is a computer that is typically always online.
- Python 3.7 or later.
- Plugins may have other requirements as well.
Optional Prerequisites¶
- If you intend to use Docker, this guide should help you get started. The author of fHDHR is not a docker user, but will still try to help.
Installation¶
Linux¶
The below instructions use the user "sysop", but you can run it as any user. The script will allow you to run as root, but warns against doing so.
- Download the release zip, or git clone to your prefered location.
cd /home/sysop && git clone https://github.com/fHDHR/fHDHR.git
- Navigate into your script directory and install the python requirements.
cd fHDHR && pip3 install -r requirements.txt
- Copy the included
config.example.inifile to a known location:
cp config.example.ini /home/sysop/config.ini
The script will not run without this - there is no default configuration file location.
-
Modify the configuration file to suit your needs.
-
Install desired fHDHR plugins.
fHDHR will technically run without plugins installed, but is practically useless without an "origin" plugin.
- Install plugin python requirements file:
pip3 install -r requirements.txt
- Run with the path to the config file:
python3 /home/sysop/fhdhr/main.py -c=/home/sysop/config.ini
Docker¶
If you wish to use fHDHR in Docker, then check out the Docker documentation.
Setup¶
Now that you have fHDHR running, you can navigate (in a web browser) to the IP:Port from the configuration step above.
If you did not setup a discovery_address in your config, SSDP will be disabled. This is not a problem as clients like Plex can have the IP:Port entered manually!
You can copy the xmltv link from the webUI and use that in your client software to provide Channel Guide information.