Mirror of the Websurfx project https://github.com/neon-mmd/websurfx
Go to file
dependabot[bot] c077e39ae7
build(deps): bump softprops/action-gh-release from 1 to 2 (#553)
2024-04-02 20:32:37 +00:00
.github build(deps): bump softprops/action-gh-release from 1 to 2 (#553) 2024-04-02 20:32:37 +00:00
docs 📝 docs(instances): more instances with the rolling/edge version (#495) 2024-02-08 07:52:16 +03:00
images [ImgBot] Optimize images 2023-12-14 16:41:11 +00:00
public Rose pine colorscheme variants for the search engine (#550) 2024-03-24 07:31:17 +00:00
src feat(config): config option to timeout idle connections within the reqwest pool (#551) 2024-03-30 16:05:44 +03:00
tests perf: several optimizations for improving the performance of the engine (#540) 2024-03-11 12:01:30 +03:00
websurfx feat(config): config option to timeout idle connections within the reqwest pool (#551) 2024-03-30 16:05:44 +03:00
.dockerignore add support for dockerized container hosting 2023-05-09 18:53:12 +03:00
.gitignore fix: pass nix flake check; ignore result 2023-09-27 09:04:36 +02:00
.gitpod.Dockerfile 🛠️ fix: add luajit installation step (#225) 2023-09-11 20:28:09 +03:00
.gitpod.yml Use the correct command to run the app in `GitPod` 2023-09-20 21:07:51 +08:00
.mergify.yml 🤖 Improve the rules used by the `Mergify` bot. (#338) 2023-10-18 17:37:55 +03:00
.rusty-hook.toml chore: add pre-commit checks for writting better code 2023-06-01 12:25:36 +03:00
.stylelintrc.json 🩹 fix: remove unnecessary `stylelint` checks by disabling them in the `stylelint` config file (#375) 2023-11-03 12:04:31 +03:00
CONTRIBUTING.md 📝 Typo correction in the `contributing` documentation (#363) 2023-10-29 17:04:52 +03:00
Cargo.lock Ranking of aggregated search results based on relevancy of the search result to the user's search query (#549) 2024-03-25 09:16:49 +00:00
Cargo.toml Ranking of aggregated search results based on relevancy of the search result to the user's search query (#549) 2024-03-25 09:16:49 +00:00
Dockerfile build(deps): bump rust from 1.75.0-alpine3.18 to 1.76.0-alpine3.18 (#539) 2024-03-02 11:23:07 +00:00
LICENSE changing license from GPLv3 to AGPLv3 2023-04-27 20:31:40 +03:00
PULL_REQUEST_TEMPLATE.md fix spelling 2023-06-29 19:40:49 +02:00
README.md 📝 Maintained badge/shield status in the readme from stale to yes/maintained #500 (#503) 2024-01-30 07:20:14 +00:00
SECURITY.md add security policy, config.yml for issue templates and add pull request template 2023-05-04 12:28:07 +03:00
build.rs 🚨 chore: make clippy linter happy (#359) 2023-10-30 19:44:28 +03:00
dev.Dockerfile build(deps): bump rust from 1.75.0-alpine3.18 to 1.76.0-alpine3.18 (#539) 2024-03-02 11:23:07 +00:00
dev.docker-compose.yml Docker compose for development (#336) 2023-10-17 19:47:53 +03:00
docker-compose.yml 🔧 Remove the unused mapped ports for docker deployment (#309) 2023-10-09 20:09:12 +03:00
flake.lock feat: add flake.nix to allow building NixOS packages 2023-09-27 08:37:45 +02:00
flake.nix feat(engine): `mojeek` for the search engine (#464) 2023-12-29 19:21:06 +03:00

README.md

websurfx logo

Readme | Discord | Instances | User Showcase | GitHub | Documentation

Awesome Self-Hosted GitHub code size in bytes GitHub Workflow Status Maintenance CodeFactor Gitpod

A modern-looking, lightning-fast, privacy-respecting, secure meta search engine (pronounced as websurface or web-surface /wɛbˈːrfəs/.) written in Rust. It provides a quick and secure search experience while completely respecting user privacy.

Table of Contents

Preview 🔭

Home Page

Search Page

404 Error Page

⬆️ Back to Top

Instances 🔗

For a full list of publicly available community driven websurfx instances to test or for daily use. see Instances

⬆️ Back to Top

Features 🚀

  • 🎨 Make Websurfx uniquely yours with the twelve color schemes provided by default. It also supports the creation of custom themes and color schemes in a quick and easy way, so unleash your creativity!
  • 🚀 Easy to setup with Docker or on bare metal with various installation and deployment options.
  • Search filtering to filter search results based on four different levels.
  • 💾 Different caching levels focusing on reliability, speed and resiliancy.
  • 🔐 Fast, private, and secure
  • 🆓 100% free and open source
  • 💨 Ad-free and clean results
  • 🌟 and lots more...

⬆️ Back to Top

Installation and Testing 🛠️

For full setup instructions, see: Installation

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

To get started with Websurfx, clone the repository, edit the config file, which is located in the websurfx/ directory, and install the Redis server by following the instructions located here and then run the websurfx server and redis server using 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.

[!Note]

  1. The project is no longer in the testing phase and is now ready for production use.
  2. There are many features still missing, like support for image search, different categories, quick apps, etc., but they will be added soon as part of future releases.

⬆️ Back to Top

Configuration 🔧

For full configuration instructions, see: Configuration

Websurfx is configured through the config.lua file, located at websurfx/config.lua.

⬆️ Back to Top

Theming 🎨

For full theming and customization instructions, see: Theming

Websurfx comes loaded with several themes and color schemes, which you can apply and edit through the config file. It also supports custom themes and color schemes using CSS, allowing you to make it truly yours.

⬆️ Back to Top

Multi-Language Support 🌍

[!Note] Currently, we do not support other languages, but we will start accepting contributions regarding language support in the future. We believe language should never be a barrier to entry.

⬆️ Back to Top

System Requirements 📊

At present, we only support x86_64 architecture systems, but we would love to have contributions that extend to other architectures as well.

⬆️ Back to Top

FAQ (Frequently Asked Questions) 🗨️

Why Websurfx?

The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused meta-search engine. There are numerous meta-search engines available, but not all guarantee the security of their search engines, which is critical for maintaining privacy. Memory flaws, for example, can expose private or sensitive information, which is understandably bad. There is also the added problem of spam, ads, and inorganic results, which most engines don't have a full-proof answer to. Until now. With Websurfx, I finally put a full stop to this problem. Websurfx is based on Rust, which ensures memory safety and removes such issues. Many meta-search engines also lack important features like advanced picture search, required by graphic designers, content providers, and others. Websurfx improves the user experience by providing these and other features, such as proper NSFW blocking and micro-apps or quick results (providing a calculator, currency exchanges, etc. in the search results).

Why AGPLv3?

Websurfx is distributed under the AGPLv3 license to keep the source code open and transparent. This helps keep malware, telemetry, and other dangers out of the project. AGPLv3 is a strong copyleft license that ensures the software's source code, including any modifications or improvements made to the code, remains open and available to everyone.

Why Rust?

Websurfx is based on Rust due to its memory safety features, which prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, contributing to Websurfx's speed and responsiveness. Finally, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.

⬆️ Back to Top

More Contributors Wanted 📣

We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the project board and the CONTRIBUTING.md file for guidelines and rules for making contributions.

⬆️ Back to Top

Supporting Websurfx 💖

For full details and other ways you can help out, see: Contributing

If you use Websurfx and would like to contribute to its development, we're glad to have you on board! Contributions of any size or type are always welcome, and we will always acknowledge your efforts.

Several areas that we need a bit of help with at the moment are:

  • Better and more color schemes: Help fix color schemes and add other famous color schemes.
  • Improve evasion code for bot detection: Help improve code related to evading IP blocking and emulating human behaviors located in everyone's engine file.
  • Logo: Help create a logo for the project and website.
  • Docker Support: Help write a Docker Compose file for the project.
  • Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or anything else.
  • Star Websurfx on GitHub.

⬆️ Back to Top

Documentation 📘

[!Note] We welcome any contributions to the documentation as this will benefit everyone who uses this project.

⬆️ Back to Top

Roadmap 🛣️

Coming soon! 🙂.

⬆️ Back to Top

Contributing 🙋

Contributions are welcome from anyone. It doesn't matter who you are; you can still contribute to the project in your own way.

Not a developer but still want to contribute?

Check out this video by Mr. Nick on how to contribute.

Developer

If you are a developer, have a look at the CONTRIBUTING.md document for more information.

⬆️ Back to Top

License 📜

Websurfx is licensed under the AGPLv3 license.

⬆️ Back to Top

Credits 🤝

We would like to thank the following people for their contributions and support:

Contributors



Stargazers

⬆️ Back to Top




Thank you for Visiting