Readme Discord Instances User Showcase GitHub Documentation

A modern-looking, lightning-fast, privacy-respecting, secure meta search engine (pronounced as “websurface”) written in Rust. It provides a quick and secure search experience while completely respecting user privacy.

Getting Started

Welcome to the world of Websurfx! In this article, we’ll dive into how to set up and customize your very own meta search engine that respects user privacy. Stick around for troubleshooting tips as we go along.

Table of Contents

• Preview
• Features
• Instances
• Installation and Testing
• Configuration
• Theming
• Multi-Language Support
• System Requirements
• FAQ
• More Contributors Wanted
• Supporting Websurfx
• Documentation
• Roadmap
• Contributing
• License
• Credits

Preview

Instances

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

Features

• Adjust Websurfx with twelve default color schemes and the option for custom themes.
• Simple setup with Docker or on bare metal.
• Search filtering at four different levels.
• Built-in ranking algorithm for organic search results.
• Different caching levels for speed and reliability.
• Experimental IO-uring feature for performance on Linux.
• Fast, private, and secure – 100% free and open-source.
• Ad-free experience.

Installation and Testing

To get started, clone the repository, edit the configuration file, and install Redis. Here’s how:

git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
git checkout stable
cargo build -r
redis-server --port 8082
.target/release/websurfx

After running the above commands, visit http://127.0.0.1:8080 to start using Websurfx.

Note: The project is production-ready, but additional features like image search are still in the works.

Configuration

Configuration is managed via the config.lua file located in the websurfx/config.lua path. Customizing settings is straightforward!

Theming

Websurfx comes with pre-loaded themes and supports CSS-based custom themes. Modify them through the relevant config file easily.

Multi-Language Support

Currently, there is no multi-language support, but contributions to this area are welcome.

System Requirements

Websurfx currently supports x86_64 architecture systems.

FAQ

Why Websurfx?

Websurfx aims to provide a fast, secure, and privacy-focused search experience, addressing issues such as memory vulnerabilities and spam. Based on Rust, it safeguards user data meticulously.

Why AGPLv3?

This license ensures that the source code remains open and transparent, avoiding malware and unwanted telemetry.

Why Rust?

Rust ensures memory safety and higher performance, making Websurfx more responsive and secure.

More Contributors Wanted

If you’re interested in contributing to the project, check out the project board.

Supporting Websurfx

Your contributions are always welcome; whether they are code improvements, new themes, or even just stars on GitHub!

Documentation

We welcome contributions to the documentation.

Roadmap

Exciting features are on the horizon, stay tuned!

Contributing

Anyone can contribute, regardless of their skill level. Check out the CONTRIBUTING.md for more information.

License

Websurfx is licensed under the AGPLv3.

Credits

A special thanks to our contributors for their hard work and support!

Troubleshooting

If you encounter issues while setting up Websurfx, try the following:

• Ensure that all dependencies, such as Cargo and Redis, are correctly installed.
• Check that you have the correct permissions to run the necessary commands.
• Review the configuration file to ensure there are no syntax errors.

If problems persist, consider reaching out on our Discord for community support or revisit the documentation for more insights.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Thank you for Visiting!