svrjs/svrjs-nextjs-website
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update the documentation to reflect the features of SVR.JS 4.2.0

Browse source
This commit is contained in:
Dorian Niemiec 2024-11-12 20:17:39 +01:00
parent 85614ae9b3
commit 7ef8ac23bd
3 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pages/docs/api/svrjs-api.md
View file

@ -366,6 +366,12 @@ Sends local message to server console.
This object contains properties from _config.json_ file. This object contains properties from _config.json_ file.
### _config.wwwroot_
<small>_Added in SVR.JS 4.2.0_</small>
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()_ ### _config.getCustomHeaders()_
<small>_Added in SVR.JS 4.0.0_</small> <small>_Added in SVR.JS 4.0.0_</small>

2
pages/docs/config/cli-options.md
View file

@ -10,4 +10,6 @@ title: CLI options
- _--secure_ - runs HTTPS server - _--secure_ - runs HTTPS server
- _--disable-mods_ - disables mods (safe mode) - _--disable-mods_ - disables mods (safe mode)
- _--single-threaded_ - runs single-threaded - _--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 - _-v_ or _--version_ - displays server version

2
pages/docs/config/configuration.md
View file

@ -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. - 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) - _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. - 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 ## Deprecated and Removed Properties