neon_arch
commited on
Commit
Β·
a536256
1
Parent(s):
1398a18
π docs: update install from source documentation (#265)
Browse files- docs/installation.md +35 -6
docs/installation.md
CHANGED
|
@@ -51,8 +51,19 @@ If you want to use the rolling/edge branch, run the following commands instead:
|
|
| 51 |
```shell
|
| 52 |
git clone https://github.com/neon-mmd/websurfx.git
|
| 53 |
cd websurfx
|
| 54 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
redis-server --port 8082 &
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 56 |
./target/release/websurfx
|
| 57 |
```
|
| 58 |
|
|
@@ -79,15 +90,30 @@ After that edit the config.lua file located under `websurfx` directory. In the c
|
|
| 79 |
-- ### General ###
|
| 80 |
logging = true -- an option to enable or disable logs.
|
| 81 |
debug = false -- an option to enable or disable debug mode.
|
| 82 |
-
threads =
|
| 83 |
|
| 84 |
-- ### Server ###
|
| 85 |
port = "8080" -- port on which server should be launched
|
| 86 |
-
|
| 87 |
-
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)
|
| 88 |
-- if production_use is set to true
|
| 89 |
-- 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.
|
| 90 |
-
request_timeout =
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 91 |
|
| 92 |
-- ### Website ###
|
| 93 |
-- The different colorschemes provided are:
|
|
@@ -112,7 +138,10 @@ theme = "simple" -- the theme name which should be used for the website
|
|
| 112 |
redis_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
|
| 113 |
|
| 114 |
-- ### Search Engines ###
|
| 115 |
-
upstream_search_engines = {
|
|
|
|
|
|
|
|
|
|
| 116 |
```
|
| 117 |
|
| 118 |
After this run the following command to deploy the app:
|
|
|
|
| 51 |
```shell
|
| 52 |
git clone https://github.com/neon-mmd/websurfx.git
|
| 53 |
cd websurfx
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
Once you have changed the directory to the `websurfx` directory then follow the build options listed in the [building docs](./building.md).
|
| 57 |
+
|
| 58 |
+
After that run the following command if you have build the app with the `redis-cache` feature:
|
| 59 |
+
|
| 60 |
+
``` shell
|
| 61 |
redis-server --port 8082 &
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
After that run the following command to start the search engine:
|
| 65 |
+
|
| 66 |
+
``` shell
|
| 67 |
./target/release/websurfx
|
| 68 |
```
|
| 69 |
|
|
|
|
| 90 |
-- ### General ###
|
| 91 |
logging = true -- an option to enable or disable logs.
|
| 92 |
debug = false -- an option to enable or disable debug mode.
|
| 93 |
+
threads = 8 -- the amount of threads that the app will use to run (the value should be greater than 0).
|
| 94 |
|
| 95 |
-- ### Server ###
|
| 96 |
port = "8080" -- port on which server should be launched
|
| 97 |
+
binding_ip = "0.0.0.0" --ip address on the which server should be launched.
|
| 98 |
+
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 (more than one))
|
| 99 |
-- if production_use is set to true
|
| 100 |
-- 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.
|
| 101 |
+
request_timeout = 30 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
|
| 102 |
+
rate_limiter = {
|
| 103 |
+
number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
|
| 104 |
+
time_limit = 3, -- The time limit in which the quantity of requests that should be accepted.
|
| 105 |
+
}
|
| 106 |
+
|
| 107 |
+
-- ### Search ###
|
| 108 |
+
-- Filter results based on different levels. The levels provided are:
|
| 109 |
+
-- {{
|
| 110 |
+
-- 0 - None
|
| 111 |
+
-- 1 - Low
|
| 112 |
+
-- 2 - Moderate
|
| 113 |
+
-- 3 - High
|
| 114 |
+
-- 4 - Aggressive
|
| 115 |
+
-- }}
|
| 116 |
+
safe_search = 2
|
| 117 |
|
| 118 |
-- ### Website ###
|
| 119 |
-- The different colorschemes provided are:
|
|
|
|
| 138 |
redis_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
|
| 139 |
|
| 140 |
-- ### Search Engines ###
|
| 141 |
+
upstream_search_engines = {
|
| 142 |
+
DuckDuckGo = true,
|
| 143 |
+
Searx = false,
|
| 144 |
+
} -- select the upstream search engines from which the results should be fetched.
|
| 145 |
```
|
| 146 |
|
| 147 |
After this run the following command to deploy the app:
|