aetherinox/thetvapp

By aetherinox

•Updated almost 2 years ago

Automatic m3u and xml timer-based updater for TheTvApp

Image

Integration & delivery

Internet of things

Web servers

1.9K

Overview Tags

aetherinox/thetvapp repository overview

⁠♾️ TheTvApp Automated Grabber ♾️

Docker image which automatically fetches the M3U playlist and EPG (XML) guide data for TheTvApp. Can be loaded into IPTV applications such as Jellyfin.

Makes use of the generous work over at https://github.com/dtankdempse/thetvapp-m3u⁠

⁠Github

View the full github repository at:

https://github.com/Aetherinox/thetvapp-docker⁠

⁠About

This container allows you to automatically fetch the latest .m3u8 playlist, and .xml guide files for the TheTvApp IPTV service.

Once the container is started up, an initial grab will be done immediately. After that initial grab, the container will periodically grab new copies of the files every X hours, which can be adjusted by modifying the docker environment variables.

The fetched .m3u8 and .xml files are then placed in a self-hosted nginx webserver which allows you to add the direct links directly into applications such as Jellyfin without having to go back and update the files on your own.

Container supports the following:

Automatically grabs .m3u8 and .xml files when container started up
Every 60 minutes, a new copy of the .m3u8 and .xml files will be fetched
Supports both ports 80 and 443
Self-signed SSL certificates (optional)
Mountable volume to control Nginx webserver files
Customizable URLs via env var should the m3u8 and xml links change
Integrated nginx hosted file browser for viewing all downloaded files, along with date and file size

⁠Docker Images

Use any of the following images in your docker-compose.yml or run command:

Service	Version	Image Link
`Docker Hub`	[![Docker Version][dockerhub-version-ftb-img]][dockerhub-version-ftb-uri]	`aetherinox/thetvapp:latest`
`Github`	[![Github Version][github-version-ftb-img]][github-version-ftb-uri]	`ghcr.io/aetherinox/thetvapp-docker:latest`

⁠Docker Tags

This repo includes a few different versions of the TheAppTV docker image.

Tag	Description
`:latest`	Latest version of the image. Includes only Nginx - no PHP
`:1.x.x`	Specified version which contains Nginx only - no PHP
`:1.x.x-php`	Contains both Nginx and PHP.

⁠Install

Instructions on using this container

⁠Docker Run

If you want to bring the docker container up quickly, use the following command:

docker run -d --restart=unless-stopped -e CRON_TIME=*/60 * * * * -p 443:443 --name thetvapp -v ${PWD}/thetvapp:/config ghcr.io/aetherinox/thetvapp-docker:latest

⁠Docker Compose

Create a new docker-compose.yml with the following:

services:
    thetvapp:
        container_name: thetvapp
        image: ghcr.io/aetherinox/thetvapp-docker:latest    # Github image
      # image: aetherinox/thetvapp:latest                   # Dockerhub image
        restart: unless-stopped
        volumes:
            - ./thetvapp:/config
        environment:
            - PUID=1000
            - PGID=1000
            - TZ=Etc/UTC
            - CRON_TIME=*/60 * * * *

Caution
Do **not** add `"` quotation marks to `CRON_TIME` environment variable. Automated timer will not function if you do.
✔️ Correct
environment:
   - CRON_TIME=*/60 * * * *
❌ Incorrect
environment:
   - CRON_TIME="*/60 * * * *"

⁠Traefik

You can put this container behind Traefik if you want to use a reverse proxy and let Traefik handle the SSL certificate.

⁠Dynamic.yml

Open the Traefik dynamic file which is usually named dynamic.yml. We need to add a new middleware, router, and service to our Traefik dynamic file so that it knows about our new TheTVApp container and where it is.

http:
    middlewares:
        https-redirect:
            redirectScheme:
                scheme: "https"
                permanent: true

    routers:
        thetvapp-http:
            service: thetvapp
            rule: Host(`domain.localhost`) || Host(`thetvapp.domain.com`)
            entryPoints:
                - http
            middlewares:
                - https-redirect@file

        thetvapp-https:
            service: thetvapp
            rule: Host(`domain.localhost`) || Host(`thetvapp.domain.com`)
            entryPoints:
                - https
            tls:
                certResolver: cloudflare
                domains:
                    - main: "domain.com"
                      sans:
                          - "*.domain.com"

    services:
        thetvapp:
            loadBalancer:
                servers:
                    - url: "https://thetvapp:443"

