Install From Package

Arch Linux

You can install Websurfx through the Aur, Currently we only support Rolling/Edge version. You can install the rolling/edge version by running the following command (using paru):

paru -S websurfx-edge-git

After installing it you can run the websurfx server by running the following commands:

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.

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

Before you can start building websurfx, you will need to have Cargo installed on your system. You can find the installation instructions here.

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 and then build and run the websurfx server by running the following commands:

git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
git checkout stable
cargo build -r
redis-server --port 8082 &
./target/release/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.

Rolling/Edge/Unstable

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

Once you have changed the directory to the websurfx directory then follow the build options listed in the building docs.

After that run the following command if you have build the app with the redis-cache feature:

redis-server --port 8082 &

After that run the following command to start the search engine:

./target/release/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.

Docker Deployment

Before you start, you will need Docker installed on your system first.

Unstable/Edge/Rolling

First clone the the repository by running the following command:

git clone https://github.com/neon-mmd/websurfx.git
cd websurfx

After that edit the config.lua file located under websurfx directory. In the config file you will specifically need to change to values which is binding_ip_addr and redis_connection_url which should make the config look something like this:

-- ### General ###
logging = true -- an option to enable or disable logs.
debug = false -- an option to enable or disable debug mode.
threads = 8 -- the amount of threads that the app will use to run (the value should be greater than 0).

-- ### Server ###
port = "8080" -- port on which server should be launched
binding_ip = "0.0.0.0" --ip address on the which server should be launched.
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 (more than one))
-- 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.
request_timeout = 30 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
rate_limiter = {
    number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
    time_limit = 3, -- The time limit in which the quantity of requests that should be accepted.
}

-- ### Search ###
-- Filter results based on different levels. The levels provided are:
-- {{
-- 0 - None
-- 1 - Low
-- 2 - Moderate
-- 3 - High
-- 4 - Aggressive
-- }}
safe_search = 2

-- ### Website ###
-- The different colorschemes provided are:
-- {{
-- catppuccin-mocha
-- dark-chocolate
-- dracula
-- gruvbox-dark
-- monokai
-- nord
-- oceanic-next
-- one-dark
-- solarized-dark
-- solarized-light
-- tokyo-night
-- tomorrow-night
-- }}
colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
theme = "simple" -- the theme name which should be used for the website

-- ### Caching ###
redis_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:

docker compose up -d --build

This will take around 5-10 mins for first deployment, afterwards the docker build stages will be cached so it will be faster to be build from next time onwards. After the above step finishes launch your preferred browser and then navigate to http://<ip_address_of_the_device>:<whatever_port_you_provided_in_the_config>.

Stable

For the stable version, follow the same steps as above (as mentioned for the unstable/rolling/edge 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:

git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
git checkout stable

⬅️ Go back to Home