podtube

Podtube generates feeds with direct link to media so you can subscribe to online platforms directly from a podcatcher like AntennaPod. Currently supported services:

• YouTube
• Invidious
• iVoox Originals
• Instagram Reels
• Filesystem

Instructions

You must build a url to your channel/podcast. The url must be built like **https://podtube.ayaplex.com//feed?[PARAMETERS]**. The currently supported parameters are:

service (required)

Name of the service that is going to be used. It's the name of one of the plugins on plugins folder (currently invidious, ivoox or youtube)

id (required)

Identifier of the channel/podcast that you want the feed from. For YouTube/Invidious it is the channel id. For iVoox it is the podcast url without domain or .html. Examples:

* https://www.youtube.com/channel/UC2bkHVIDjXS7sgrgjFtzOXQ -> UC2bkHVIDjXS7sgrgjFtzOXQ
* https://www.ivoox.com/podcast-cuarto-milenio-oficial_sq_f17162_1.html -> podcast-cuarto-milenio-oficial_sq_f17162_1

format

Output format of the feed. Accepted values are rss and atom. The default value is rss.

max_pagination

Number of pages for which results are desired. The default value is 1.

proxy_url

Whether the feed will contain urls that point directly to the files on the original services, or if it points to podtube so the final urls are generated on the fly. Values can be True or False. The default value is True. There may be some services that use temporary urls, like YouTube. Also take into account that generating the final url may be a slow process, so only disable this option if you know what you are doing.

proxy_download

In order for this option to make sense, the proxy_url option must be set to True. Values can be True or False. The default value is False. If False, the download endpoint will redirect to the download link on the original service. If true, podtube will stream the file acting as a proxy. This option is provided just in case the service forces that the same IP that generates the download link is the only one with permissions to download. Note that this option may not work on PaaS like Heroku, as long requests are usually not allowed there.

Examples

podtube v2 migration

• proxy_url option was removed: On the initial versions of podtube, the media urls were directly generated. This meant that before downloading a YouTube video, the feed needed to be reloaded, as the URLs are only valid for a small amount of time. However on other plugins where the URL is permanent it could be a bit faster and reduce requests to podtube. After adding offline mode we are removing this option and always going through podtube backend in order to keep the code a bit simpler.
• storage mode considerations: The idea behind storage mode is that plugins will be able to read and write to the filesystem in order to provide support for things that were not possible before, for example downloading videos which only have a streaming or multipart source or inserting subtitles. I've been careful to avoid security issues, but it is not worth the risk if you don't need this feature, so by default capacity to use filesystem is not enabled. Also I think it would probably not work as-is inside the docker images. In order to enable access to filesystem, env variable PODTUBE_FILESYSTEM_MODE needs to be set to true.
• There is a new option to require API key to protect the backend against attacks. If the env variable API_KEY is set, then the feed urls require a new query parameter api_key with the same value. This is not required, so the default behavior is as v1.
• URL upgrade: youtube-dl and invidious instances stop working from time to time, so I think it is useful to be able to switch from one plugin to the other from the backend without needing to update the feed url on your podcatcher. Because of this, the query parameter called service before will now be called plugin, and behaves as the old services query param. The service query param now requires the full domain name of the service and will pick the first plugin that announces support for it. The preferred plugin can be manually set through an env variable. This only applies to YouTube support for now. So setting PODTUBE_PLUGIN_youtube.com=invidious will use invidious plugin, while setting it to youtube will use the YouTube plugin without upgrading the URLs. version 2.0 contains an upgrade code that will upgrade your v1 urls through a permanent redirect to a URL that keeps the behavior of v1, this means not requiring any env variable, but also not allowing to override the YouTube implementation. Make sure that the URLs are updated on your client with the redirect or future podtube versions will stop working.