Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:guides:other:configuration [2017/02/03 17:33]
flyth
en:guides:other:configuration [2018/02/20 20:21] (current)
irgendwer updated config options and defaults
Line 1: Line 1:
 # Configuration # Configuration
  
-^ Field              ^ Value ^ +^ Field              ^ Value                                                                          ^ Default ​                   ​
-| EnableDebugConsole | (internal use only) | +| EnableDebugConsole | (internal use only)                                                            | true                       
-| EnableLocalFS ​     | (internal use only) | +| EnableLocalFS ​     | (internal use only)                                                            | false                      ​
-| EnableProfiler ​    | (internal use only; deprecated) | +| EnableProfiler ​    | (internal use only; deprecated) ​                                               | false                      ​
-| EnableWebStream ​   | allow the bot to export the audiostream via http or icecast; disabled by default ​+| EnableWebStream ​   | allow the bot to export the audiostream via http or icecast ​                   | false                      ​
-| DataDir ​           | This can be used to specify the data directory the bot should use. Default is ./data inside the bot root+| DataDir ​           | This can be used to specify the data directory the bot should use.             | ./data inside the bot root | 
-| Hostname ​          | Hostname to use for the certificate when UseSSL is enabled | +| Hostname ​          | Hostname to use for the certificate when UseSSL is enabled ​                    |                            ​
-| InstanceActionLimit| number of http requests / actions (per instance and second) before a limit will prevent further actions | +| InstanceActionLimit| number of http requests / actions (per instance and second) before a limit will prevent further actions ​| 6 
-| IsProxied ​         | if enabled, the bot will trust proxied headers and use the ips from there | +| IsProxied ​         | if enabled, the bot will trust proxied headers and use the ips from there      | false                      ​
-| License ​           | one or more valid licenses | +| License ​           | one or more valid licenses ​                                                    |                            ​
-| LicenseKey ​        | hostspecific license key; used for license-requests. Don't change! | +| LicenseKey ​        | hostspecific license key; used for license-requests. Don't change ​it         ​| ​                           ​
-| ListenHost ​        | IP-address the bot should listen on; default ​0.0.0.0 will listen on all interfaces / IP-addresses | +| ListenHost ​        | IP-address the bot should listen on                  ​| ​0.0.0.0 ​(will listen on all interfaces/​IP-addresses
-| ListenPort ​        | Port the bot should listen on | +| ListenPort ​        | Port the bot should listen on                        | 8087  ​
-| LocalPlayback ​     | (internal use only) | +| LocalPlayback ​     | (internal use only)                                  | false 
-| LogFile ​           | if specified, output will be logged to this file instead of stdout | +| LogFile ​           | if specified, output will be logged to this file instead of stdout ​
-| MaxBulkOperations ​ | number of entries that can be moved with one operation (add to playlist, move to folder and such) | +| MaxBulkOperations ​ | number of entries that can be moved with one operation (add to playlist, move to folder and such) | 300 
-| LogLevel ​          | verbosity of the log; default is 3 | +| LogLevel ​          | verbosity of the log                                      ​| ​(errors and warnings) ​
-| Pragma ​            | (caution!) used to override database version; DO NOT SET! | +| Pragma ​            | (caution!) used to override database version; DO NOT SET! 
-| RunAsGroup ​        | gid to use for privilege drop | +| RunAsGroup ​        | gid to use for privilege drop          | 0 
-| RunAsUser ​         | uid to use for privilege drop | +| RunAsUser ​         | uid to use for privilege drop          | 0 
-| SampleInterval ​    ​| ​number of milliseconds of audiodata that is handled in a batch; 60 is sane for most installationson Windows tuning this can help preventing stuttering ​+| SampleInterval ​    ​| ​`DON'T TOUCHWILL BREAK THINGS!` ​     | 
-| SSLCertFile ​       | certificate to use for SSL connections | +| SSLCertFile ​       | certificate to use for SSL connections ​
-| SSLKeyFile ​        | private key to use for SSL connections | +| SSLKeyFile ​        | private key to use for SSL connections ​
-| Token              | random security token, generated on first start; to change, remove it | +| Token              | random security token, generated on first start; to change, remove it 
-| TS3Path ​           | Path to the TeamSpeak 3 Client executable | +| TS3Path ​           | Path to the TeamSpeak 3 Client executable ​
-| UploadLimit ​       | maximum number of bytes a file is allowed to have when uploading; default ​80M | +| UploadLimit ​       | maximum number of bytes a file is allowed to have when uploading ​| 83886080 (80M
-| UseSSL ​            | if set to true, the bot will only accept https-connections;​ Hostname MUST be specified | +| UseSSL ​            | if set to true, the bot will only accept https-connections;​ Hostname MUST be specified ​| false 
-| YoutubeDLPath ​     | Path the the youtube-dl executable |+| YoutubeDLPath ​     | Path the the youtube-dl executable ​| youtube-dl ​|
  
 ### TS3 ### TS3
  
-^ Field              ^ Value ^ +^ Field              ^ Value                                                                ^ Default ​     ​
-| AvatarMaxWidth ​    | if set, all uploaded avatars will be limited (resized) to this value | +| AvatarMaxWidth ​    | if set, all uploaded avatars will be limited (resized) to this value | 0 (no limit) ​|  
-| AvatarMaxHeight ​   | if set, all uploaded avatars will be limited (resized) to this value |+| AvatarMaxHeight ​   | if set, all uploaded avatars will be limited (resized) to this value | 0 (no limit) | 
 +| AllowGIF ​          | allows avatar to be a GIF                                            |              ​|
  
 ### YoutubeDL ### YoutubeDL
  
-^ Field              ^ Value ^ +^ Field                         ​^ Value                                                                       ^ Default ​
-| BufferSize ​        ​| number of bytes to use for buffering (useful to tune on slow connections) | +| BufferSize ​                   | number of bytes to use for buffering (useful to tune on slow connections) ​  ​           
-| MaxDownloadSize ​   | maximum size of files to download via ytdl | +| CacheStreamed ​                ​| if streaming via ytdl, enabling this will cause the streams to get stored inside the cache directory; please be aware that you have to delete the cache files manually (that'​s safe to do) |            | 
-| MaxDownloadRate ​   | if you want to slow down ytdl to prevent traffic spikes, use this +| ChunkSize ​                    | Size in bytes that will determine count of simultaneous download streams (limited by MaxSimultaneousChunkDownloads) | 3 MB        | 
-| CacheStreamed ​     | if streaming via ytdl, enabling this will cause the streams to get stored inside the cache directory; please be aware that you have to delete the cache files manually (that'​s safe to do) |+| MaxDownloadSize ​              | maximum size of files to download via ytdl                                  |            | 
 +| MaxDownloadRate ​              | if you want to slow down ytdl to prevent traffic spikes, use this           ​| ​           | 
 +| MaxSimultaneousChunkDownloads | overall limit of simultaneous download streams per job                      | 10         | 
 +| TimeoutMultiDownloader ​       | timeout (in seconds) for chunks of a multi stream download ​                 | 5 Minutes ​ | 
 +| TimeoutSingleDownloader ​      | time (in seconds) before a downloader cancels ​                              | 30 Minutes ​|
  
 ### Plugins ### Plugins
Line 53: Line 58:
 | AllowReload ​       | Enables a script function that allows hot script reloading (added scripts will still need a restart of the bot) | | AllowReload ​       | Enables a script function that allows hot script reloading (added scripts will still need a restart of the bot) |
 | EnableTimer ​       | Enable the timer event (disabled by default); deprecated, will get removed soon | | EnableTimer ​       | Enable the timer event (disabled by default); deprecated, will get removed soon |
 +| WatchScripts ​      | An array of script files that should automatically be reloaded if a change is detected; very useful for script developers; AllowReload needs to be enabled |
  
 ### SpeechRecognition ### SpeechRecognition
Line 61: Line 67:
 ### XServer ### XServer
  
-^ Field              ^ Value ^ +^ Field              ^ Value                                                     ^ Default ​
-| Delay              | Throttle XServer events to save CPU cycles (DON'T CHANGE) | +| Delay              | Throttle XServer events to save CPU cycles (DON'T CHANGE) ​| 0       
-| Debug              | (internal only) |+| Debug              | (internal only)                                           | false   |
  
-### DAV+### DAV (deprecated)
  
-^ Field              ^ Value ^ +^ Field              ^ Value                                                                     ^ Default ​
-| Enable ​            | Enables serving the music files via DAV backend; experimental |+| Enable ​            | Enables serving the music files via DAV backend; experimental; deprecated | false   |
  
 ### FFmpeg ### FFmpeg