forked from mxpv/podsync
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.toml.example
134 lines (113 loc) · 5.46 KB
/
config.toml.example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# 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"
# Optional. If you want to use TLS you must set the TLS flag and path to the certificate file and private key file.
tls = true
certificate_path = "/var/www/cert.pem"
key_file_path = "/var/www/priv.pem"
# Configure where to store the episode data
[storage]
# Could be "local" (default) for the local file system, or "s3" for a S3-compatible storage provider (e.g. AWS S3)
type = "local"
[storage.local]
data_dir = "/app/data" # Don't change if you run podsync via docker
# To configure for a S3 provider, set key and secret in environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, respectively;
# then fillout the API endpoint, region, and bucket below.
[storage.s3]
endpoint_url = "https://s3.us-west-2.amazonaws.com"
region = "us-west-2"
bucket = "example-bucket-name"
# If you use prefix, you may need to add a path to `server.hostname` setting
# e.g. https://example-bucket-name.s3.us-west-2.amazonaws.com/example/prefix/
prefix = "example/prefix"
# 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" # "high" or "low"
format = "video" # "audio", "video" or "custom"
# When format = "custom"
# YouTubeDL format parameter and result file extension
custom_format = { youtube_dl_format = "bestaudio[ext=m4a]", extension = "m4a" }
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
# Optionally 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.
# Duration filters are in seconds.
# max_age filter is in days.
filters = { title = "regex for title here", not_title = "regex for negative title match", description = "...", not_description = "...", min_duration = 0, max_duration = 86400, max_age = 365 }
# 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"]
# When set to true, podcasts indexers such as iTunes or Google Podcasts will not index this podcast
private_feed = true
# 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"
# optional: this will override the default link (usually the URL address) in the generated RSS feed with another link
link = "https://example.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
debug = false