forked from chazlarson/Media-Scripts
-
Notifications
You must be signed in to change notification settings - Fork 1
/
.env.example
115 lines (101 loc) · 8.04 KB
/
.env.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
# PLEX API ENV VARS
PLEXAPI_PLEXAPI_TIMEOUT='360'
PLEXAPI_AUTH_SERVER_BASEURL=https://plex.domain.tld
# Just the base URL, no /web or anything at the end.
# i.e. http://192.168.1.11:32400 or the like
PLEXAPI_AUTH_SERVER_TOKEN=PLEX-TOKEN
PLEXAPI_LOG_BACKUP_COUNT='3'
PLEXAPI_LOG_FORMAT='%(asctime)s %(module)12s:%(lineno)-4s %(levelname)-9s %(message)s' # PLEX API ENV VARS
PLEXAPI_LOG_LEVEL='INFO'
PLEXAPI_LOG_PATH='plexapi.log'
PLEXAPI_LOG_ROTATE_BYTES='512000'
PLEXAPI_LOG_SHOW_SECRETS='false'
PLEXAPI_SKIP_VERIFYSSL='false' # ignore self signed certificate errors
# GENERAL ENV VARS
TMDB_KEY=TMDB_API_KEY # https://developers.themoviedb.org/3/getting-started/introduction
TVDB_KEY=TVDB_V4_API_KEY # currently not used; https://thetvdb.com/api-information
DELAY=1 # optional delay between items
LIBRARY_NAMES=Movies,TV Shows,Movies 4K # comma-separated list of libraries to act on
# IMAGE DOWNLOAD ENV VARS
## what-to-grab
GRAB_SEASONS=1 # should get-all-posters retrieve season posters?
GRAB_EPISODES=1 # should get-all-posters retrieve episode posters? [requires GRAB_SEASONS]
GRAB_BACKGROUNDS=1 # should get-all-posters retrieve backgrounds?
ONLY_CURRENT=0 # should get-all-posters retrieve ONLY current artwork?
ARTWORK=1 # current background is downloaded with current poster
INCLUDE_COLLECTION_ARTWORK=1 # should get-all-posters retrieve collection posters?
ONLY_COLLECTION_ARTWORK=0 # should get-all-posters retrieve ONLY collection posters?
ONLY_THESE_COLLECTIONS=Bing|Bang|Boing # only grab artwork for these collections and items in them
POSTER_DEPTH=20 # grab this many posters [0 grabs all]
KEEP_JUNK=0 # keep files that script would normally delete [incorrect filetypes, mainly]
FIND_OVERLAID_IMAGES=0 # check all downloaded images for overlays
# RETAIN_OVERLAID_IMAGES=0 # keep images that have an overlay EXIF tag [this will override the following two]
RETAIN_KOMETA_OVERLAID_IMAGES=0 # keep images that have the Kometa overlay EXIF tag
RETAIN_TCM_OVERLAID_IMAGES=0 # keep images that have the TCM overlay EXIF tag
## where-to-put-it
USE_ASSET_NAMING=1 # should grab-all-posters name images to match Kometa's Asset Directory requirements?
USE_ASSET_FOLDERS=1 # should those Kometa-Asset-Directory names use asset folders?
USE_ASSET_SUBFOLDERS=0 # create asset folders in subfolders ["Collections", "Other", or [0-9, A-Z]] ]
ASSETS_BY_LIBRARIES=1 # should those Kometa-Asset-Directory images be sorted into library folders?
ASSET_DIR=assets # top-level directory for those Kometa-Asset-Directory images
# if asset-directory naming is on, the next three are ignored
POSTER_DIR=extracted_posters # put downloaded posters here
CURRENT_POSTER_DIR=current_posters # put downloaded current posters and artwork here
POSTER_CONSOLIDATE=0 # if false, posters are separated into folders by library
## tracking
TRACK_URLS=1 # If set to 1, URLS are tracked and won't be downloaded twice
TRACK_COMPLETION=1 # If set to 1, movies/shows are tracked as complete by rating id
TRACK_IMAGE_SOURCES=1 # keep a file containing file names and source URLs
## general
POSTER_DOWNLOAD=1 # if false, generate a script rather than downloading
FOLDERS_ONLY=0 # Just build out the folder hierarchy; no image downloading
DEFAULT_YEARS_BACK=2 # in absence of a "last run date", grab things added this many years back.
# 0 sets the fallback date to the beginning of time
THREADED_DOWNLOADS=0 # should downloads be done in the background in threads?
RESET_LIBRARIES=Bing,Bang,Boing # reset "last time" count to the fallback date for these libraries
RESET_COLLECTIONS=Bing,Bang,Boing # CURRENTLY UNUSED
ADD_SOURCE_EXIF_COMMENT=1 # CURRENTLY UNUSED
# STATUS ENV VARS
PLEX_OWNER=yournamehere # account name of the server owner
TARGET_PLEX_URL=https://plex.domain2.tld # As above, the target of apply_all_status
TARGET_PLEX_TOKEN=PLEX-TOKEN-TWO # As above, the target of apply_all_status
TARGET_PLEX_OWNER=yournamehere # As above, the target of apply_all_status
LIBRARY_MAP={"LIBRARY_ON_PLEX":"LIBRARY_ON_TARGET_PLEX", ...}
# In apply_all_status, map libraries according to this JSON.
# RESET-POSTERS ENV VARS
TRACK_RESET_STATUS=1 # should reset-posters-* keep track of status and pick up where it left off?
LOCAL_RESET_ARCHIVE=1 # should reset-posters-tmdb keep a local archive of posters?
TARGET_LABELS=this label, that label # comma-separated list of labels to reset posters on
REMOVE_LABELS=0 # attempt to remove the TARGET_LABELs from items after resetting the poster
RESET_SEASONS=1 # reset-posters-* resets season artwork as well in TV libraries
RESET_EPISODES=1 # reset-posters-* resets episode artwork as well in TV libraries [requires RESET_SEASONS=True]
RETAIN_RESET_STATUS_FILE=0 # Don't delete the reset progress file at the end
FLUSH_STATUS_AT_START=0 # Delete the reset progress file at the start instead of reading it
RESET_SEASONS_WITH_SERIES=0 # If there isn't a season poster, use the series poster
DRY_RUN=0 # [currently only works with reset-posters-*]; don't actually do anything, just log
# LIST ITEM IDS ENV VARS
INCLUDE_COLLECTION_MEMBERS=0
ONLY_COLLECTION_MEMBERS=0
# DELETE_COLLECTION ENV VARS
KEEP_COLLECTIONS=bing,bang # List of collections to keep
# REMATCH-ITEMS ENV VARS
UNMATCHED_ONLY=1 # If 1, only rematch things that are currently unmatched
# RESET_ADDED_AT
ADJUST_DATE_FUTURES_ONLY=0 # Only look at items that show up as added in the future
ADJUST_DATE_EPOCH_ONLY=1 # Only adjust items that have "originally available" dates of `1970-01-01`
# REFRESH_METADATA
REFRESH_1970_ONLY=1 # If 1, only refresh things that have an originally-available date of 1970-01-01
# ACTOR ENV VARS
CAST_DEPTH=20 # how deep to go into the cast for actor collections
TOP_COUNT=10 # how many actors to export
JOB_TYPE=Actor # Actor or Director
KNOWN_FOR_ONLY=0 # ignore cast members who are not primarily known as JOBTYPE
BUILD_COLLECTIONS=0 # build yaml for Kometa config.yml
NUM_COLLECTIONS=20 # this many actors in Kometa yaml
TRACK_GENDER=1 # Pay attention to actor gender [as recorded on TMDB]
MIN_GENDER_NONE=5 # include minimum this many "none" gendered actors in the YAML, if possible
MIN_GENDER_FEMALE=5 # include minimum this many "female" gendered actors in the YAML, if possible
MIN_GENDER_MALE=5 # include minimum this many "male" gendered actors in the YAML, if possible
MIN_GENDER_NB=5 # include minimum this many "non-binary" gendered actors in the YAML, if possible
# LOW POSTER COUNT
POSTER_THRESHOLD=10