From 07d5af9dfb19c787ecaf303a2747f137548b1cf3 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Sun, 7 Apr 2024 16:09:04 +0200 Subject: [PATCH] Move from config.ini to config.yaml, warn about user setting loss --- conf/config.ini | 205 -------------------------- conf/config.yaml | 239 +++++++++++++++++++++++++++++++ doc/POST_UPGRADE.d/1.4.0~ynh1.md | 4 + scripts/install | 6 +- scripts/upgrade | 19 +-- 5 files changed, 257 insertions(+), 216 deletions(-) delete mode 100644 conf/config.ini create mode 100644 conf/config.yaml create mode 100644 doc/POST_UPGRADE.d/1.4.0~ynh1.md diff --git a/conf/config.ini b/conf/config.ini deleted file mode 100644 index 95af563..0000000 --- a/conf/config.ini +++ /dev/null @@ -1,205 +0,0 @@ -[general] -ip = 127.0.0.1 -port = __PORT__ -base_url = __PATH__ -path_mappings = [] -debug = False -branch = master -auto_update = False -single_language = False -minimum_score = 90 -use_scenename = True -use_postprocessing = False -postprocessing_cmd = -postprocessing_threshold = 90 -use_postprocessing_threshold = False -postprocessing_threshold_movie = 70 -use_postprocessing_threshold_movie = False -use_sonarr = __SONARR_INSTALLED__ -use_radarr = __RADARR_INSTALLED__ -path_mappings_movie = [] -serie_default_enabled = False -serie_default_profile = -movie_default_enabled = False -movie_default_profile = -page_size = 25 -page_size_manual_search = 10 -minimum_score_movie = 70 -use_embedded_subs = True -embedded_subs_show_desired = True -utf8_encode = True -ignore_pgs_subs = False -ignore_vobsub_subs = False -ignore_ass_subs = False -adaptive_searching = False -enabled_providers = [] -multithreading = True -chmod_enabled = False -chmod = 0640 -subfolder = current -subfolder_custom = -upgrade_subs = True -upgrade_frequency = 12 -days_to_upgrade_subs = 7 -upgrade_manual = True -anti_captcha_provider = None -wanted_search_frequency = 3 -wanted_search_frequency_movie = 3 -subzero_mods = [] -dont_notify_manual_actions = False -flask_secret_key = __FLASK_KEY__ - -[auth] -type = None -username = -password = -apikey = __API_KEY__ - -[sonarr] -ip = 127.0.0.1 -port = __SONARR_PORT__ -base_url = __SONARR_PATH__ -ssl = False -apikey = __SONARR_API_KEY__ -full_update = Daily -full_update_day = 6 -full_update_hour = 4 -only_monitored = False -series_sync = 60 -episodes_sync = 60 -excluded_tags = [] -excluded_series_types = [] -use_ffprobe_cache = True - -[radarr] -ip = 127.0.0.1 -port = __RADARR_PORT__ -base_url = __RADARR_PATH__ -ssl = False -apikey = __RADARR_API_KEY__ -full_update = Daily -full_update_day = 6 -full_update_hour = 5 -only_monitored = False -movies_sync = 60 -excluded_tags = [] -use_ffprobe_cache = True - -[proxy] -type = None -url = -port = -username = -password = -exclude = ["localhost","127.0.0.1"] - -[opensubtitles] -username = -password = -use_tag_search = False -vip = False -ssl = False -timeout = 15 -skip_wrong_fps = False - -[opensubtitlescom] -username = -password = -use_hash = True - -[addic7ed] -username = -password = - -[podnapisi] -verify_ssl = True - -[legendasdivx] -username = -password = -skip_wrong_fps = False - -[ktuvit] -email = -hashed_password = - -[legendastv] -username = -password = -featured_only = False - -[xsubs] -username = -password = - -[assrt] -token = - -[anticaptcha] -anti_captcha_key = - -[deathbycaptcha] -username = -password = - -[napisy24] -username = -password = - -[subscene] -username = -password = - -[betaseries] -token = - -[analytics] -enabled = True - -[titlovi] -username = -password = - -[titulky] -username = -password = -skip_wrong_fps = False -approved_only = False -multithreading = True - -[subsync] -use_subsync = False -use_subsync_threshold = False -subsync_threshold = 90 -use_subsync_movie_threshold = False -subsync_movie_threshold = 70 -debug = False - -[series_scores] -hash = 359 -series = 180 -year = 90 -season = 30 -episode = 30 -release_group = 15 -source = 7 -audio_codec = 3 -resolution = 2 -video_codec = 2 -hearing_impaired = 1 -streaming_service = 0 -edition = 0 - -[movie_scores] -hash = 119 -title = 60 -year = 30 -release_group = 15 -source = 7 -audio_codec = 3 -resolution = 2 -video_codec = 2 -hearing_impaired = 1 -streaming_service = 0 -edition = 0 - diff --git a/conf/config.yaml b/conf/config.yaml new file mode 100644 index 0000000..20d2481 --- /dev/null +++ b/conf/config.yaml @@ -0,0 +1,239 @@ +--- +addic7ed: + cookies: '' + password: '' + user_agent: '' + username: '' + vip: false +analytics: + enabled: false +anticaptcha: + anti_captcha_key: '' +assrt: + token: '' +auth: + apikey: __API_KEY__ + password: '' + type: null + username: '' +backup: + day: 6 + folder: /var/www/bazarr/data/backup + frequency: Manually + hour: 3 + retention: 31 +betaseries: + token: '' +cors: + enabled: false +deathbycaptcha: + password: '' + username: '' +embeddedsubtitles: + hi_fallback: false + included_codecs: [] + timeout: 600 + unknown_as_english: false +general: + adaptive_searching: true + adaptive_searching_delay: 3w + adaptive_searching_delta: 1w + anti_captcha_provider: null + auto_update: true + base_url: __PATH__ + branch: master + chmod: '0640' + chmod_enabled: false + days_to_upgrade_subs: 7 + debug: false + default_und_audio_lang: '' + default_und_embedded_subtitles_lang: '' + dont_notify_manual_actions: false + embedded_subs_show_desired: true + embedded_subtitles_parser: ffprobe + enabled_providers: [] + flask_secret_key: __FLASK_KEY__ + hi_extension: hi + ignore_ass_subs: false + ignore_pgs_subs: false + ignore_vobsub_subs: false + ip: 127.0.0.1 + language_equals: [] + minimum_score: 90 + minimum_score_movie: 70 + movie_default_enabled: false + movie_default_profile: '' + multithreading: true + page_size: 25 + parse_embedded_audio_track: false + path_mappings: [] + path_mappings_movie: [] + port: __PORT__ + postprocessing_cmd: '' + postprocessing_threshold: 90 + postprocessing_threshold_movie: 70 + serie_default_enabled: false + serie_default_profile: '' + single_language: false + skip_hashing: false + subfolder: current + subfolder_custom: '' + subzero_mods: '' + theme: auto + upgrade_frequency: 12 + upgrade_manual: true + upgrade_subs: true + use_embedded_subs: true + use_postprocessing: false + use_postprocessing_threshold: false + use_postprocessing_threshold_movie: false + use_radarr: false + use_scenename: true + use_sonarr: false + utf8_encode: true + wanted_search_frequency: 6 + wanted_search_frequency_movie: 6 +hdbits: + passkey: '' + username: '' +karagarga: + f_password: '' + f_username: '' + password: '' + username: '' +ktuvit: + email: '' + hashed_password: '' +legendasdivx: + password: '' + skip_wrong_fps: false + username: '' +movie_scores: + audio_codec: 3 + edition: 1 + hash: 119 + hearing_impaired: 1 + release_group: 13 + resolution: 2 + source: 7 + streaming_service: 1 + title: 60 + video_codec: 2 + year: 30 +napisy24: + password: '' + username: '' +opensubtitles: + password: '' + skip_wrong_fps: false + ssl: false + timeout: 15 + use_tag_search: false + username: '' + vip: false +opensubtitlescom: + include_ai_translated: false + password: '' + use_hash: true + username: '' +podnapisi: + verify_ssl: true +postgresql: + database: '' + enabled: false + host: localhost + password: '' + port: 5432 + username: '' +proxy: + exclude: + - localhost + - 127.0.0.1 + password: '' + port: '' + type: null + url: '' + username: '' +radarr: + apikey: '__RADARR_API_KEY__' + base_url: __RADARR_PATH__ + defer_search_signalr: false + excluded_tags: [] + full_update: Daily + full_update_day: 6 + full_update_hour: 4 + http_timeout: 60 + ip: 127.0.0.1 + movies_sync: 60 + only_monitored: false + port: __RADARR_PORT__ + ssl: false + sync_only_monitored_movies: false + use_ffprobe_cache: true +series_scores: + audio_codec: 3 + episode: 30 + hash: 359 + hearing_impaired: 1 + release_group: 14 + resolution: 2 + season: 30 + series: 180 + source: 7 + streaming_service: 1 + video_codec: 2 + year: 90 +sonarr: + apikey: '__SONARR_API_KEY__' + base_url: __SONARR_PATH__ + defer_search_signalr: false + exclude_season_zero: false + excluded_series_types: [] + excluded_tags: [] + full_update: Daily + full_update_day: 6 + full_update_hour: 4 + http_timeout: 60 + ip: 127.0.0.1 + only_monitored: false + port: __SONARR_PORT__ + series_sync: 60 + ssl: false + sync_only_monitored_episodes: false + sync_only_monitored_series: false + use_ffprobe_cache: true +subf2m: + user_agent: '' + verify_ssl: true +subscene: + password: '' + username: '' +subsync: + checker: + blacklisted_languages: [] + blacklisted_providers: [] + debug: false + force_audio: false + gss: true + max_offset_seconds: 60 + no_fix_framerate: true + subsync_movie_threshold: 70 + subsync_threshold: 90 + use_subsync: false + use_subsync_movie_threshold: false + use_subsync_threshold: false +titlovi: + password: '' + username: '' +titulky: + approved_only: false + password: '' + username: '' +whisperai: + endpoint: http://127.0.0.1:9000 + loglevel: INFO + response: 5 + timeout: 3600 +xsubs: + password: '' + username: '' diff --git a/doc/POST_UPGRADE.d/1.4.0~ynh1.md b/doc/POST_UPGRADE.d/1.4.0~ynh1.md new file mode 100644 index 0000000..bcc28d8 --- /dev/null +++ b/doc/POST_UPGRADE.d/1.4.0~ynh1.md @@ -0,0 +1,4 @@ +Bazarr v1.4.0 has changed its configuration from ini to yaml format, forcing us to reset it. +Since this configuration file holds both the app's core settings but also your user settings, they will be unfortunately be reset too. + +Sorry for the inconvenience! This will happen only this one time, hopefully. diff --git a/scripts/install b/scripts/install index 036bfaa..7ec66d1 100755 --- a/scripts/install +++ b/scripts/install @@ -77,10 +77,10 @@ ynh_app_setting_set --app=$app --key=flask_key --value=$flask_key api_key=$(ynh_string_random --length=32) ynh_app_setting_set --app=$app --key=api_key --value=$api_key -ynh_add_config --template="config.ini" --destination="$install_dir/data/config/config.ini" +ynh_add_config --template="config.yaml" --destination="$install_dir/data/config/config.yaml" -chmod 660 "$install_dir/data/config/config.ini" -chown $app: "$install_dir/data/config/config.ini" +chmod 660 "$install_dir/data/config/config.yaml" +chown $app: "$install_dir/data/config/config.yaml" #================================================= # YUNOHOST MULTIMEDIA INTEGRATION diff --git a/scripts/upgrade b/scripts/upgrade index 33fc8ae..d2ad21f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -79,22 +79,25 @@ yunohost service add $app --description="Subtitle downloader for Radarr and Sona #REMOVEME? ynh_script_progression --message="Upgrading Bazarr and its dependencies..." --weight=5 pushd $install_dir - # Initialize virtual environment - ynh_exec_as $app python${python_major_version} -m venv venv + # Initialize virtual environment + ynh_exec_as $app python${python_major_version} -m venv venv - ynh_exec_as $app $install_dir/venv/bin/pip install -r "$install_dir/requirements.txt" + ynh_exec_as $app $install_dir/venv/bin/pip install -r "$install_dir/requirements.txt" popd #================================================= # UPDATE A CONFIG FILE #================================================= #FIXME: Find a way not to override all settings while upgrading the config file. -#ynh_script_progression --message="Updating a configuration file..." --weight=1 +#FIXME: This is done once after v1.4.0 that changed the config file from .ini to .yaml format +if ynh_compare_current_package_version --comparison lt --version 1.4.0~ynh1 +then + ynh_script_progression --message="Updating a configuration file..." --weight=1 + ynh_add_config --template="config.yaml" --destination="$install_dir/data/config/config.yaml" +fi -#ynh_add_config --template="config.ini" --destination="$install_dir/data/config/config.ini" - -#chmod 660 "$install_dir/data/config/config.ini" -#chown $app: "$install_dir/data/config/config.ini" +chmod 660 "$install_dir/data/config/config.yaml" +chown $app: "$install_dir/data/config/config.yaml" #================================================= # YUNOHOST MULTIMEDIA INTEGRATION