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

53
docs/installation.md
View file

@ -1,16 +1,47 @@
# Stable
# Install From Package
To get started with Websurfx, clone the repository, edit the config file which is located in the `websurfx` directory and install redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands:
## Arch Linux
You can install `Websurfx` through the [Aur](https://aur.archlinux.org/packages/websurfx-git), Currently we only support `Rolling/Edge` version. You can install the rolling/edge version by running the following command (using [paru](https://github.com/Morganamilo/paru)):
```bash
paru -S websurfx-edge-git
```
After installing it you can run the websurfx server by running the following commands:
``` bash
redis-server --port 8082 &
websurfx
```
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080/ to start using Websurfx.
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
## 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 🙂.
# Install From Source
## Stable
To get started with Websurfx, clone the repository, edit the config file which is located in the `websurfx` directory and install redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then build and run the websurfx server by running the following commands:
```shell
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
cargo build
cargo build -r
redis-server --port 8082 &
./target/debug/websurfx
```
# Rolling/Edge/Unstable
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080/ to start using Websurfx.
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
## Rolling/Edge/Unstable
If you want to use the rolling/edge branch, run the following commands instead:
@ -18,13 +49,15 @@ If you want to use the rolling/edge branch, run the following commands instead:
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
git checkout rolling
cargo build
cargo build -r
redis-server --port 8082 &
./target/debug/websurfx
```
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080/ to start using Websurfx.
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
# Docker Deployment
Before you start, you will need [Docker](https://docs.docker.com/get-docker/) installed on your system first.
@ -61,7 +94,11 @@ colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used fo
theme = "simple" -- the theme name which should be used for the website
-- Caching
redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
redis_connection_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on.
production_use = false -- 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.
```
After this run the following command to deploy the app:
@ -74,7 +111,7 @@ This will take around 5-10 mins for first deployment, afterwards the docker buil
## Unstable/Edge/Rolling
For the unstable/rolling/edge version, follow the same steps as above with an addition of one command for cloning the repository which makes the cloning step as follows:
For the unstable/rolling/edge version, follow the same steps as above (as mentioned for the stable version) with an addition of one command which has to be performed after cloning and changing directory into the repository which makes the cloning step as follows:
```bash
git clone https://github.com/neon-mmd/websurfx.git
@ -82,4 +119,4 @@ cd websurfx
git checkout rolling
```
[⬅️ Go back to Home](https://github.com/neon-mmd/websurfx/wiki).
[⬅️ Go back to Home](./README.md)