Web service that provides podcasts for services that don't offer them (anymore).
Go to file
Paul van Tilburg 8afd4b17ba
Add a simple index page that explains the usage
2022-05-24 11:05:59 +02:00
debian Add Debian packaging via cargo-deb 2022-05-20 16:54:09 +02:00
src Add a simple index page that explains the usage 2022-05-24 11:05:59 +02:00
templates Add a simple index page that explains the usage 2022-05-24 11:05:59 +02:00
.gitignore Configure URL via config; dd Rocket.toml example file 2022-05-20 16:15:33 +02:00
Cargo.lock Add a simple index page that explains the usage 2022-05-24 11:05:59 +02:00
Cargo.toml Add a simple index page that explains the usage 2022-05-24 11:05:59 +02:00
LICENSE Add README.md and LICENSE file 2022-05-20 16:19:58 +02:00
README.md Clarify it more with an example URL 2022-05-24 10:51:37 +02:00
Rocket.toml.example Configure URL via config; dd Rocket.toml example file 2022-05-20 16:15:33 +02:00

README.md

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. 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 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
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.

Given the Mixcloud URL https://www.mixcloud.com/myfavouriteband/, the URL you need to use for Podbringer is comprised of the following parts:

  https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
  |------------------------------|     |-------||--------------|
   The Podbringer location URL          Service  User @ service

License

Podbringer is licensed under the MIT license (see the LICENSE file or http://opensource.org/licenses/MIT).