neon_arch commited on
Commit
7a33ee0
β€’
1 Parent(s): 5bed9e7

πŸ“œ docs: update the installation instructions (#148)

Browse files
Files changed (1) hide show
  1. docs/installation.md +10 -3
docs/installation.md CHANGED
@@ -10,7 +10,7 @@ paru -S websurfx-edge-git
10
 
11
  After installing it you can run the websurfx server by running the following commands:
12
 
13
- ``` bash
14
  redis-server --port 8082 &
15
  websurfx
16
  ```
@@ -19,7 +19,7 @@ Once you have started the server, open your preferred web browser and navigate t
19
 
20
  If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
21
 
22
- ## Other Distros
23
 
24
  The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well πŸ™‚.
25
 
@@ -91,12 +91,16 @@ production_use = false -- whether to use production mode or not (in other words
91
  -- The different colorschemes provided are:
92
  -- {{
93
  -- catppuccin-mocha
 
94
  -- dracula
 
95
  -- monokai
96
  -- nord
97
  -- oceanic-next
 
98
  -- solarized-dark
99
  -- solarized-light
 
100
  -- tomorrow-night
101
  -- }}
102
  colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
@@ -104,6 +108,9 @@ theme = "simple" -- the theme name which should be used for the website
104
 
105
  -- ### Caching ###
106
  redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
 
 
 
107
  ```
108
 
109
  After this run the following command to deploy the app:
@@ -124,4 +131,4 @@ cd websurfx
124
  git checkout stable
125
  ```
126
 
127
- [⬅️ Go back to Home](./README.md)
 
10
 
11
  After installing it you can run the websurfx server by running the following commands:
12
 
13
+ ```bash
14
  redis-server --port 8082 &
15
  websurfx
16
  ```
 
19
 
20
  If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
21
 
22
+ ## Other Distros
23
 
24
  The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well πŸ™‚.
25
 
 
91
  -- The different colorschemes provided are:
92
  -- {{
93
  -- catppuccin-mocha
94
+ -- dark-chocolate
95
  -- dracula
96
+ -- gruvbox-dark
97
  -- monokai
98
  -- nord
99
  -- oceanic-next
100
+ -- one-dark
101
  -- solarized-dark
102
  -- solarized-light
103
+ -- tokyo-night
104
  -- tomorrow-night
105
  -- }}
106
  colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
 
108
 
109
  -- ### Caching ###
110
  redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
111
+
112
+ -- ### Search Engines ###
113
+ upstream_search_engines = { DuckDuckGo = true, Searx = false } -- select the upstream search engines from which the results should be fetched.
114
  ```
115
 
116
  After this run the following command to deploy the app:
 
131
  git checkout stable
132
  ```
133
 
134
+ [⬅️ Go back to Home](./README.md)