⁠Static.yml

These entries will go in your Traefik static.yml file. Any changes made to this file requires that you reset Traefik afterward.

⁠certificatesResolvers

Open your Traefik static.yml file and add your certResolver from above. We are going to use Cloudflare in this exmaple, you can use whatever from the list at:

https://doc.traefik.io/traefik/https/acme/#providers⁠

certificatesResolvers:
    cloudflare:
        acme:
            email: [email protected]
            storage: /cloudflare/acme.json
            keyType: EC256
            preferredChain: 'ISRG Root X1'
            dnsChallenge:
                provider: cloudflare
                delayBeforeCheck: 15
                resolvers:
                    - "1.1.1.1:53"
                    - "1.0.0.1:53"
                disablePropagationCheck: true

Once you pick the DNS / SSL provider you want to use from the code above, you need to see if that provider has any special environment variables that must be set. The Providers Page⁠ lists all providers and also what env variables need set for each one.

In our example, since we are using Cloudflare for dnsChallenge -> provider, we must set:

CF_API_EMAIL
CF_API_KEY

Create a .env environment file in the same folder where your Traefik docker-compose.yml file is located, and add the following:

[email protected]
CF_API_KEY=Your-Cloudflare-API-Key

Save the .env file and exit.

⁠entryPoints (Normal)

Finally, inside the Traefik static.yml, we need to make sure we have our entryPoints configured. Add the following to the Traefik static.yml file only if you DON'T have entry points set yet:

entryPoints:
    http:
        address: :80
        http:
            redirections:
                entryPoint:
                    to: https
                    scheme: https

    https:
        address: :443
        http3: {}
        http:
            tls:
                options: default
                certResolver: cloudflare
                domains:
                    - main: domain.com
                      sans:
                          - '*.domain.com'

⁠entryPoints (Cloudflare)

If your website is behind Cloudflare's proxy service, you need to modify your entryPoints above so that you can automatically allow Cloudflare's IP addresses through. This means your entry points will look a bit different.

In the example below, we will add forwardedHeaders -> trustedIPs and add all of Cloudflare's IPs to the list which are available here:

https://www.cloudflare.com/ips/⁠

    http:
        address: :80
        forwardedHeaders:
            trustedIPs: &trustedIps
                - 103.21.244.0/22
                - 103.22.200.0/22
                - 103.31.4.0/22
                - 104.16.0.0/13
                - 104.24.0.0/14
                - 108.162.192.0/18
                - 131.0.72.0/22
                - 141.101.64.0/18
                - 162.158.0.0/15
                - 172.64.0.0/13
                - 173.245.48.0/20
                - 188.114.96.0/20
                - 190.93.240.0/20
                - 197.234.240.0/22
                - 198.41.128.0/17
                - 2400:cb00::/32
                - 2606:4700::/32
                - 2803:f800::/32
                - 2405:b500::/32
                - 2405:8100::/32
                - 2a06:98c0::/29
                - 2c0f:f248::/32
        http:
            redirections:
                entryPoint:
                    to: https
                    scheme: https

    https:
        address: :443
        http3: {}
        forwardedHeaders:
            trustedIPs: *trustedIps
        http:
            tls:
                options: default
                certResolver: cloudflare
                domains:
                    - main: domain.com
                      sans:
                          - '*.domain.com'

Save the files and then give Traefik and your TheTvApp containers a restart.

⁠Env Variables & Volumes

This section outlines that environment variables can be specified, and which volumes you can mount when the container is started.

⁠Environment Variables

The following env variables can be modified before spinning up this container:

