mirror/mxpv-podsync
1
0
Fork 0
mirror of https://github.com/mxpv/podsync.git synced 2024-05-11 05:55:04 +00:00
Code Issues Releases Activity

Add config.toml.example (fix #269 #194)

Browse Source
This commit is contained in:
Maksym Pavlenko
2022-01-02 17:31:41 +02:00
parent 36900183b5
commit aaf8e0958c
4 changed files with 119 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -50,66 +50,26 @@ In order to query YouTube or Vimeo API you have to obtain an API token first.
- [How to get YouTube API key](https://elfsight.com/blog/2016/12/how-to-get-youtube-api-key-tutorial/)
- [Generate an access token for Vimeo](https://developer.vimeo.com/api/guides/start#generate-access-token)
## Configuration example
## Configuration
You need to create a configuration file (for instance `config.toml`) and specify the list of feeds that you're going to host.
Here is an example how configuration might look like:
See [config.toml.example](./config.toml.example) for all possible configuration keys available in Podsync.
Minimal configuration would look like this:
```toml
[server]
port = 8080
# Bind a specific IP addresses for server ,"*": bind all IP addresses which is default option, localhost or 127.0.0.1 bind a single IPv4 address
bind_address = "172.20.10.2"
# Specify path for reverse proxy and only [A-Za-z0-9]
path = "test"
data_dir = "/app/data" # Don't change if you run podsync via docker
data_dir = "/data/podsync/"
# Tokens from `Access tokens` section
[tokens]
youtube = ["YOUTUBE_API_TOKEN"] # YouTube API Key. See https://developers.google.com/youtube/registering_an_application
vimeo = [ # Multiple keys will be rotated.
"VIMEO_API_KEY_1", # Vimeo developer keys. See https://developer.vimeo.com/api/guides/start#generate-access-token
"VIMEO_API_KEY_2"
]
youtube = "PASTE YOUR API KEY HERE"
[feeds]
[feeds.ID1]
url = "{FEED_URL}" # URL address of a channel, group, user, or playlist.
page_size = 50 # The number of episodes to query each update (keep in mind, that this might drain API token)
update_period = "12h" # How often query for updates, examples: "60m", "4h", "2h45m"
quality = "high" # or "low"
format = "video" # or "audio"
playlist_sort = "asc" # or "desc", which will fetch playlist items from the end
# custom.cover_art_quality use "high" or "low" to special cover image quality from channel cover default is equal with "quality" and disable when custom.cover_art was set.
# custom = { title = "Level1News", description = "News sections of Level1Techs, in a podcast feed!", author = "Level1Tech", cover_art = "{IMAGE_URL}", cover_art_quality = "high", category = "TV", subcategories = ["Documentary", "Tech News"], explicit = true, lang = "en" } # Optional feed customizations
# max_height = 720 # Optional maximal height of video, example: 720, 1080, 1440, 2160, ...
# cron_schedule = "@every 12h" # Optional cron expression format. If set then overwrite 'update_period'. See details below
# filters = { title = "regex for title here", not_title = "regex for negative title match", description = "...", not_description = "..." } # Optional Golang regexp format. If set, then only download matching episodes.
# opml = true|false # Optional inclusion of the feed in the OPML file (default value: false)
# clean = { keep_last = 10 } # Keep last 10 episodes (order desc by PubDate)
# youtube_dl_args = [ "--write-sub", "--embed-subs", "--sub-lang", "en,en-US,en-GB" ] # Optional extra arguments passed to youtube-dl when downloading videos from this feed. This example would embed available English closed captions in the videos. Note that setting '--audio-format' for audio format feeds, or '--format' or '--output' for any format may cause unexpected behaviour. You should only use this if you know what you are doing, and have read up on youtube-dl's options!
[database]
badger = { truncate = true, file_io = true } # See https://github.com/dgraph-io/badger#memory-usage
[downloader]
self_update = true # Optional, auto update youtube-dl every 24 hours
timeout = 15 # Timeout in minutes
# Optional log config. If not specified logs to the stdout
[log]
filename = "podsync.log"
max_size = 50 # MB
max_age = 30 # days
max_backups = 7
compress = true
[feeds.ID1]
url = "https://www.youtube.com/channel/UCxC5Ls6DwqV0e-CYcAKkExQ"
```
Please note: Automatically clean-up will not work without a database configuration.
Episodes files will be kept at: `/path/to/data/directory/ID1`, feed will be accessible from: `http://localhost/ID1.xml`
If you want to hide Podsync behind reverse proxy like nginx, you can use `hostname` field:
```toml

20
cmd/podsync/config_test.go
View File

@@ -40,16 +40,16 @@ timeout = 15
filters = { title = "regex for title here" }
playlist_sort = "desc"
clean = { keep_last = 10 }
[feeds.XYZ.custom]
cover_art = "http://img"
cover_art_quality = "high"
category = "TV"
subcategories = ["1", "2"]
explicit = true
lang = "en"
author = "Mrs. Smith (mrs@smith.org)"
ownerName = "Mrs. Smith"
ownerEmail = "mrs@smith.org"
[feeds.XYZ.custom]
cover_art = "http://img"
cover_art_quality = "high"
category = "TV"
subcategories = ["1", "2"]
explicit = true
lang = "en"
author = "Mrs. Smith (mrs@smith.org)"
ownerName = "Mrs. Smith"
ownerEmail = "mrs@smith.org"
`
path := setup(t, file)
defer os.Remove(path)

101
config.toml.example Normal file
View File

@@ -0,0 +1,101 @@
# This is an example of TOML configuration file for Podsync.
# Web server related configuration.
[server]
# HTTP server port.
port = 8080
# Optional. If you want to hide Podsync behind reverse proxy like nginx, you can use hostname field.
# Server will be accessible from http://localhost:8080, but episode links will point to https://my.test.host:4443/ID1/XYZ
hostname = "https://my.test.host:4443"
# Bind a specific IP addresses for server ,"*": bind all IP addresses which is default option, localhost or 127.0.0.1 bind a single IPv4 address
bind_address = "172.20.10.2"
# Specify path for reverse proxy and only [A-Za-z0-9]
path = "test"
data_dir = "/app/data" # Don't change if you run podsync via docker
# API keys to be used to access Youtube and Vimeo.
# These can be either specified as string parameter or array of string (so those will be rotated).
[tokens]
youtube = "YOUTUBE_API_TOKEN" # YouTube API Key. See https://developers.google.com/youtube/registering_an_application
vimeo = [ # Multiple keys will be rotated.
"VIMEO_API_KEY_1", # Vimeo developer keys. See https://developer.vimeo.com/api/guides/start#generate-access-token
"VIMEO_API_KEY_2"
]
# The list of data sources to be hosted by Podsync.
# These are channels, users, playlists, etc.
[feeds]
# Each channel must have a unique identifier (in this example "ID1").
[feeds.ID1]
# URL address of a channel, group, user, or playlist.
url = "https://www.youtube.com/channel/CHANNEL_NAME_TO_HOST"
# The number of episodes to query each update (keep in mind, that this might drain API token)
page_size = 50
# How often query for updates, examples: "60m", "4h", "2h45m"
update_period = "12h"
quality = "high" # or "low"
format = "video" # or "audio"
playlist_sort = "asc" # or "desc", which will fetch playlist items from the end
# Optional maximal height of video, example: 720, 1080, 1440, 2160, ...
max_height = 720
# Optinally include this feed in OPML file (default value: false)
opml = true
# Optional cron expression format for more precise update schedule.
# If set then overwrite 'update_period'.
cron_schedule = "@every 12h"
# Whether to cleanup old episodes.
# Keep last 10 episodes (order desc by PubDate)
clean = { keep_last = 10 }
# Optional Golang regexp format.
# If set, then only download matching episodes.
filters = { title = "regex for title here", not_title = "regex for negative title match", description = "...", not_description = "..." }
# Optional extra arguments passed to youtube-dl when downloading videos from this feed.
# This example would embed available English closed captions in the videos.
# Note that setting '--audio-format' for audio format feeds, or '--format' or '--output' for any format may cause
# unexpected behaviour. You should only use this if you know what you are doing, and have read up on youtube-dl's options!
youtube_dl_args = ["--write-sub", "--embed-subs", "--sub-lang", "en,en-US,en-GB"]
# Optional feed customizations
[feeds.ID1.custom]
title = "Level1News"
description = "News sections of Level1Techs, in a podcast feed!"
author = "Level1Tech"
cover_art = "{IMAGE_URL}"
cover_art_quality = "high"
category = "TV"
subcategories = ["Documentary", "Tech News"]
explicit = true
lang = "en"
author = "Mrs. Smith (mrs@smith.org)"
ownerName = "Mrs. Smith"
ownerEmail = "mrs@smith.org"
# Podsync uses local database to store feeds and episodes metadata.
# This section is optional and usually not needed to configure unless some very specific corner cases.
# Refer to https://dgraph.io/docs/badger/get-started/#memory-usage for documentation.
[database]
badger = { truncate = true, file_io = true }
# Youtube-dl specific configuration.
[downloader]
# Optional, auto update youtube-dl every 24 hours
self_update = true
# Download timeout in minutes.
timeout = 15
# Optional log config. If not specified logs to the stdout
[log]
filename = "podsync.log"
max_size = 50 # MB
max_age = 30 # days
max_backups = 7
compress = true

1
pkg/db/badger.go
View File

@@ -23,7 +23,6 @@ const (
)
// BadgerConfig represents BadgerDB configuration parameters
// See https://github.com/dgraph-io/badger#memory-usage
type BadgerConfig struct {
Truncate bool `toml:"truncate"`
FileIO bool `toml:"file_io"`