configuration overview - panuozzo77/StreamingCommunity GitHub Wiki

Configuration Overview

This guide provides a comprehensive overview of the configuration options available in StreamingCommunity. The application uses a JSON configuration file that allows you to customize various aspects of its behavior, from basic settings to advanced download options.

Configuration File Location

The configuration file (config.json) is located in the root directory of the StreamingCommunity installation. When using the application for the first time, a default configuration file is created automatically.

Configuration Sections

The configuration file is organized into several sections, each controlling different aspects of the application:

  1. DEFAULT Settings: Core application behavior and general settings
  2. OUT_FOLDER Settings: Directory structure and naming conventions for downloaded content
  3. QBIT_CONFIG Settings: qBittorrent integration for torrent downloads
  4. REQUESTS Settings: Network request configuration
  5. M3U8_DOWNLOAD Settings: Options for downloading HLS content
  6. M3U8_CONVERSION Settings: Media conversion and encoding options
  7. M3U8_PARSER Settings: HLS playlist parsing options
  8. SITE_EXTRA Settings: Site-specific configuration options

Modifying Configuration

You can modify the configuration in several ways:

1. Directly Editing the JSON File

Open config.json in any text editor and modify the values as needed. Make sure to maintain valid JSON syntax.

Example config.json:

{
    "DEFAULT": {
        "debug": false,
        "show_message": true,
        "clean_console": true,
        "show_trending": true,
        "use_api": true,
        "not_close": false,
        "telegram_bot": false,
        "download_site_data": false,
        "validate_github_config": false
    },
    "OUT_FOLDER": {
        "root_path": "Video",
        "movie_folder_name": "Movie",
        "serie_folder_name": "Serie",
        "anime_folder_name": "Anime",
        "map_episode_name": "E%(episode)_%(episode_name)",
        "add_siteName": false
    },
    // Other sections...
}

2. Using Command Line Arguments

Many configuration options can be overridden using command line arguments when running the application:

python test_run.py --not_close true --default_video_worker 8 --specific_list_audio ita,eng

3. Programmatically

If you're using StreamingCommunity as a library in your own Python code, you can modify the configuration programmatically:

from StreamingCommunity.Util.config_json import config_manager

# Get a configuration value
debug_mode = config_manager.get_bool('DEFAULT', 'debug')

# Set a configuration value
config_manager.set_key('DEFAULT', 'debug', True)
config_manager.save_config()

Configuration Inheritance

When using Docker, the configuration file is mounted from your host system to the container, allowing you to make changes without rebuilding the image.

Resetting to Default Configuration

If you need to reset to the default configuration:

  1. Delete or rename the existing config.json file
  2. Restart the application, which will generate a new default configuration file

Next Steps

Explore each configuration section in detail:

⚠️ **GitHub.com Fallback** ⚠️