mirror of
https://github.com/mxpv/podsync.git
synced 2024-05-11 05:55:04 +00:00
Update README
This commit is contained in:
29
README.md
29
README.md
@@ -1,32 +1,25 @@
|
||||

|
||||
[](https://www.patreon.com/podsync)
|
||||
|
||||
Podsync - is a simple, free service that lets you listen to any YouTube / Vimeo channels, playlists or user videos in podcast format.
|
||||
|
||||
## Patreon
|
||||
Podcast applications have a rich functionality for content delivery - automatic download of new episodes, remembering last played position, sync between devices and offline listening. This functionality is not available on YouTube and Vimeo. So the aim of Podsync is to make your life easier and enable you to view/listen to content on any device in podcast client.
|
||||
|
||||
In order to login via Patreon the following variables should be configured:
|
||||
- `PATREON_REDIRECT_URL` should point to `http://yout_host_here/patreon`
|
||||
- `PATREON_CLIENT_ID` and `PATREON_SECRET` should be copied from https://www.patreon.com/platform/documentation/clients
|
||||
## Architecture
|
||||
|
||||

|
||||
|
||||
## Building Docker images
|
||||
|
||||
Backend
|
||||
Every project contains a `Makefile` for building and pushing to a registry:
|
||||
|
||||
```bash
|
||||
./build.sh
|
||||
make build
|
||||
make push
|
||||
make update
|
||||
```
|
||||
|
||||
nginx
|
||||
```bash
|
||||
./nginx.sh
|
||||
```
|
||||
Use docker-compose to run containers:
|
||||
|
||||
ytdl
|
||||
```bash
|
||||
cd cmd/ytdl/
|
||||
./build.sh
|
||||
```
|
||||
|
||||
## Running
|
||||
```bash
|
||||
docker-compose pull
|
||||
docker-compose up -d
|
||||
|
BIN
docs/architecture.png
Normal file
BIN
docs/architecture.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 45 KiB |
Reference in New Issue
Block a user