Skip to content

A sleek and efficient podcast downloader.

License

Notifications You must be signed in to change notification settings

APraxx/PodFetch

 
 

Repository files navigation

Podfetch

dependency status

Podfetch is a self-hosted podcast manager. It is a web app that lets you download podcasts and listen to them online. It is written in Rust and uses React for the frontend. It also contains a GPodder integration so you can continue using your current podcast app.

Every time a new commit is pushed to the main branch, a new docker image is built and pushed to docker hub. So it is best to use something like watchtower to automatically update the docker image.

Contributing

Building the project

Prerequisites

  • Rust
  • Cargo
  • Node
  • npm/yarn/pnpm

Building the app

# File just needs to be there
touch static/index.html
cargo.exe run --color=always --package podfetch --bin podfetch
cd ui
<npm/yarn/pnpm> install
<npm/yarn/pnpm> run dev

If you want to run other databases you need to install the corresponding diesel cli. For example for postgres you need to install diesel_cli --no-default-features --features postgres and run the same command for running it with cargo.

UI Development

I would love to have a UX expert to help me with the UI. If you are interested in helping me out, please contact me via GitHub issue with designs/implemented React pages.

Getting Started

Docker

Docker-Compose Examples

Docker-Compose

Advantages over Postgres
  • Easier to setup
  • Easier to use

=> No concurrency. So please don't try to download to podcasts at the same time.

Sqlite

version: '3'
services:
  podfetch:
    image: samuel19982/podfetch:latest
    user: ${UID:-1000}:${GID:-1000}
    ports:
      - "80:8000"
    volumes:
      - podfetch-podcasts:/app/podcasts
      - podfetch-db:/app/db
    environment:
      - POLLING_INTERVAL=60
      - SERVER_URL=http:https://<your-ip>:<your-port>

volumes:
  podfetch-podcasts:
  podfetch-db:

Postgres

Advantages over SQLite

  • Better performance
  • Better concurrency
  • Better stability
  • Better scalability

Docker Compose

version: '3'
services:
  podfetch:
    image: samuel19982/podfetch:postgres
    user: ${UID:-1000}:${GID:-1000}
    ports:
      - "80:8000"
    volumes:
      - ./podcasts:/app/podcasts
    environment:
      - POLLING_INTERVAL=300
      - SERVER_URL=http:https://localhost:80 # Adjust to your server url
      - DATABASE_URL=postgresql:https://postgres:changeme@postgres/podfetch
      - DB_CONNECTIONS=10 # optional
  postgres:
    image: postgres
    environment:
      POSTGRES_USER: ${POSTGRES_USER:-postgres}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-changeme}
      PGDATA: /data/postgres
      POSTGRES_DB: ${POSTGRES_DB:-podfetch}
    volumes:
      - postgres:/data/postgres
    restart: unless-stopped

volumes:
  postgres:

Auth

Several Auth methods are described here: AUTH.md

Hosting

Hosting options are described here: HOSTING.md

CLI usage

The cli usage is described here: CLI.md

Environment Variables

Variable Description Default
POLLING_INTERVAL Interval in minutes to check for new episodes 300
SERVER_URL URL of the server http:https://localhost:8000
DATABASE_URL URL of the database sqlite:https://./db/podcast.db

UI

UI Documentation

Internationalization

Podfetch is currently available in English and German. If you want to add a new language you can do so by adding a new file to the i18n folder and adding the translations to the file.

RSS feed

Podfetch offers an own feed to download podcast episodes. You can add the url <SERVER_URL>/rss to your favorite podcast app like gPodder to download and play episodes.

Podcast Index

It is also possible to retrieve/add podcasts from Podcast Index. To configure it you need to create an account on that website. After creating an account an email is sent to you with the required credentials.

Variable Description Default
PODINDEX_API_KEY the api key sent to you via mail %
PODINDEX_API_SECRET the api secret also found in the mail %
  • % means an empty string is configured as default

After successful setup you should see on the settings page a green checkmark next to the Podindex config section.

GPodder

Podfetch also supports the GPodder api. You can use your current GPodder account to login to Podfetch and continue using your current podcast app. To do that just go to the settings page and enter your GPodder username and password.

To enable it you need to set the following environment variables:

Variable Description Default
GPODDER_INTEGRATION_ENABLED Activates the GPodder integration via your server url false

Roadmap

  • Add podcasts via Itunes api
  • Check for new episodes.
  • Download episodes.
  • Play episodes.
  • Force refresh download of podcast episodes.
  • Force refresh of podcast episodes.
  • Resume podcasts even if browser is closed.
  • Add websocket support for new podcasts.
  • Add detailed audio player.
  • Star podcasts.
  • Unsubscribe podcasts.
  • Add retrieving podcasts from Podcastindex.org.
  • Basic Auth.
  • Import from OPML file.
  • Telegram Bot api to get alerted when new episodes are downloaded.
  • Like episodes.
  • Delete podcasts.

About

A sleek and efficient podcast downloader.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 60.5%
  • TypeScript 38.5%
  • CSS 0.7%
  • Dockerfile 0.2%
  • HTML 0.1%
  • JavaScript 0.0%