Paul van Tilburg
3b25e9b5e2
All checks were successful
Check, lint and test / Check, lint and test (push) Successful in 2m1s
|
||
---|---|---|
.forgejo/workflows | ||
debian | ||
src | ||
templates | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
Rocket.toml.example |
Podbringer
Podbringer is a web service that provides podcasts for services that don't offer them (anymore). It provides a way to get the RSS feed for your podcast client and it facilites the downloads of the pods (enclosures).
It currently only supports Mixcloud and YouTube. Other back-ends might be added in the future.
Building & running
Using Cargo, it is easy to build and run Podbringer, just run:
$ cargo run --release
...
Compiling podbringer v0.1.0 (/path/to/podbringer)
Finished release [optimized] target(s) in 9m 26s
Running `/path/to/podbringer/target/release/podbringer`
(Note that Rocket listens on 127.0.0.1:8000
by default for debug builds, i.e.
builds when you don't add --release
.)
Configuration
For now, you will need to provide Rocket with configuration to tell it at which
public URL Podbringer is hosted. This needs to be done even if you are not using
a reverse proxy, in which case you need to provide it with the proxied URL. You
can also use the configuration to configure a different address and/or port.
Just create a Rocket.toml
file that contains (or copy Rocket.toml.example
):
[default]
address = "0.0.0.0"
port = 7062
public_url = "https://my.domain.tld/podbringer"
This will work independent of the type of build. For more about Rocket's configuration, see: https://rocket.rs/v0.5-rc/guide/configuration/.
Usage
Podbringer currently has no front-end or web interface yet that can help you use it. Until then, you just have to enter the right service-specific RSS feed URL in your favorite podcast client to start using it. For example:
https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
|------------------------------| |------| |-------------|
The Podbringer public URL Service Service ID
So, the URL consists of the location of Podbringer, the fact that you want the feed, the name of the service and the ID that identifies something list on that service.
Feed item limit
To prevent feeds with a very large number of items, any feed that is returned
contains at most 50 items by default. If you want to have more (or less) items,
provide the limit in the URL by setting the limit
parameter.
For example, to get up until 1000 items the URL becomes:
https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband?limit=1000
Service: Mixcloud
For Mixcloud, a feed can be constructed of everything that a user posted.
Given the Mixcloud URL like https://www.mixcloud.com/myfavouriteband/, the
myfavouriteband
part of the URL is the Mixcloud username and can be used as
the service ID.
https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
|------------------------------| |------| |-------------|
The Podbringer public URL Service Username
Service: YouTube
For YouTube, a feed can either be constructed of a channel or a playlist.
Given the YouTube channel URL like https://www.youtube.com/c/favouritechannel,
the favouritechannel
part of the URL is the YouTube channel ID.
Given the YouTube playlist URL
https://www.youtube.com/playlist?list=PLsomeplaylistidentifier, the
PLsomeplaylistidentifier
part of the URL is the YouTube playlist ID.
Either the channel or playlist ID can be used as the service ID.
https://my.domain.tld/podbringer/feed/youtube/favouritechannel
|------------------------------| |-----| |--------------|
The Podbringer public URL Service Channel ID
https://my.domain.tld/podbringer/feed/youtube/PLsomeplaylistidentifier
|------------------------------| |-----| |----------------------|
The Podbringer public URL Service Playlist ID
License
Podbringer is licensed under the MIT license (see the LICENSE
file or
http://opensource.org/licenses/MIT).