Configuration¶
How to start¶
First of all you need to prepare config file, which helps you describe all the sources that you want to subscribe and destinations where movies should be downloaded. More information about
After that you need to share generated podcast on your private http server.
Remember that this library have no secure podcast file from other viewers. You public it on your own responsibility. Please make sure that author of your favorite movies allows you to make podcast from his files
Configuration file¶
The behaviour of the program you can define in configuration file.
It tells what sources should be checked for new files and where will be
saved or how to distribute them. The configuration file is a simple yaml
(or json) file that named: config.yml
(or config.json
for json).
Localization¶
The ytrss looking for following directory to find this file and get first available to work with.
From location defined in
PYTHON_YTRSS_CONFIG
environment.For windows from
$HOME\\YTRSS
fileFor linux in
~/.config/ytrss
or/etc/ytrss/
file.
User also can set specific configuration file by define it with
-c
or --conf
parameter in terminal client
Example configuration file¶
The configuration file has yaml format. The example of the file looks like this:
---
subscriptions:
- name: Private playlist
url: https://youtube.com/playlist?list=<playlist_id>
destination: default
- name: YouTube
destination: youtube
url: https://www.youtube.com/@YouTube
destinations:
default:
type: rss
title: Youtube - podcast
url_prefix: https://my.domain/ytdown/default
author: youtube
link: https://youtube.com
desc: My favourite movies from YouTube
img: https://www.youtube.com/yts/img/yt_1200-vfl4C3T0K.png
path: /home/user/podcasts/default
youtube:
type: rss
title: Youtube channel
url_prefix: https://my.domain/ytdown/youtube
author: youtube
link: https://youtube.com
desc: YouTube channel
img: https://www.youtube.com/yts/img/yt_1200-vfl4C3T0K.png
path: /home/user/podcasts/youtube
Main structure¶
key |
default value |
description |
|
---|---|---|---|
subscriptions |
required |
- |
List of sources that will be look for new files. See Subscriptions structure. |
destinations |
required |
- |
A list of elements where the files should be placed. See Destinations structure. |
config_dir |
optional |
|
Directory where the configuration should be places |
cache_path |
optional |
|
A place where all file should be downloaded before copy to destination |
arguments |
optional |
[] |
A list of parameters that are added to |
Subscriptions structure¶
key |
default value |
description |
|
---|---|---|---|
name |
optional |
“<unknown>” |
Readable name of source |
url |
required |
- |
A localization of source (e.x. url to youtube channel) |
destination |
optional |
“default” |
The destination where the file will be transfer. See Destinations structure. |
enable |
optional |
|
If set to |
Destinations structure¶
key |
default value |
description |
|
---|---|---|---|
type |
required |
- |
Type of destination (e.x. rss for podcast) |
title |
optional |
“unknown title” |
Title of podcast |
url_prefix |
optional |
(empty) |
a string that have been added to podcast url |
author |
optional |
“Nobody” |
Author of podcast |
link |
optional |
List to podcast (e.x. to youtube channel) |
|
desc |
optional |
“No description” |
Description of podcast |
img |
optional |
None |
Optional url to podcast image |
path |
required |
- |
Path that the file should be saved |