Spaces:
Running
Running
neon_arch commited on
Commit ·
a66362b
1
Parent(s): 493696f
📝 docs: provide explanation for the new config file options (#439)
Browse files- docs/configuration.md +10 -2
docs/configuration.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
| 4 |
|
| 5 |
If you have built `websurfx` from the source then the configuration file will be located under the project directory (codebase) at `websurfx/`
|
| 6 |
|
| 7 |
-
>
|
| 8 |
> If you have built websurfx with an unstable/rolling/edge branch then you can copy the configuration file from `websurfx/config.lua` located under the 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_.
|
| 9 |
|
| 10 |
## Installed From Package
|
|
@@ -48,7 +48,7 @@ Some of the configuration options provided in the file are stated below. These a
|
|
| 48 |
|
| 49 |
## Website
|
| 50 |
|
| 51 |
-
- **colorscheme:** The colorscheme name which should be used for the website theme (the name should be by
|
| 52 |
|
| 53 |
> By Default we provide 12 colorschemes to choose from these are:
|
| 54 |
>
|
|
@@ -71,6 +71,12 @@ Some of the configuration options provided in the file are stated below. These a
|
|
| 71 |
>
|
| 72 |
> 1. simple
|
| 73 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 74 |
## Cache
|
| 75 |
|
| 76 |
- **redis_url:** Redis connection URL address on which the client should connect.
|
|
@@ -78,6 +84,8 @@ Some of the configuration options provided in the file are stated below. These a
|
|
| 78 |
> **Note**
|
| 79 |
> This option can be commented out if you have compiled the app without the `redis-cache` feature. For more information, See [**building**](./building.md).
|
| 80 |
|
|
|
|
|
|
|
| 81 |
## Search Engines
|
| 82 |
|
| 83 |
- **upstream_search_engines:** Select from the different upstream search engines from which the results should be fetched.
|
|
|
|
| 4 |
|
| 5 |
If you have built `websurfx` from the source then the configuration file will be located under the project directory (codebase) at `websurfx/`
|
| 6 |
|
| 7 |
+
> [!Note]
|
| 8 |
> If you have built websurfx with an unstable/rolling/edge branch then you can copy the configuration file from `websurfx/config.lua` located under the 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_.
|
| 9 |
|
| 10 |
## Installed From Package
|
|
|
|
| 48 |
|
| 49 |
## Website
|
| 50 |
|
| 51 |
+
- **colorscheme:** The colorscheme name which should be used for the website theme (the name should be by the colorscheme file name present in the `public/static/colorschemes` folder).
|
| 52 |
|
| 53 |
> By Default we provide 12 colorschemes to choose from these are:
|
| 54 |
>
|
|
|
|
| 71 |
>
|
| 72 |
> 1. simple
|
| 73 |
|
| 74 |
+
- **animation:** The animation name that should be used for the website (again, the name should be by the animation file name present in the `public/static/animations` folder).
|
| 75 |
+
|
| 76 |
+
> By Default we provide 1 animation to choose from these are:
|
| 77 |
+
>
|
| 78 |
+
> 1. simple-frosted-glow
|
| 79 |
+
|
| 80 |
## Cache
|
| 81 |
|
| 82 |
- **redis_url:** Redis connection URL address on which the client should connect.
|
|
|
|
| 84 |
> **Note**
|
| 85 |
> This option can be commented out if you have compiled the app without the `redis-cache` feature. For more information, See [**building**](./building.md).
|
| 86 |
|
| 87 |
+
- **cache_expiry_time:** The maximum time the server will store the cache for, after which it flushs/removes/expires/invalidates the cached results. (value provided to this option should be in seconds and the value should be greater than or equal to 60 seconds).
|
| 88 |
+
|
| 89 |
## Search Engines
|
| 90 |
|
| 91 |
- **upstream_search_engines:** Select from the different upstream search engines from which the results should be fetched.
|