From 7ef8ac23bd534f6cf5f5284462f6d267f067c9a8 Mon Sep 17 00:00:00 2001 From: Dorian Niemiec Date: Tue, 12 Nov 2024 20:17:39 +0100 Subject: [PATCH] docs: update the documentation to reflect the features of SVR.JS 4.2.0 --- pages/docs/api/svrjs-api.md | 6 ++++++ pages/docs/config/cli-options.md | 2 ++ pages/docs/config/configuration.md | 2 ++ 3 files changed, 10 insertions(+) diff --git a/pages/docs/api/svrjs-api.md b/pages/docs/api/svrjs-api.md index 346f96f..f9de64d 100644 --- a/pages/docs/api/svrjs-api.md +++ b/pages/docs/api/svrjs-api.md @@ -366,6 +366,12 @@ Sends local message to server console. This object contains properties from _config.json_ file. +### _config.wwwroot_ + +_Added in SVR.JS 4.2.0_ + +A normalized path to the webroot. In SVR.JS versions prior to 4.2.0, _config.wwwroot_ refers to the _webroot_ property from _config.json_ file. + ### _config.getCustomHeaders()_ _Added in SVR.JS 4.0.0_ diff --git a/pages/docs/config/cli-options.md b/pages/docs/config/cli-options.md index ef14633..c57ba1e 100644 --- a/pages/docs/config/cli-options.md +++ b/pages/docs/config/cli-options.md @@ -10,4 +10,6 @@ title: CLI options - _--secure_ - runs HTTPS server - _--disable-mods_ - disables mods (safe mode) - _--single-threaded_ - runs single-threaded +- _--stdout-notty_ - enable `stdout` even when `stdout` is not a TTY. May decrease the performace. (SVR.JS 4.2.0 or newer) +- _--no-save-config_ - don't save configuration file (SVR.JS 4.2.0 or newer) - _-v_ or _--version_ - displays server version diff --git a/pages/docs/config/configuration.md b/pages/docs/config/configuration.md index 6affcf5..e1e8163 100644 --- a/pages/docs/config/configuration.md +++ b/pages/docs/config/configuration.md @@ -187,6 +187,8 @@ The _config.json_ file contains various properties that you can customize to con - Option to allow double slashes in the URL. If set to `false`, double slashes are removed by URL sanitizer. Double slashes at the beginning of path (e.g. in _//config.json_) are always removed. Doesn't affect URL rewriting, in that case please configure the _allowDoubleSlashes_ property in the URL rewriting rule. It may allow some configuration file leaks, if web root is in the SVR.JS installation directory. - _optOutOfStatisticsServer_ (Boolean, SVR.JS 3.15.6 or newer) - Option to opt out of sending data to the statistics server. You can use this option to increase the privacy of SVR.JS. +- _disableConfigurationSaving_ (Boolean, SVR.JS 4.2.0 or newer) + - Option to enable `stdout` even when the `stdout` is not a TTY. Setting this option to `true` may decrease the performace of SVR.JS. ## Deprecated and Removed Properties