morrigan/crabbysearch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: revise and improve the documentation

Browse source
This commit is contained in:
neon_arch 2023-05-26 12:50:50 +03:00
parent 85d463f41a
commit eee06b92d7
5 changed files with 102 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/configuration.md
View file

@ -1,6 +1,15 @@
# Configuration
Everything in websurfx can be configured through the config file located at `websurfx/config.lua`.
## Installed From Source
If you have built `websurfx` from source then the configuration file will be located under project directory (codebase) at `websurfx/`
> **Note**
> If you have built websurfx with unstable/rolling/edge branch then you can copy the configuration file from `websurfx/config.lua` located under project directory (codebase) to `~/.config/websurfx/` and make the changes there and rerun the websurfx server. _This is only available from unstable/rolling/edge version_.
## Installed From Package
If you have installed `websurfx` using the package manager of your Linux distro then the default configuration file will be located at `/etc/xdg/websurfx/`. You can copy the default config to `~/.config/websurfx/` and make the changes there and rerun the websurfx server.
Some of the configuration options provided in the file are stated below. These are subdivided into three categories:
@ -12,6 +21,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**.
## Website
@ -39,4 +49,4 @@ Some of the configuration options provided in the file are stated below. These a
- **redis_connection_url:** Redis connection url address on which the client should connect on.
[⬅️ Go back to Home](https://github.com/neon-mmd/websurfx/wiki).
[⬅️ Go back to Home](./README.md)