All Configuration Keys

In a nutshell

This is the full, auto-generated table of every key in the shipped mycroft.conf, with defaults and descriptions where available. Use this page to look up one specific key. For a curated, task-oriented walkthrough of the main settings, see Configuration Reference.

---

Known wrong upstream description

The descriptions below reproduce the shipped mycroft.conf comments, and one of those comments is wrong: listener.fake_barge_in lowers playback volume to listener.barge_in_volume (default 30, not listed below because the shipped config omits it) and restores it afterwards. It never mutes. See Configuration Reference for the corrected wording.

All Keys (Generated)

Blank Description cells

A blank cell in the table below means the generator could not pull a description for that key from the upstream source, usually because the shipped default config has no accompanying comment there. It does not mean the key is unsupported. Most of these are self-explanatory from the key path and default value (for example, sounds.error, location.city.name). For anything non-obvious, check the linked source or grep the relevant repo for where the key is read.

Telemetry keys are intentionally absent

share_telemetry and share_usage_telemetry do not appear below because they are installer-time prompts, not mycroft.conf keys. See ovos-installer's telemetry section for what each one does and where it's actually stored.

(top level)

Key	Default	Description
lang	"en-US"	Primary BCP-47 language code for STT and TTS.
secondary_langs	[]	Extra languages whose resource files are loaded. Intents are only matched when the utterance is tagged with that lang at STT.
system_unit	"metric"	Measurement units (metric or imperial).
temperature_unit	"celsius"	Temperature units (celsius or fahrenheit).
windspeed_unit	"m/s"	Windspeed units, either 'km/h', 'm/s', 'mph' or 'kn' (knots)
precipitation_unit	"mm"	Precipitation units, either 'mm' or 'inch'
time_format	"half"	Clock format for display (half = 12-hour, full = 24-hour).
spoken_time_format	"full"
date_format	"MDY"	Date format for display and parsing.
confirm_listening	true	Play a beep when the system starts listening.
metadata_transformers	{}
ignore_logs	["enclosure.mouth.viseme", "enclosure.mouth.display"]
enable_old_audioservice	true
debug	false

open_data

Key	Default	Description
open_data.intent_urls	[]	URLs of opt-in open-data collection servers to send anonymized intent matches to. Empty by default. See Privacy & Security.

sounds

Key	Default	Description
sounds.start_listening	"snd/start_listening.wav"	Earcon confirming the wake word was heard and recording started. Only plays when confirm_listening is true.
sounds.end_listening	"snd/end_listening.wav"	Earcon confirming recording stopped and the utterance was captured.
sounds.acknowledge	"snd/acknowledge.mp3"	Earcon a skill plays via self.acknowledge() to confirm a request that produces no spoken reply. Also the default for the skill installer's pip_success.
sounds.error	"snd/error.mp3"	Earcon played when no skill or pipeline could handle the utterance (complete intent failure). Also the default for the skill installer's pip_error.

location

Key	Default	Description
location.city.code	"Lawrence"
location.city.name	"Lawrence"
location.city.state.code	"KS"
location.city.state.name	"Kansas"
location.city.state.country.code	"US"
location.city.state.country.name	"United States"
location.coordinate.latitude	38.971669
location.coordinate.longitude	-95.23525
location.timezone.code	"America/Chicago"
location.timezone.name	"Central Standard Time"
location.timezone.dstOffset	3600000
location.timezone.offset	-21600000

utterance_transformers

Key	Default	Description
utterance_transformers.ovos-utterance-normalizer	{}
utterance_transformers.ovos-utterance-plugin-cancel	{}
utterance_transformers.ovos-utterance-corrections-plugin	{}

typed_slots_transformers

Key	Default	Description
typed_slots_transformers.ovos-typed-slots-transformer	{}

intent_transformers

Key	Default	Description
intent_transformers.ovos-keyword-template-matcher	{}
intent_transformers.ovos-ahocorasick-ner-plugin	{}

intents

