neonmmd/websurfx

Quick reference 🔗

Maintained by: https://github.com/neon-mmd/websurfx

Where to get help: The Websurfx community ***

Supported tags and respective Dockerfile links 🏷️

• 1.0.0-hybrid, hybrid, latest
• 1.0.0-memory, memory
• 1.0.0-nocache, nocache
• 1.0.0-redis, redis

Quick reference (cont.) 🔗

Where to file issues: https://github.com/neon-mmd/websurfx

Supported architectures: (https://github.com/neon-mmd/websurfx?tab=readme-ov-file#system-requirements-) 📊

amd64 only

What is Websurfx? 💬

🚀 An open source alternative to Searx meta search engine which provides a modern-looking ✨, lightning-fast ⚡, privacy respecting 🥸, secure 🔒 meta search engine.

More info on the search engine. See: https://github.com/neon-mmd/websurfx/blob/HEAD/README.md

!https://github.com/neon-mmd/websurfx/blob/HEAD/images/websurfx_logo.png?raw=true

How to use this image 🩻

To get started using the image, create a docker-compose.yml with the content, which should look something like this:

yaml
---
version: '3.9'
services:
  app:
    # Comment the line below if you don't want to use the `hybrid/latest` image.
    image: neonmmd/websurfx:latest
    # Uncomment the line below if you want to use the `no cache` image.
    # image: neonmmd/websurfx:nocache
    # Uncomment the line below if you want to use the `memory` image.
    # image: neonmmd/websurfx:memory
    # Uncomment the line below if you want to use the `redis` image.
    # image: neonmmd/websurfx:redis
    ports:
      - 8080:8080
    # Uncomment the following lines if you are using the `hybrid/latest` or `redis` image.
    # depends_on:
    #   - redis
    # links:
    #   - redis
    volumes:
      - ./websurfx/:/etc/xdg/websurfx/
  # Uncomment the following lines if you are using the `hybrid/latest` or `redis` image.
  # redis:
  #   image: redis:latest
  #   ports:
  #     - 6379:6379

Then create a directory websurfx in the directory you have placed the docker-compose.yml file, and then in the new directory create two new empty files named allowlist.txt and blocklist.txt. Finally, create a new config file config.lua with the default configuration, which looks something like this.:

lua
-- ### 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.

Then run the Docker image by running the following command:

shell
$ docker compose up -d

Then launch the browser of your choice and navigate to http://<ip_address_of_the_device>:<whatever_port_you_provided_in_the_config>.

For more in depth information on the deployment process. See: https://github.com/neon-mmd/websurfx/blob/rolling/docs/installation.md

Image Variants 🌳

The Websurfx images come in many flavors, which are based on the different features it provides.

For more information on features. See: https://github.com/neon-mmd/websurfx/blob/rolling/docs/features.md

neonmmd/websurfx:(hybrid/latest/<version>-hybrid)

This image is based on the hybrid caching feature of the Websurfx search engine, which enables both the Redis and In-Memory caching ability in the search engine.

neonmmd/websurfx:(memory/<version>-memory)

This image is based on the In-Memory caching feature of the Websurfx search engine, which enables the In-Memory caching ability in the search engine.

neonmmd/websurfx:(nocache/<version>-nocache)

This image is based on the No cache feature of the Websurfx search engine, which disables caching ability in the search engine.

neonmmd/websurfx:(redis/<version>-redis)

This image is based on the Redis caching feature of the Websurfx search engine, which enables the Redis caching ability in the search engine.

License 📜

View license information for the software contained in this image. See: https://github.com/neon-mmd/websurfx/blob/HEAD/LICENSE

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.