Command Line Arguments

Command Line Arguments and Docker Environmental Variables

Command Line Arguments	Environmental Variables	Data Type	Description	Example Values	Required	Additional Information
-brand, -server_brand	BRAND, SERVER_BRAND	string	Specify server brand	'emby', 'jellyfin'	No	link
-url, -server_url	URL, SERVER_URL	string	Specify server IP address or FQDN	'http://192.168.1.234:8096', 'http://localhost.com:8096/emby'	No	link
-admin_username	ADMIN_USERNAME	string	Specify admin user's username	'admin_username0'	No	-
-password,-admin_password	PASSWORD, ADMIN_PASSWORD	string	Specify admin user's password	'admin_p@s5w0Rd!'	No	-
-authkey,-server_auth_key	AUTHKEY, SERVER_AUTH_KEY	string	Specify a server authentication key (i.e. API key); if specified -admin_username and -admin_password are ignored	'abcdef0123456789abcdef0123456789'	No	link
-adminid, -server_admin_id	ADMINID, SERVER_ADMIN_ID	string	Specify the admin user's identification number	'abcdef01234567899876543210fedcba'	No	link
-lstbeh, -list_behavior	LSTBEH, LIST_BEHAVIOR	string	Specify blacklist or whitelist behavior when choosing libraries	'blacklist', 'whitelist'	No	link
-matbeh, -matching_behavior	MATBEH, MATCHING_BEHAVIOR	string	Specify how media items will be matched to libraries	'byId', 'byPath', 'byNetworkPath'	No	link
-blacktags, -global_blacktags	BLACKTAGS, GLOBAL_BLACKTAGS	string (commas separate multiple tags)	Specify global blacktags	'tag0,tag1,tag2,etc...'	No	link
-whitetags, -global_whitetags	WHITETAGS, GLOBAL_WHITETAGS	string (commas separate multiple tags)	Specify global whitetags	'tag0,tag1,tag2,etc...'	No	link
-disusrs, -monitor_disabled_users	DISUSRS, MONITOR_DISABLED_USERS	boolean	Specify whether disable users are monitored	True, False	No	link
-libsel ,-user_library_selection	LIBSEL, USER_LIBRARY_SELECTION	integer	Specify which library selection method is used	0, 1, 2, 3	No	link
-rdurl, -radarr_url	RDURL, RADARR_URL	string (commas separate multiple URLs)	Specify IP address or FQDN for Radarr	'http://192.168.1.234:7878,http://localhost.com:7878/radarr,etc...'	No	link
-rdapi, -radarr_api_key	RDAPI, RADARR_API_KEY	string (commas separate multiple API keys)	Specify API key for Radarr	'0123456789fedcbaabcdef9876543210,1123456789fedcbaabcdef9876543211,etc...'	No	link
-snurl, -sonarr_url	SNURL, SONARR_URL	string (commas separate multiple URLs)	Specify IP address or FQDN for Radarr	'http://192.168.1.234:8989,http://localhost.com:8989/sonarr,etc...'	No	link
-snapi, -sonarr_api_key	SNAPI, SONARR_API_KEY	string (commas separate multiple API keys)	Specify API key for Radarr	'9876543210abcdeffedbca0123456789,8876543210abcdeffedbca0123456788,etc...'	No	link
-a, -attrs, -attributes	A, ATTRS, ATTRIBUTES	boolean	Show console attribute test output; will override all other options, except -h	True, False	No	-
-c, -config	-	string	Specify alternate *.yaml configuration file. Do NOT use this in Docker; instead use -v to mount a config file from the host into the container.	'/path/to/your/config.yaml', 'c:\path\to\your\config.yaml'	No	-
-u, -config_updater	U, CONFIG_UPDATER	boolean	Modify configuration by editing users and their libraries; will override all other options, except -h and -a	True, False	No	link
-	TZ	string	Specify a timezone	-	Yes	link
-h, -help, -?	-	-	Show the help menu; will override all other options	-	No	-

Command Line Usage

/path/to/python3.x /path/to/mumc.py -option [arg] -option [arg] -etc [etc]...

Docker Environmental Variable Usage

docker run --rm -it --name mumc \
-v '/opt/MUMC/config/mumc_config.yaml:/usr/src/app/config/mumc_config.yaml' \
-v '/opt/MUMC/logs/mumc_DEBUG.log:/usr/src/app/logs/mumc_DEBUG.log' \
-e ENV=[arg] \
-e ENV=[arg] \
-e ETC=[etc]... \
ghcr.io/terrelsa13/mumc:latest

Docker Compose Environmental Variable Usage

services:
   mumc:
      container_name: 'mumc'
      image: ghcr.io/terrelsa13/mumc:latest
      environment:
         ENV: [arg]
         ENV: [arg]
         ETC: [etc]
         ...
      volumes:
         - '/opt/MUMC/config/mumc_config.yaml:/usr/src/app/config/mumc_config.yaml'
         - '/opt/MUMC/logs/mumc_DEBUG.log:/usr/src/app/logs/mumc_DEBUG.log'
      stdin_open: true
      tty: true

Command Line Argument Priority vs Environmental Variable Priority

• mumc_config.yaml will overwrite command line arguments
• command line arguments will overwrite environmental variables

When To Use Command Line Arguments and Environmental Variables

• With the exception of -a, -c, -u, and -h; command line arguments and environmental variables are not meant to be used during "normal" runtime.
• Command line arguments and environmental variables are meant to aide the configuration file building process.
  • Any optional Command line arguments or environmental variables that are omitted will require manual input during the configuration file building process.

Additional Information - MUMC extras.