neon_arch
commited on
Commit
•
473ada2
1
Parent(s):
5cb53c7
docs: update docs to explain about the new option logging
Browse files- docs/configuration.md +5 -0
- docs/installation.md +10 -8
docs/configuration.md
CHANGED
@@ -13,10 +13,15 @@ If you have installed `websurfx` using the package manager of your Linux distro
|
|
13 |
|
14 |
Some of the configuration options provided in the file are stated below. These are subdivided into three categories:
|
15 |
|
|
|
16 |
- Server
|
17 |
- Website
|
18 |
- Cache
|
19 |
|
|
|
|
|
|
|
|
|
20 |
## Server
|
21 |
|
22 |
- **port:** Port number on which server should be launched.
|
|
|
13 |
|
14 |
Some of the configuration options provided in the file are stated below. These are subdivided into three categories:
|
15 |
|
16 |
+
- General
|
17 |
- Server
|
18 |
- Website
|
19 |
- Cache
|
20 |
|
21 |
+
# General
|
22 |
+
|
23 |
+
- **logging:** An option to enable or disable logs.
|
24 |
+
|
25 |
## Server
|
26 |
|
27 |
- **port:** Port number on which server should be launched.
|
docs/installation.md
CHANGED
@@ -76,11 +76,17 @@ cd websurfx
|
|
76 |
After that edit the config.lua file located under `websurfx` directory. In the config file you will specifically need to change to values which is `binding_ip_addr` and `redis_connection_url` which should make the config look something like this:
|
77 |
|
78 |
```lua
|
79 |
-
--
|
|
|
|
|
|
|
80 |
port = "8080" -- port on which server should be launched
|
81 |
binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched.
|
|
|
|
|
|
|
82 |
|
83 |
-
-- Website
|
84 |
-- The different colorschemes provided are:
|
85 |
-- {{
|
86 |
-- catppuccin-mocha
|
@@ -95,12 +101,8 @@ binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched.
|
|
95 |
colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
|
96 |
theme = "simple" -- the theme name which should be used for the website
|
97 |
|
98 |
-
-- Caching
|
99 |
-
redis_connection_url = "redis://
|
100 |
-
|
101 |
-
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)
|
102 |
-
-- if production_use is set to true
|
103 |
-
-- 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.
|
104 |
```
|
105 |
|
106 |
After this run the following command to deploy the app:
|
|
|
76 |
After that edit the config.lua file located under `websurfx` directory. In the config file you will specifically need to change to values which is `binding_ip_addr` and `redis_connection_url` which should make the config look something like this:
|
77 |
|
78 |
```lua
|
79 |
+
-- ### General ###
|
80 |
+
logging = true -- an option to enable or disable logs.
|
81 |
+
|
82 |
+
-- ### Server ###
|
83 |
port = "8080" -- port on which server should be launched
|
84 |
binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched.
|
85 |
+
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)
|
86 |
+
-- if production_use is set to true
|
87 |
+
-- 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.
|
88 |
|
89 |
+
-- ### Website ###
|
90 |
-- The different colorschemes provided are:
|
91 |
-- {{
|
92 |
-- catppuccin-mocha
|
|
|
101 |
colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
|
102 |
theme = "simple" -- the theme name which should be used for the website
|
103 |
|
104 |
+
-- ### Caching ###
|
105 |
+
redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
|
|
|
|
|
|
|
|
|
106 |
```
|
107 |
|
108 |
After this run the following command to deploy the app:
|