This is the source code for a simple, easy to use podcatcher web application. You are free to use this source to host the app yourself. The application is intended to be run in production in Heroku or a Heroku-like PAAS such as Dokku or Railway; however it should be quite easy to adapt it to run in other environments such as AWS EC2.
Radiofeed requires the following basic dependencies to get started:
- Python 3.10+
- Node 16+
- pip-tools
For ease of local development a docker-compose.yml is provided which includes:
- PostgreSQL
- Redis
- Mailhog (for local email testing and development)
You can use these images if you want, or use a local install of PostgreSQL or Redis.
If you want to use the Docker images just run:
docker-compose up --build -dCurrent tested versions are PostgresSQL 14+ and Redis 6.2+.
You should run your development environment inside a virtualenv e.g.:
python -m venv .venv && source .venv/bin/activateA Makefile has been provided with shortcuts to install and run your local development environment, including:
make install: download and install front and backend dependenciesmake dbinstall: run migrations and install sample fixturesmake test: run unit testsmake update: update all dependencies to latest available versionsmake watch: compile JavaScript and CSS assets on the flymake serve: run Django development servermake shell: run Django shell on iPython
If you are running several of these operations simultaneously you may want to use a multiplexer such as Tmux.
The following environment variables should be set in your production installation (changing radiofeed.app for your domain).
DJANGO_SETTINGS_MODULE=radiofeed.settings.production
ALLOWED_HOSTS=radiofeed.app
DATABASE_URL=<database-url>
REDIS_URL=<redis-url>
ADMIN_URL=<admin-url>
ADMINS=me@radiofeed.app
EMAIL_HOST=mg.radiofeed.app
MAILGUN_API_KEY=<mailgun_api_key>
SECRET_KEY=<secret>
SENTRY_URL=<sentry-url>
Some settings such as DATABASE_URL may be set automatically by certain PAAS providers such as Heroku. Consult your provider documentation as required.
EMAIL_HOST should be set to your Mailgun sender domain along with MAILGUN_API_KEY if you are using Mailgun.
You should ensure the SECRET_KEY is sufficiently random: run the generate_secret_key custom Django command to create a suitable random string.
In production it's also a good idea to set ADMIN_URL to something other than the default admin/. Make sure it ends in a forward slash, e.g. some-random-path/.
A Dockerfile is provided for standard container deployments e.g. on Dokku.
Once you have access to the Django Admin, you should configure the default Site instance with the correct production name and domain.
In production you should set up the following cron jobs to run these Django commands (with suggested schedules and arguments):
Parse podcast RSS feeds:
*/6 * * * * python manage.py parse_feedsGenerate similar recommendations for each podcast:
15 6 * * * python manage.py create_recommendationsSend podcast recommendations to users:
15 9 * * 1 python manage.py send_recommendations_emailsAn app.json configuration with these cron schedules is included for Dokku deployment.