Key	Default	Description
intents.ovos-adapt-pipeline-plugin.conf_high	0.65
intents.ovos-adapt-pipeline-plugin.conf_med	0.45
intents.ovos-adapt-pipeline-plugin.conf_low	0.25
intents.ovos-padatious-pipeline-plugin.conf_high	0.95
intents.ovos-padatious-pipeline-plugin.conf_med	0.8
intents.ovos-padatious-pipeline-plugin.conf_low	0.5
intents.ovos-padatious-pipeline-plugin.stem	false
intents.ovos-padatious-pipeline-plugin.cast_to_ascii	false
intents.ovos-padatious-pipeline-plugin.disable_padaos	false
intents.ovos-padatious-pipeline-plugin.domain_engine	false
intents.ovos-padatious-pipeline-plugin.single_thread	true
intents.ovos-common-query-pipeline-plugin.max_response_wait	6
intents.ovos-common-query-pipeline-plugin.extension_time	3
intents.ovos-common-query-pipeline-plugin.reranker	"ovos-flashrank-reranker-plugin"
intents.ovos-ocp-pipeline-plugin.legacy	false
intents.ovos-ocp-pipeline-plugin.min_score	40
intents.ovos-ocp-pipeline-plugin.filter_media	true
intents.ovos-ocp-pipeline-plugin.filter_SEI	true
intents.ovos-ocp-pipeline-plugin.playback_mode	0
intents.ovos-ocp-pipeline-plugin.search_fallback	true
intents.pipeline	["ovos-stop-pipeline-plugin-high", "ovos-converse-pipeline-plugin", "ovos-ocp-pipeline-plugin-high", "ovos-padatious-pipeline-plugin-high", "ovos-adapt-pipeline-plugin-high", "ovos-m2v-pipeline-high", "ovos-ocp-pipeline-plugin-medium", "ovos-fallback-pipeline-plugin-high", "ovos-stop-pipeline-plugin-medium", "ovos-padatious-pipeline-plugin-medium", "ovos-adapt-pipeline-plugin-medium", "ovos-fallback-pipeline-plugin-medium", "ovos-fallback-pipeline-plugin-low"]

skills

Key	Default	Description
skills.blacklisted_skills	["skill-ovos-stop.openvoiceos"]
skills.fallbacks.fallback_priorities	{}
skills.fallbacks.fallback_mode	"accept_all"
skills.fallbacks.fallback_whitelist	[]
skills.fallbacks.fallback_blacklist	[]
skills.converse.timeout	300
skills.converse.skill_timeouts	{}
skills.converse.converse_mode	"accept_all"
skills.converse.converse_whitelist	[]
skills.converse.converse_blacklist	[]
skills.converse.converse_activation	"accept_all"
skills.converse.max_activations	-1
skills.converse.skill_activations	{}
skills.converse.cross_activation	true
skills.converse.cross_deactivation	true	Unused. Nothing in ovos-core reads this key. Deactivation permission is gated by cross_activation, and the shipped config marks skill deactivation as not implemented.
skills.converse.converse_priorities	{}

system

Key	Default	Description
system.disable_user_config	false
system.protected_keys.user	[]
system.protected_keys.assistant	[]

websocket

Key	Default	Description
websocket.host	"127.0.0.1"
websocket.port	8181
websocket.route	"/core"
websocket.ssl	false
websocket.shared_connection	true
websocket.max_msg_size	25

gui_websocket

Key	Default	Description
gui_websocket.host	"127.0.0.1"	Bound to 127.0.0.1 by default. Remote display clients require widening this to 0.0.0.0, which exposes the socket to the whole network. See Bus Service for network-exposure guidance.
gui_websocket.base_port	18181
gui_websocket.route	"/gui"
gui_websocket.ssl	false

network_tests

Key	Default	Description
network_tests.ip_url	"https://api.ipify.org"
network_tests.dns_primary	"1.1.1.1"
network_tests.dns_secondary	"8.8.8.8"
network_tests.web_url	"http://nmcheck.gnome.org/check_network_status.txt"
network_tests.web_url_secondary	"https://checkonline.home-assistant.io/online.txt"
network_tests.captive_portal_url	"http://nmcheck.gnome.org/check_network_status.txt"
network_tests.captive_portal_text	"NetworkManager is online"

listener

Key	Default	Description
listener.sample_rate	16000	Audio sampling rate in Hz.
listener.fake_barge_in	true	Lower playback volume during recording, restored afterward. It does not mute.
listener.speech_begin	0.3	Seconds of detected speech before a command is considered started.
listener.silence_end	0.7	Seconds of silence before a command is considered ended.
listener.recording_timeout	10.0	Max seconds for a single recording.
listener.utterance_chunks_to_rewind	2
listener.wakeword_chunks_to_save	15
listener.record_wake_words	false
listener.save_utterances	false
listener.utterance_filename	"{md5}-{uuid4}"
listener.wake_word_upload.disable	true
listener.wake_word_upload.url	""
listener.microphone.module	"ovos-microphone-plugin-alsa"
listener.microphone.ovos-microphone-plugin-alsa.fallback_module	"ovos-microphone-plugin-sounddevice"
listener.microphone.ovos-microphone-plugin-sounddevice.fallback_module	"ovos-microphone-plugin-pyaudio"
listener.remove_silence	true	Strip leading/trailing silence before sending audio to STT.
listener.ww_verifiers.ovos-ww-verifier-silero.threshold	0.1
listener.ww_verifiers.ovos-ww-verifier-silero.enabled	false
listener.vad_pre_wake_enabled	true
listener.VAD.silence_method	"vad_and_ratio"
listener.VAD.speech_seconds	0.1
listener.VAD.silence_seconds	0.5
listener.VAD.before_seconds	0.5
listener.VAD.min_seconds	1
listener.VAD.max_current_ratio_threshold	2
listener.VAD.initial_energy_threshold	1000.0
listener.VAD.module	"ovos-vad-plugin-silero"
listener.VAD.ovos-vad-plugin-silero.threshold	0.2
listener.VAD.ovos-vad-plugin-silero.fallback_module	"ovos-vad-plugin-precise"
listener.VAD.ovos-vad-plugin-precise.fallback_module	"ovos-vad-plugin-webrtcvad"
listener.VAD.ovos-vad-plugin-webrtcvad.vad_mode	3
listener.VAD.ovos-vad-plugin-webrtcvad.fallback_module	"ovos-vad-plugin-noise"
listener.VAD.ovos-vad-plugin-noise.method	"all"
listener.VAD.ovos-vad-plugin-noise.max_current_ratio_threshold	2.0
listener.VAD.ovos-vad-plugin-noise.energy_threshold	1000.0
listener.retry_mic_init	true
listener.mute_during_output	false
listener.phoneme_duration	120
listener.multiplier	1.0
listener.energy_ratio	1.5
listener.wake_word	"hey_mycroft"	Default hotword (matches an entry under hotwords).
listener.stand_up_word	"wake_up"
listener.recording_timeout_with_silence	3.0
listener.instant_listen	true
listener.continuous_listen	false
listener.hybrid_listen	false
listener.listen_timeout	45

hotwords

Key	Default	Description
hotwords.hey_mycroft.module	"ovos-ww-plugin-precise-onnx"
hotwords.hey_mycroft.model	"https://github.com/OpenVoiceOS/precise-lite-models/raw/master/wakewords/en/hey_mycroft.onnx"
hotwords.hey_mycroft.trigger_level	3
hotwords.hey_mycroft.sensitivity	0.5
hotwords.hey_mycroft.listen	true
hotwords.hey_mycroft.fallback_ww	"hey_mycroft_tflite"
hotwords.hey_mycroft_tflite.module	"ovos-ww-plugin-precise-lite"
hotwords.hey_mycroft_tflite.model	"https://github.com/OpenVoiceOS/precise-lite-models/raw/master/wakewords/en/hey_mycroft.tflite"
hotwords.hey_mycroft_tflite.expected_duration	3
hotwords.hey_mycroft_tflite.trigger_level	3
hotwords.hey_mycroft_tflite.sensitivity	0.5
hotwords.hey_mycroft_tflite.listen	true
hotwords.hey_mycroft_tflite.fallback_ww	"hey_mycroft_precise"
hotwords.hey_mycroft_precise.module	"ovos-ww-plugin-precise"
hotwords.hey_mycroft_precise.version	"0.3"
hotwords.hey_mycroft_precise.model	"https://github.com/MycroftAI/precise-data/raw/models-dev/hey-mycroft.tar.gz"
hotwords.hey_mycroft_precise.expected_duration	3
hotwords.hey_mycroft_precise.trigger_level	3
hotwords.hey_mycroft_precise.sensitivity	0.5
hotwords.hey_mycroft_precise.listen	true
hotwords.hey_mycroft_precise.fallback_ww	"hey_mycroft_vosk"
hotwords.hey_mycroft_vosk.module	"ovos-ww-plugin-vosk"
hotwords.hey_mycroft_vosk.samples	["hey mycroft", "hey microsoft", "hey mike roft", "hey minecraft"]
hotwords.hey_mycroft_vosk.rule	"fuzzy"
hotwords.hey_mycroft_vosk.listen	true
hotwords.hey_mycroft_vosk.fallback_ww	"hey_mycroft_pocketsphinx"
hotwords.hey_mycroft_pocketsphinx.module	"ovos-ww-plugin-pocketsphinx"
hotwords.hey_mycroft_pocketsphinx.phonemes	"HH EY . M AY K R AO F T"
hotwords.hey_mycroft_pocketsphinx.threshold	1e-90
hotwords.hey_mycroft_pocketsphinx.lang	"en-us"
hotwords.hey_mycroft_pocketsphinx.listen	true
hotwords.wake_up.module	"ovos-ww-plugin-vosk"
hotwords.wake_up.rule	"fuzzy"
hotwords.wake_up.samples	["wake up"]
hotwords.wake_up.lang	"en-us"
hotwords.wake_up.wakeup	true
hotwords.wake_up.fallback_ww	"wake_up_pocketsphinx"
hotwords.wake_up_pocketsphinx.module	"ovos-ww-plugin-pocketsphinx"
hotwords.wake_up_pocketsphinx.phonemes	"W EY K . AH P"
hotwords.wake_up_pocketsphinx.threshold	1e-20
hotwords.wake_up_pocketsphinx.lang	"en-us"
hotwords.wake_up_pocketsphinx.wakeup	true

gui

Key	Default	Description
gui.idle_display_skill	"ovos-skill-homescreen.openvoiceos"
gui.extension	"generic"
gui.generic.homescreen_supported	true
gui.disable_gui	false

session

Key	Default	Description
session.ttl	-1

stt

Key	Default	Description
stt.module	"ovos-stt-plugin-server"	Stock default is ovos-stt-plugin-server, which routes voice audio to a public community server for speech-to-text. See Privacy & Security.
stt.fallback_module	""

tts

Key	Default	Description
tts.pulse_duck	false
tts.module	"ovos-tts-plugin-server"	Stock default is ovos-tts-plugin-server, which routes text to a public community server for text-to-speech. See Privacy & Security.
tts.fallback_module	""
tts.ovos-tts-plugin-mimic.voice	"ap"
tts.ovos-tts-plugin-mimic.persist_cache	false
tts.ovos-tts-plugin-mimic.preloaded_cache	""
tts.ovos-tts-plugin-mimic.min_free_percent	75
tts.ovos-tts-plugin-mimic.persist_thresh	1

g2p

Key	Default	Description
g2p.module	""

language

Key	Default	Description
language.detection_module	"ovos-lang-detector-plugin-server"	Stock default is ovos-lang-detector-plugin-server, which routes text to a public community server for language detection. See Privacy & Security.
language.translation_module	"ovos-translate-plugin-server"	Stock default is ovos-translate-plugin-server, which routes text to a public community server for translation. See Privacy & Security.
language.ovos-translate-plugin-server.fallback_module	"ovos-google-translate-plugin"
language.ovos-lang-detector-plugin-server.fallback_module	"ovos-google-lang-detector-plugin"
language.ovos-google-lang-detector-plugin.fallback_module	"ovos-lang-detector-plugin-cld3"
language.ovos-lang-detector-plugin-cld3.fallback_module	"ovos-lang-detector-plugin-cld2"
language.ovos-lang-detector-plugin-cld2.fallback_module	"ovos-lang-detector-plugin-langdetect"
language.ovos-lang-detector-plugin-langdetect.fallback_module	"ovos-lang-detector-plugin-fastlang"
language.ovos-lang-detector-plugin-fastlang.fallback_module	"ovos-lang-detect-ngram-lm"

Audio

Key	Default	Description
Audio.native_sources	["debug_cli", "audio", "mycroft-gui"]
Audio.default-backend	"mpv"
Audio.backends.OCP.type	"ovos_common_play"
Audio.backends.OCP.preferred_audio_services	["mpv", "vlc", "simple"]
Audio.backends.OCP.disable_mpris	true
Audio.backends.OCP.dbus_type	"session"
Audio.backends.OCP.manage_external_players	false
Audio.backends.OCP.active	true
Audio.backends.simple.type	"ovos_audio_simple"
Audio.backends.simple.active	true
Audio.backends.vlc.type	"ovos_vlc"
Audio.backends.vlc.active	true
Audio.backends.vlc.initial_volume	100
Audio.backends.vlc.low_volume	50
Audio.backends.mpv.type	"ovos_mpv"
Audio.backends.mpv.active	true
Audio.backends.mpv.initial_volume	100
Audio.backends.mpv.low_volume	50

---

Source code: OpenVoiceOS/ovos-config.

---

Read next: Configuration Reference Related: Configuration Overview · Locations · Bus Events Reference