From 9037d8544dd303ac1536d0ff915acbf8247a3f6e Mon Sep 17 00:00:00 2001 From: 0xboobface <0xboobface@gmail.com> Date: Sun, 14 Apr 2019 17:57:32 +0200 Subject: [PATCH] Add documentation for the configuration files --- .../resources/html/docs/ConfigurationFile.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 client/src/main/resources/html/docs/ConfigurationFile.md diff --git a/client/src/main/resources/html/docs/ConfigurationFile.md b/client/src/main/resources/html/docs/ConfigurationFile.md new file mode 100644 index 00000000..24269c91 --- /dev/null +++ b/client/src/main/resources/html/docs/ConfigurationFile.md @@ -0,0 +1,58 @@ +#### Configuration File +The configuration file stores all your settings and recorded models. + +##### Location +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` + +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` + +##### Values +The application and the server share the same configuration file structure. That's why there are +values, which don't make sense in the server configuration and vice versa. These values are simply +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 +until a recording is finished. 0 means unlimited. + +- **determineResolution** (app only) - [`true`,`false`] Display the stream resolution on the thumbnails. + +- **generatePlaylist** (server only) - [`true`,`false`] Generate a playlist once a recording terminates. The playlist is used to detect, if a recording is finished +or not. If you disable this, the recording will stay in the state *recording*. You should only disable this, if you are doing some other post-processing. + +- **httpPort** - [1 - 65536] The TCP port, the server listens on. In the server config, this will tell the server, which port to use. In the application this will set +the port ctbrec tries to connect to, if it is run in remote mode. + +- **httpServer** (app only) - The TCP host where the server is running. Has no effect, if ctbrec is run in local reocrding mode. + +- **httpTimeout** - [1 - 2147483647] in milliseconds. In the server configuration this sets the idle timeout for connections to the server. In the app this sets the connect and read timeout for any HTTP connection. + +- **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 :) + +- **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. + +- **maximumResolution** - [1 - 2147483647]. Sets the maximum video height for a recording. ctbrec tries to find a stream quality, which is lower than or equal to this value. If the only provided stream quality is above this threshold, ctbrec won't record the stream. + +- **minimumLengthInSeconds** - [0 - 2147483647] Automatically delete recordings, which are shorter than this amount of seconds. 0 disables this feature. + +- **minimumSpaceLeftInBytes** - [0 - 9223372036854775807] The space in bytes ctbrec should conserve on the hard drive. 1 GiB = 1024 MiB = 1048576 KiB = 1073741824 bytes + +- **onlineCheckIntervalInSecs** - [1 - 2147483647] How often ctbrec checks, if a model is online. This is not a guaranteed interval: If you record many models, the online check for all models can take longer than this interval. A minute is a reasonable value, but you can go lower, if you don't want to miss a anything. But don't go too low, or you risk to do too many requests in a short amount of time and get banned by some sites. + +- **postProcessing** - Absolute path to a script, which is executed once a recording is finished. See [Post-Processing](/docs/PostProcessing.md). + +- **recordingsDir** - Where ctbrec saves the recordings. + +- **splitRecordings** (app only) - [0 - 2147483647] in seconds. Split recordings after this amount of seconds. The recordings are split up into several individual recordings, +which have the defined length (roughly). 0 means no splitting.