diff --git a/Readme.md b/Readme.md index 934a1aa..0caacec 100644 --- a/Readme.md +++ b/Readme.md @@ -58,6 +58,7 @@ - [About the Project](#about-the-project) - [Motivation](#motivation) - [Built With](#built-with) + - [Features](#features) - [Installation](#installation) - [License](#license) - [Roadmap](#roadmap) @@ -87,6 +88,21 @@ Podgrab started a tool that I initially built to solve a specific problem I had. - [GORM](https://github.com/go-gorm/gorm) - [SQLite](https://www.sqlite.org/index.html) +### Features +- Download/Archive complete podcast +- Auto-download new episodes +- Download on demand +- Podcast Discovery - Search and Add podcasts using iTunes API +- Full-fledged podcast player +- Add using direct RSS feed url / OMPL import / Search +- Basic Authentication +- Existing episode detection +- Easy OPML import/export +- Customizable episode names +- Dark Mode +- Self Hosted / Open Source +- Docker support + ## Installation The easiest way to run Podgrab is to run it as a docker container. @@ -137,7 +153,10 @@ services: | CHECK_FREQUENCY | How frequently to check for new episodes and missing files (in minutes) | 30 | | PASSWORD | Set to some no empty value to enable Basic Authentication, username `podgrab`|(empty)| - +### Setup + +- Enable *websocket support* if running behind a reverse proxy. This is needed for the "Add to playlist" functionality. +- Go through the settings page once and change relevant settings before adding podcasts. ## License @@ -152,10 +171,11 @@ Distributed under the MIT License. See `LICENSE` for more information. - [x] Rudimentary downloading/downloaded indicator - [x] Played/Unplayed Flag - [x] OPML import -- [ ] OPML export +- [x] OPML export +- [x] In built podcast player - [ ] Set ID3 tags if not set - [ ] Filtering and Sorting options -- [ ] In built podcast player + diff --git a/Screenshots.md b/Screenshots.md index f72a04b..39b014a 100644 --- a/Screenshots.md +++ b/Screenshots.md @@ -14,6 +14,11 @@ ![Podcast Episodes](images/podcast_episodes.jpg) + +## Player + +![Player](images/player.jpg) + ## Settings ![Podcast Episodes](images/settings.jpg) diff --git a/images/add_podcast.jpg b/images/add_podcast.jpg index 03c0baf..6ba9fd0 100644 Binary files a/images/add_podcast.jpg and b/images/add_podcast.jpg differ diff --git a/images/all_episodes.jpg b/images/all_episodes.jpg index ab25784..f3cab7d 100644 Binary files a/images/all_episodes.jpg and b/images/all_episodes.jpg differ diff --git a/images/player.jpg b/images/player.jpg new file mode 100644 index 0000000..e025cc4 Binary files /dev/null and b/images/player.jpg differ diff --git a/images/podcast_episodes.jpg b/images/podcast_episodes.jpg index 5fb84ff..c679931 100644 Binary files a/images/podcast_episodes.jpg and b/images/podcast_episodes.jpg differ diff --git a/images/screenshot.jpg b/images/screenshot.jpg index 93a0104..1923b91 100644 Binary files a/images/screenshot.jpg and b/images/screenshot.jpg differ diff --git a/images/settings.jpg b/images/settings.jpg index 0f50f2e..9ab1dc4 100644 Binary files a/images/settings.jpg and b/images/settings.jpg differ