Merge pull request #162 from neon-mmd/readme-revision

📜 Revise the `docs` to remain in sync with the current changes
neon-mmd · Jul 31, 2023 · b299766 · b299766
2 parents 571b7ce + 47504cc
commit b299766
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "websurfx"
-version = "0.15.0"
+version = "0.15.1"
 edition = "2021"
 description = "An open-source alternative to Searx that provides clean, ad-free, and organic results with incredible speed while keeping privacy and security in mind."
 repository = "https://github.com/neon-mmd/websurfx"

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -29,6 +29,7 @@ Some of the configuration options provided in the file are stated below. These a
 - **port:** Port number on which server should be launched.
 - **binding_ip_addr:** IP address on the which server should be launched.
 - **production_use:** Whether to use production mode or not (in other words this option should be used if it is to be used to host it on the server to provide a service to a large number of users). If production_use is set to true. There will be a random delay before sending the request to the search engines, this is to prevent DDoSing the upstream search engines from a large number of simultaneous requests. This is newly added option and hence is only available in the **edge version**.
+- **request_timeout:** Timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
 
 ## Website
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -86,6 +86,7 @@ binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched.
 production_use = false -- whether to use production mode or not (in other words this option should be used if it is to be used to host it on the server to provide a service to a large number of users)
 -- if production_use is set to true
 -- There will be a random delay before sending the request to the search engines, this is to prevent DDoSing the upstream search engines from a large number of simultaneous requests.
+request_timeout = 60 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
 
 -- ### Website ###
 -- The different colorschemes provided are: