Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kd2org/opodsync
A minimalist GPodder server, using the same API, for self-hosting
https://github.com/kd2org/opodsync
antennapod gpodder nextcloud podcast rss
Last synced: about 1 month ago
JSON representation
A minimalist GPodder server, using the same API, for self-hosting
- Host: GitHub
- URL: https://github.com/kd2org/opodsync
- Owner: kd2org
- License: agpl-3.0
- Created: 2022-08-04T00:49:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T23:37:10.000Z (3 months ago)
- Last Synced: 2024-09-27T06:20:38.741Z (about 2 months ago)
- Topics: antennapod, gpodder, nextcloud, podcast, rss
- Language: PHP
- Homepage:
- Size: 109 KB
- Stars: 148
- Watchers: 6
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oPodSync - a minimalist GPodder-compatible server
*(Previously known as Micro GPodder server)*
This is a minimalist podcast synchronization server, for self-hosting your podcast listening / download history.
This allows you to keep track of which episodes have been listened to.
Requires PHP 7.4+ and SQLite3 with JSON1 extension.
## Features
* Compatible with [GPodder](https://gpoddernet.readthedocs.io/en/latest/api/reference/) and NextCloud [gPodder Sync](https://apps.nextcloud.com/apps/gpoddersync) APIs
* Stores history of subscriptions and episodes (plays, downloads, etc.)
* Sync between devices
* Compatible with gPodder desktop client
* Self-registration
* See subscriptions and history on web interface
* Fetch feeds and episodes metadata and store them locally (optional)
## Roadmap
* Support [Podcasting 2.0 GUID](https://podcasting2.org/podcast-namespace/tags/guid)
* Unit tests
* Implement the [Open Podcast API](https://openpodcastapi.org)
* Download, archive and listen to podcasts from the web UI (optional feature)
## Screenshots
## Installation
Just copy the files from the `server` directory into a new directory of your webserver.
This should work in most cases. Exceptions are:
* If you are not using Apache, but Caddy, or nginx, make sure to adapt the rules from the `.htaccess` file to your own server.
* If you are using Apache, but have set-up this server in a sub-folder of your document root, then you will have to adapt the `.htaccess` to your configuration.
### First account
When installed, the server will allow to create a first account. Just go to the server URL and you will be able to create an account and login.
After that first account, account creation is disabled by default.
If you want to allow more accounts, you'll have to configure the server (see "Configuration" below).
### Docker
In order to run oPodSync with Docker you only need to build the `Dockerfile` and run it while binding the `data` directory for persistence and setting the hostname. An example `docker-compose.yml` is provided.
### Configuration
You can create a `config.local.php` in the `data` directory (overridable with the `DATA_ROOT` environment variable), defining configuration constants:
```