diff --git a/common/src/main/resources/docs/ConfigurationFile.md b/common/src/main/resources/docs/ConfigurationFile.md index 0530b3a0..ba2d96c9 100644 --- a/common/src/main/resources/docs/ConfigurationFile.md +++ b/common/src/main/resources/docs/ConfigurationFile.md @@ -6,15 +6,15 @@ The configuration file stores all your settings and recorded models. ctbrec application: -- Windows: `C:\Users\{your user name}\AppData\Roaming\ctbrec\settings.json` -- Linux: `~/.config/ctbrec/settings.json` -- macOS: `/Users/{your user name}/Library/Preferences/ctbrec/settings.json` +- Windows: `C:\Users\{your user name}\AppData\Roaming\ctbrec\\settings.json` +- Linux: `~/.config/ctbrec//settings.json` +- macOS: `/Users/{your user name}/Library/Preferences/ctbrec//settings.json` server: -- Windows: `C:\Users\{your user name}\AppData\Roaming\ctbrec\server.json` -- Linux: `~/.config/ctbrec/server.json` -- macOS: `/Users/{your user name}/Library/Preferences/ctbrec/server.json` +- Windows: `C:\Users\{your user name}\AppData\Roaming\ctbrec\\server.json` +- Linux: `~/.config/ctbrec//server.json` +- macOS: `/Users/{your user name}/Library/Preferences/ctbrec//server.json` ##### Values @@ -24,7 +24,7 @@ ignored. This is a collection of the most interesting values: - **chooseStreamQuality** (app only) - [`true`,`false`] Opens the stream resolution selection dialog, when you start recording a model. -- **concurrentRecordings** - [0 - 2147483647] Limits the number of concurrently running recordings. Once this number is reached, now more recordings are started +- **concurrentRecordings** - [0 - 2147483647] Limits the number of concurrently running recordings. Once this number is reached, no more recordings are started until a recording is finished. 0 means unlimited. - **determineResolution** (app only) - [`true`,`false`] Display the stream resolution on the thumbnails. @@ -43,12 +43,10 @@ ignored. This is a collection of the most interesting values: - **httpUserAgent** - The user agent, which is used in the HTTP header, when ctbrec connects to a camsite. This is used to disguise, that it actually is a recording software :) -- **httpUserAgentMobile** - Same as *httpUserAgent*, but in same cases we have to pretend to be a mobile phone :) +- **httpUserAgentMobile** - Same as *httpUserAgent*, but in s0me cases we have to pretend to be a mobile phone :) - **key** - Key for the HMAC based authentication. If this is set in server config and contains values, the HMAC authentication is automatically active. -- **livePreviews** (app only) - Enables the live preview feature in the app. - - **logFFmpegOutput** - [`true`,`false`] The output from FFmpeg (from recordings or post-processing steps) will be logged in temporary files. - **loghlsdlOutput** - [`true`,`false`] The output from hlsdl will be logged in temporary files. Only in effect, if `useHlsdl` is set to true