alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-10-18 06:22:53 -04:00
Code Issues Releases Activity

📜 docs: update the installation instructions (#148)

Browse Source
This commit is contained in:
neon_arch 2023-07-18 18:21:13 +03:00
parent 5bed9e735e
commit 7a33ee03d6
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/installation.md
View File

@ -10,7 +10,7 @@ paru -S websurfx-edge-git
After installing it you can run the websurfx server by running the following commands: After installing it you can run the websurfx server by running the following commands:
``` bash ```bash
redis-server --port 8082 & redis-server --port 8082 &
websurfx websurfx
``` ```
@ -19,7 +19,7 @@ Once you have started the server, open your preferred web browser and navigate t
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md). If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
## Other Distros ## Other Distros
The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well 🙂. The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well 🙂.
@ -91,12 +91,16 @@ production_use = false -- whether to use production mode or not (in other words
-- The different colorschemes provided are: -- The different colorschemes provided are:
-- {{ -- {{
-- catppuccin-mocha -- catppuccin-mocha
-- dark-chocolate
-- dracula -- dracula
-- gruvbox-dark
-- monokai -- monokai
-- nord -- nord
-- oceanic-next -- oceanic-next
-- one-dark
-- solarized-dark -- solarized-dark
-- solarized-light -- solarized-light
-- tokyo-night
-- tomorrow-night -- tomorrow-night
-- }} -- }}
colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme 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
-- ### Caching ### -- ### Caching ###
redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on. redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
-- ### Search Engines ###
upstream_search_engines = { DuckDuckGo = true, Searx = false } -- select the upstream search engines from which the results should be fetched.
``` ```
After this run the following command to deploy the app: After this run the following command to deploy the app:
@ -124,4 +131,4 @@ cd websurfx
git checkout stable git checkout stable
``` ```
[⬅️ Go back to Home](./README.md) [⬅️ Go back to Home](./README.md)