User Settings¶
An overview of all available user settings available in the user configuration file. By default, the configuration file is installed here:
~/.config/mediahandler/config.yml
The configuration file uses YAML formatting, and does not require that every option is present in the file. Sections and options may be left blank or completely removed – the application will use default values in their place.
View an Example Configuration File.
General¶
General mediahandler script functionality options.
Default section and values:
General:
keep_files: no
keep_if_skips: yes
keep_files¶
Enable or disable mediahandler’s removal of the originally downloaded files upon script completion.
- Valid options:
no
(default)yes
keep_if_skips¶
Enable or disable mediahandler’s removal of the originally downloaded files in a situation where some of files were skipped during the script’s processing.
- Valid options:
no
yes
(default)
Deluge¶
Deluge server integration options.
Default section and values:
Deluge:
enabled: no
host: 127.0.0.1
port: 58846
user:
pass:
enabled¶
Enable or disable mediahandler’s ability to automatically remove a torrent from the Deluge UI when the script is executed on torrent completion. Please review the python package and application Installation Requirements before enabling.
See Deluge Integration for more information on this integration.
- Valid options:
no
(default)yes
Logging¶
Logging output options.
Default section and values:
Logging:
enabled: yes
level: 30
log_file:
Notifications¶
Options for push notification via 3rd party services. Multiple services may be used side-by-side.
Default section and values:
Notifications:
enabled: no
notify_name:
pushover:
api_key:
user_key:
pushbullet:
token:
enabled¶
Enable or disable push notifications upon script completion. Please review the python package and application Installation Requirements before enabling.
- Valid options:
no
(default)yes
notify_name¶
Specify a name for notifications to use in message titles, e.g. “EM Media Handler: Media Added”.
Default: EM Media Handler
pushover¶
To enable Pushover integration, simply set both the api_key
and user_key
settings with valid credentials:
Notifications:
enabled: yes
notify_name: My Custom Name
pushover:
api_key: SNAczveGbbyzUmASUljL
user_key: AkdmliUzQZofvoYVLskG
Your user_key
can be found on your Pushover dashboard.
Your api_key
is specific to the Pushover application you would like to have the script send the notification through. Click on the application’s settings to retrieve the key.
pushbullet¶
To enable Pushbullet integration, simply set the token
setting with valid credentials:
Notifications:
enabled: yes
notify_name: My Custom Name
pushbullet:
token: gNJccqGqISParIqHcvRy
Your token
can be found in your Pushbullet account settings.
EM Media Handler does not yet support specifying a device or channel to send Pushbullet notifications to.
TV and Movies¶
TV and Movies both use Filebot and are the only media type modules enabled “out of the box”. Their settings are identical in function, which is why they are grouped together in this guide, but they are unique in execution to their respective type.
Default section and values:
TV:
enabled: yes
folder:
ignore_subs: yes
format: "{n}/Season {s}/{n.space('.')}.{'S'+s.pad(2)}E{e.pad(2)}"
log_file:
Movies:
enabled: yes
folder:
ignore_subs: yes
format: "{n} ({y})"
log_file:
enabled¶
Enable or disable processing of media type by mediahandler.
- Valid options:
no
yes
(default)
folder¶
Specify a destination folder for added media files.
TV Default: ~/Media/TV
Movies Default: ~/Media/Movies
ignore_subs¶
Tell Filebot whether or not to process subtitle files along with video files or ignore them.
- Valid options:
no
yes
(default)
format¶
Specify a Filebot naming format. During processing, it will be appended to the media type’s folder
value to form a complete path. See Filebot’s format expressions documentation for more details.
TV Default: "{n}/Season {s}/{n.space('.')}.{'S'+s.pad(2)}E{e.pad(2)}"
Movies Default: "{n} ({y})"
Music¶
The Music media type is integrated with Beets.
Default section and values:
Music:
enabled: no
log_file:
enabled¶
Enable or disable processing of the music media type by mediahandler. Please review the python package and application Installation Requirements before enabling.
- Valid options:
no
(default)yes
Audiobooks¶
The Audiobook media type makes use of the Google Books API for processing. Additionally, creation of chaptered audiobook files (.m4b) is available via integration with the ABC application for Linux.
EM Media Handler does not yet support creation of chaptered audiobook files on OS X.
Default section and values:
Audiobooks:
enabled: no
folder:
api_key:
make_chapters: off
chapter_length: 8
enabled¶
Enable or disable processing of the audiobooks media type by mediahandler. Please review the python package and application Installation Requirements before enabling.
- Valid options:
no
(default)yes
folder¶
Specify a destination folder for added audiobooks.
Audiobooks will be added to the folder in the following format:
~/Media/Audiobooks/<author name>/<full book title>/<shorted book title>.<file extension>
EM Media Handler does not yet support custom renaming formats for Audiobooks.
Default: ~/Media/Audiobooks
api_key¶
A valid Google API key. To obtain one, you will need to:
Visit the Google API Console.
Create a new project (you can keep the default values that Google provides).
When your project is created, click on the “Enable an API” button on the Project Dashboard.
Scroll to the “Books API” and click on the “Off” button next to it on the right to activate.
In the left-hand menu, click on the “Credentials” option under “APIs & auth”
Click on the “Create new Key” button under “Public API access”.
Select “Server key”.
(Optional) Specify your server’s IP for greater security.
Copy & paste the generated “API KEY” into the
api_key
setting in your configuration file, e.g.Audiobooks: enabled: yes folder: /my/path/to/books api_key: kKCRCNNsbrfWkohKpxwq make_chapters: on chapter_length: 8
make_chapters¶
Enable or disable creation of chaptered audiobook files (.m4b) using the ABC application for Linux. Visit the Installation Requirements section for information on installation.
EM Media Handler does not yet support creation of chaptered audiobook files on OS X.
- Values:
off
(default)on
chapter_length¶
Specify, in hours, the maximum length each audiobook file (.m4b) created by ABC should be. For audiobooks that have a running time longer than the specified length, multiple parts will be created, e.g.
~/Media/Audiobooks/Donna Tartt/The Goldfinch_ A Novel/The Goldfinch, Part 1.m4b
~/Media/Audiobooks/Donna Tartt/The Goldfinch_ A Novel/The Goldfinch, Part 2.m4b
~/Media/Audiobooks/Donna Tartt/The Goldfinch_ A Novel/The Goldfinch, Part 3.m4b
Default: 8
(hours)