alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-21 05:38:20 -05:00
Code Issues Releases Activity
Mirror of the Websurfx project https://github.com/neon-mmd/websurfx
18 Commits 3 Branches 274 Tags 12 MiB
Rust 81.4%
CSS 9.9%
JavaScript 4.7%
Lua 1.7%
Dockerfile 1.4%
Other 0.9%
b46dc992f3
Go to file
neon_arch b46dc992f3 changing license from GPLv3 to AGPLv3
2023-04-27 20:31:40 +03:00
images Add preview images, changes to installation step and add FAQ 2023-04-26 22:14:34 +03:00
public initial commit 2023-04-22 14:35:07 +03:00
src Improving source code documentation. 2023-04-27 17:53:28 +03:00
.gitignore initial commit 2023-04-22 14:35:07 +03:00
Cargo.lock add logging middleware 2023-04-25 18:57:18 +08:00
Cargo.toml add logging middleware 2023-04-25 18:57:18 +08:00
CONTRIBUTING.org initial commit 2023-04-22 14:35:07 +03:00
goals.org Marked goals as completed. 2023-04-27 17:56:08 +03:00
LICENSE changing license from GPLv3 to AGPLv3 2023-04-27 20:31:40 +03:00
README.org updating README.org 2023-04-27 20:19:04 +03:00

README.org

Websurfx

A lightening fast, privacy respecting, secure meta search engine. (pronounced as websurface or web-surface wɛbˈsɜːrfəs.)

Preview

Main Page

/alamin/websurfx/media/commit/b46dc992f32c65cf74f887ee0e144272b06a849e/images/main_page.png

Search Page

/alamin/websurfx/media/commit/b46dc992f32c65cf74f887ee0e144272b06a849e/images/search_page.png

404 Error Page

/alamin/websurfx/media/commit/b46dc992f32c65cf74f887ee0e144272b06a849e/images/404_error_page.png

Installation and Testing

To start installing, testing and playing around with search engine. Clone the repo and then cargo run as shown below:

  git clone https://gitlab.com/NEON-MMD/websurfx.git
  cd websurfx
  cargo build
  ./target/debug/websurfx --port 8080

If you want to be on the rolling/edge branch then do the following steps:

  git clone https://gitlab.com/NEON-MMD/websurfx.git
  cd websurfx
  git checkout rolling
  cargo build
  ./target/debug/websurfx --port 8080

and then open your browser of choice and visit http://127.0.0.1:8080 and then you can start playing with it right away.

Important Note: Do not over refresh your page or put too many requests or start hosting on production server as there are no behaviours right now in the code to prevent ip blocking (it is still work under process) and you can potential can get your ip blocked/banned and also the project is still under testing phase and far from being complete and ready to be hosted on production machines.

FAQ (Frequently Asked Questions)

Why Websurfx?

The main goal of the project is to provide a fast, secure and privacy focused meta search engine. Though there are many meta search engine out there but they don't provide gaurantee security of the their search engine which is essential because sometimes privacy is related to security like for example some memory vulnerabilities can leak private or sensitive information which is never good so the project being written in rust gaurantees memory safety and thus eliminating such problems and also many meta search engines lack many features like advanced image search (which is required by may graphics designers, content creators, etc), proper nsfw blocking (many links are still visible even on strict safe search), etc which *websurfx aims to provide.

Why AGPLv3?

The reason why I am releasing my meta search engine under AGPLv3 is because my main motive of this meta search is to provide privacy, speed and security to the user and GPL licensing or closed sourcing or any other licensing makes it loose for the user/server admin to not release the source code which is shady because you never know what he is putting in the source code lets say he is adding telemetry, spyware stuff, logging and what not which gets shady and is against privacy.

Why Rust?

Rust provides memory safe code which eliminates issues relating memory based vulnerabilites which makes the project more secure and less vulnerable to memory based bugs and issues and also rust being a faster programming language than c++ provides a much faster, smooth and secure meta search engine :).

Contributing

Contributions are welcome. It does not matter who you are you can still contribute to the project in your way :).

Not a developer but still want to contribute

Here is video by Mr. Nick on how to contribute and credit to him as well

Developer

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

License

The project is available under the GPLv3 license.

Credits

Thanks to this wonderful people for contributing and supporting this project: