Merge pull request #1439 from MycroftAI/feature/mycroft-conf-doc

Improve docs within mycroft default configuration
pull/1440/merge
Åke 2018-02-23 11:11:45 +01:00 committed by GitHub
commit 03b9a53070
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 20 deletions

View File

@ -7,13 +7,19 @@
// '/etc/mycroft/mycroft.conf'), or at the USER level (typically in the // '/etc/mycroft/mycroft.conf'), or at the USER level (typically in the
// file '~/.mycroft/mycroft.conf'). // file '~/.mycroft/mycroft.conf').
// //
// The Override: comment indicates at what level (if any) this is // The load order of settings is:
// overridden by the system to a value besides the default shown here. // DEFAULT
// REMOTE
// SYSTEM
// USER
//
// The Override: comments below indicates where these settings are generally
// set outside of this file. The load order is always followed, so an
// individual systems can still apply changes at the SYSTEM or USER levels.
// Language used for speech-to-text and text-to-speech. // Language used for speech-to-text and text-to-speech.
// Code is a BCP-47 identifier (https://tools.ietf.org/html/bcp47), lowercased // Code is a BCP-47 identifier (https://tools.ietf.org/html/bcp47), lowercased
// TODO: save unmodified, lowercase upon demand // TODO: save unmodified, lowercase upon demand
// Override: none
"lang": "en-us", "lang": "en-us",
// Measurement units, either 'metric' or 'english' // Measurement units, either 'metric' or 'english'
@ -33,11 +39,9 @@
"opt_in": false, "opt_in": false,
// Play a beep when system begins to listen? // Play a beep when system begins to listen?
// Override: none
"confirm_listening": true, "confirm_listening": true,
// File locations of sounds to play for system events // File locations of sounds to play for system events
// Override: none
"sounds": { "sounds": {
"start_listening": "snd/start_listening.wav", "start_listening": "snd/start_listening.wav",
"end_listening": "snd/end_listening.wav" "end_listening": "snd/end_listening.wav"
@ -81,7 +85,6 @@
}, },
// General skill values // General skill values
// Override: none
"skills": { "skills": {
// Directory to look for user skills // Directory to look for user skills
"directory": "~/.mycroft/skills", "directory": "~/.mycroft/skills",
@ -98,7 +101,6 @@
}, },
// Address of the REMOTE server // Address of the REMOTE server
// Override: none
"server": { "server": {
"url": "https://api.mycroft.ai", "url": "https://api.mycroft.ai",
"version": "v1", "version": "v1",
@ -107,7 +109,6 @@
}, },
// The mycroft-core messagebus' websocket // The mycroft-core messagebus' websocket
// Override: none
"websocket": { "websocket": {
"host": "0.0.0.0", "host": "0.0.0.0",
"port": 8181, "port": 8181,
@ -138,7 +139,6 @@
}, },
// Settings used for any precise wake words // Settings used for any precise wake words
// Override: none
"precise": { "precise": {
"dist_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/dist/", "dist_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/dist/",
"models_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/models/" "models_url": "https://raw.githubusercontent.com/MycroftAI/precise-data/models/"
@ -181,11 +181,9 @@
}, },
// Level of logs to store, one of "CRITICAL", "ERROR", "WARNGIN", "INFO", "DEBUG" // Level of logs to store, one of "CRITICAL", "ERROR", "WARNGIN", "INFO", "DEBUG"
// Override: none
"log_level": "DEBUG", "log_level": "DEBUG",
// Messagebus types that will NOT be output to logs // Messagebus types that will NOT be output to logs
// Override: none
"ignore_logs": ["enclosure.mouth.viseme", "enclosure.mouth.display"], "ignore_logs": ["enclosure.mouth.viseme", "enclosure.mouth.display"],
// Settings related to remote sessions // Settings related to remote sessions
@ -232,24 +230,16 @@
// be removed from this file. // be removed from this file.
// ================================================================= // =================================================================
"wifi": {
"setup": false
},
"ConfigurationSkill": { "ConfigurationSkill": {
"max_delay": 60 "max_delay": 60
}, },
"WikipediaSkill": {
"max_results": 5,
"max_phrases": 2
},
"WolframAlphaSkill": { "WolframAlphaSkill": {
"api_key": "", "api_key": "",
"proxy": true "proxy": true
}, },
"WeatherSkill": { "WeatherSkill": {
"api_key": "", "api_key": "",
"proxy": true, "proxy": true
"temperature": "fahrenheit"
}, },
"NPRNewsSkill": { "NPRNewsSkill": {
"url_rss": "http://www.npr.org/rss/podcast.php?id=500005" "url_rss": "http://www.npr.org/rss/podcast.php?id=500005"