From 473ada2871fb41a6c5a36de0dcfcd5863b548ed0 Mon Sep 17 00:00:00 2001 From: neon_arch Date: Sun, 28 May 2023 11:23:11 +0300 Subject: [PATCH] docs: update docs to explain about the new option logging --- docs/configuration.md | 5 +++++ docs/installation.md | 18 ++++++++++-------- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index bb10ba6..f700389 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -13,10 +13,15 @@ If you have installed `websurfx` using the package manager of your Linux distro Some of the configuration options provided in the file are stated below. These are subdivided into three categories: +- General - Server - Website - Cache +# General + +- **logging:** An option to enable or disable logs. + ## Server - **port:** Port number on which server should be launched. diff --git a/docs/installation.md b/docs/installation.md index d8f301b..1a04254 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -76,11 +76,17 @@ cd websurfx 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: ```lua --- Server +-- ### General ### +logging = true -- an option to enable or disable logs. + +-- ### Server ### port = "8080" -- port on which server should be launched 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. --- Website +-- ### Website ### -- The different colorschemes provided are: -- {{ -- catppuccin-mocha @@ -95,12 +101,8 @@ binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched. colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme theme = "simple" -- the theme name which should be used for the website --- Caching -redis_connection_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on. - -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. +-- ### Caching ### +redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on. ``` After this run the following command to deploy the app: