Spandan Tripathy commited on
Commit
68f7012
β€’
1 Parent(s): 24fda29

πŸ“ More typo correction and Grammatical correction in the documentation page (#368)

Browse files
Files changed (1) hide show
  1. docs/configuration.md +9 -9
docs/configuration.md CHANGED
@@ -2,14 +2,14 @@
2
 
3
  ## Installed From Source
4
 
5
- If you have built `websurfx` from source then the configuration file will be located under project directory (codebase) at `websurfx/`
6
 
7
  > **Note**
8
- > 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_.
9
 
10
  ## Installed From Package
11
 
12
- 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.
13
 
14
  Some of the configuration options provided in the file are stated below. These are subdivided into the following categories:
15
 
@@ -42,13 +42,13 @@ Some of the configuration options provided in the file are stated below. These a
42
  >
43
  > - Level 0 - With this level no search filtering occurs.
44
  > - Level 1 - With this level some search filtering occurs.
45
- > - Level 2 - With this level the upstream search engines are restricted to send sensitive contents like NSFW search results, etc.
46
- > - Level 3 - With this level the regex based filter lists is used alongside level 2 to filter more search results that have slipped in or custom results that needs to be filtered using the filter lists.
47
- > - Level 4 - This level is similar to level 3 except in this level the regex based filter lists are used to disallow users to search sensitive or disallowed content. This level could be useful if you are parent or someone who wants to completely disallow their kids or yourself from watching sensitive content.
48
 
49
  ## Website
50
 
51
- - **colorscheme:** The colorscheme name which should be used for the website theme (the name should be in accordance to the colorscheme file name present in `public/static/colorschemes` folder).
52
 
53
  > By Default we provide 12 colorschemes to choose from these are:
54
  >
@@ -65,7 +65,7 @@ Some of the configuration options provided in the file are stated below. These a
65
  > 11. tokyo-night
66
  > 12. tomorrow-night
67
 
68
- - **theme:** The theme name which should be used for the website (again, the name should be in accordance to the theme file name present in `public/static/themes` folder).
69
 
70
  > By Default we provide 1 theme to choose from these are:
71
  >
@@ -73,7 +73,7 @@ Some of the configuration options provided in the file are stated below. These a
73
 
74
  ## Cache
75
 
76
- - **redis_url:** Redis connection url address on which the client should connect on.
77
 
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).
 
2
 
3
  ## Installed From Source
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
11
 
12
+ 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/` make the changes there and rerun the websurfx server.
13
 
14
  Some of the configuration options provided in the file are stated below. These are subdivided into the following categories:
15
 
 
42
  >
43
  > - Level 0 - With this level no search filtering occurs.
44
  > - Level 1 - With this level some search filtering occurs.
45
+ > - Level 2 - With this level the upstream search engines are restricted to sending sensitive content like NSFW search results, etc.
46
+ > - Level 3 - With this level the regex-based filter lists are used alongside level 2 to filter more search results that have slipped in or custom results that need to be filtered using the filter lists.
47
+ > - Level 4 - This level is similar to level 3 except in this level the regex-based filter lists are used to disallow users to search sensitive or disallowed content. This level could be useful if you are a parent or someone who wants to completely disallow their kids or yourself from watching sensitive content.
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
  >
 
65
  > 11. tokyo-night
66
  > 12. tomorrow-night
67
 
68
+ - **theme:** The theme name that should be used for the website (again, the name should be by the theme file name present in the `public/static/themes` folder).
69
 
70
  > By Default we provide 1 theme to choose from these are:
71
  >
 
73
 
74
  ## Cache
75
 
76
+ - **redis_url:** Redis connection URL address on which the client should connect.
77
 
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).