List of Settings

This is a full list of all RMD settings, their types, and their default values. They are sorted by category.

To see more details about commonly-used settings, check out the Settings & Arguments page.

Auth

  • refresh_token
    • Description: Use this to safely authorize RMD to read your Reddit account.
    • Expected Type: str
    • Default value: [blank]
  • user_agent
    • Description: The user agent to identify as, wherever possible.
    • Expected Type: str
    • Default value: [Unique ID]

Output

  • base_dir
    • Description: The base directory to save to. Cannot contain tags.
    • Expected Type: str
    • Default value: [Path to RMD Directory]
  • manifest
    • Description: Path to the output manifest file, relative to the base download directory. Cannot contain tags.
    • Expected Type: str
    • Default value: ./manifest.sqlite
  • file_name_pattern
    • Description: The ouput file name/path. Supports tags.
    • Expected Type: str
    • Default value: [subreddit]/[title] - ([author])

Processing

  • deduplicate_files
    • Description: Remove downloaded files if another copy already exists. Also compares images for visual similarity.
    • Expected Type: bool
    • Default value: True
  • retry_failed
    • Description: Retry downloads that have failed in previous runs.
    • Expected Type: bool
    • Default value: True

Threading

  • concurrent_downloads
    • Description: How many threads can download media at once.
    • Expected Type: int
    • Default value: 5
  • console_clear_screen
    • Description: If it's okay to clear the terminal while running.
    • Expected Type: bool
    • Default value: True
  • display_refresh_rate
    • Description: How often the UI should update progress, in seconds.
    • Expected Type: int
    • Default value: 5

Interface

  • start_server
    • Description: If the WebUI should be available.
    • Expected Type: bool
    • Default value: True
  • browser
    • Description: Browser to auto-open UI in.
    • Expected Type: str
    • Default value: chrome-app
    • Options:
      • chrome-app - Chrome Application Mode (recommended)
      • default browser - The default system browser
      • off - Don't auto-open a browser
  • keep_open
    • Description: If True, the WebUI will stay available after the browser closes.
    • Expected Type: bool
    • Default value: False
  • port
    • Description: The port to open the WebUI on.
    • Expected Type: int
    • Default value: 7505
  • host
    • Description: The host to bind on.
    • Expected Type: str
    • Default value: localhost

Imgur

  • client_id
    • Description: The API client ID to use when accessing private Imgur albums.
    • Expected Type: str
    • Default value: [blank]
  • client_secret
    • Description: The API client secret to use when accessing private Imgur albums.
    • Expected Type: str
    • Default value: [blank]