Env Var	Default	Description
`PUID`	1000	_{User ID running the container}
`PGID`	1000	_{Group ID running the container}
`TZ`	Etc/UTC	_Timezone
`PORT_HTTP`	80	_{Defines the HTTP port to run on}
`PORT_HTTPS`	443	_{Defines the HTTPS port to run on}
`CRON_TIME`	0/60 * * * *	_{Determines how often the .m3u8 and .xml guide files are updated}
`URL_XML`	_{https://raw.githubusercontent.com/dtankdempse/thetvapp-m3u/refs/heads/main/guide/epg.xml⁠}	_{URL to fetch .xml file}
`URL_XML_GZ`	_{https://raw.githubusercontent.com/dtankdempse/thetvapp-m3u/refs/heads/main/guide/epg.xml.gz⁠}	_{URL to fetch .xml.gz file}
`URL_M3U`	_{https://thetvapp-m3u.data-search.workers.dev/playlist⁠}	_{URL to fetch .m3u8 file}

Please note that you can change the URLs for the files fetched from the internet, but it is highly advised to not do this unless you know for sure that the location paths have changed. To change the URLs to the m3u8, .xml, and .xml.gz; change the following environment variables:

URL_XML=https://url/to/file.xml
URL_XML_GZ=https://url/to/file.xml.gz
URL_M3U=https://url/to/file.m3u8

⁠Volumes

The following volumes can be mounted with this container:

Volume	Description
`./thetvapp:/config`	_{Path which stores downloaded .m3u8, .xml, nginx configs, and optional SSL certificate/keys}

By mounting the volume above, you should now have access to the following folders:

Folder	Description
`📁 keys`	_{Responsible for storing your ssl certificate cert.crt + key cert.key}
`📁 log`	_{All nginx and php logs}
`📁 nginx`	_{Contains nginx.conf, resolver.conf, ssl.conf, site-confs}
`📁 php`	_{Contains php-local.ini, www2.conf}
`📁 www`	_{Folder where downloaded .m3u8, .xml, and .xml.gz will be downloaded to}

⁠Build

You can build your own copy of the image by running the following:

git clone https://github.com/Aetherinox/thetvapp-docker.git .
docker build -t thetvapp:latest thetvapp:1.0.0 .

⁠Troubleshooting

These are issues you may experience when building and deploying your own custom image.

⁠Permission Denied

Failed to open apk database: Permission denied
unable to exec /etc/s6-overlay/s6-rc.d/init-envfile/run: Permission denied
unable to exec /etc/s6-overlay/s6-rc.d/init-envfile/run: Permission denied

If you receive any type of permission denied error when running your custom image, you must ensure that certain files have executable +x (or 0755) permissions. Once you fix the file permissions, re-build the image. A full list of files requiring elevated permissions are listed below:

sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-adduser/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-crontab-config/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-custom-files/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-envfile/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-folders/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-keygen/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-migrations/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-nginx/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-permissions/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-php/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-samples/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/init-version-checks/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/svc-cron/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/svc-nginx/run
sudo chmod +x /root/etc/s6-overlay/s6-rc.d/svc-php-fpm/run
sudo chmod +x /run.sh
sudo chmod +x /download.sh

⁠Shell / Bash

You can access the docker container's shell by running:

docker exec -it thetvapp ash

⁠Logs

This image spits out detailed information about its current progress. You can either use docker logs or a 3rd party app such as Portainer⁠ to view the logs.

───────────────────────────────────────────────────────────────
                  TheTvApp Docker Container
───────────────────────────────────────────────────────────────

  This container automatically downloads the m3u8 and xml guide
  data from
        - https://github.com/dtankdempse/thetvapp-m3u

  Once the data is downloaded, you can access the files from
  the container's webserver.

        User ID ........... 1000
        Group ID .......... 1000
        Port HTTP ......... 80
        Port HTTPS ........ 443

───────────────────────────────────────────────────────────────

 SSL          : Using existing keys found in /config/keys
 Loader       : No custom files found, skipping...
 Core         : Completed loading container
 Config       : Setting task to run */60 * * * *
                Setting timezone Etc/UTC

 Start        : Downloading latest thetvapp m3u + xml
                Getting thetvapp.xml › https://raw.githubusercontent.com/dtankdempse/thetvapp-m3u/refs/heads/main/guide/epg.xml
                Getting thetvapp.xml.gz › https://raw.githubusercontent.com/dtankdempse/thetvapp-m3u/refs/heads/main/guide/epg.xml.gz
                Getting thetvapp.m3u8 › https://thetvapp-m3u.data-search.workers.dev/playlist
 End          : Finished update at 12-01-2024 15:00:00

Tag summary

Recent tags

Content type

Image

Digest

sha256:15c29a151…

Size

18 MB

Last updated

almost 2 years ago

docker pull aetherinox/thetvapp