mirror of
https://github.com/neon-mmd/websurfx.git
synced 2024-11-21 13:38:21 -05:00
Merge branch 'stable' into rolling
This commit is contained in:
neon_arch
commit
403166c0dd
18
.github/workflows/hello.yml
vendored
Normal file
18
.github/workflows/hello.yml
vendored
Normal file
@ -0,0 +1,18 @@
|
||||
name: Welcome first time contributors
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
types:
|
||||
- opened
|
||||
|
||||
jobs:
|
||||
welcome:
|
||||
name: Welcome
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/first-interaction@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pr-message: |-
|
||||
Congrats on making your first Pull Request and thanks for taking the time to improve Websurfx! ❤️!
|
||||
Say hello by joining the conversation in our [Discord](https://discord.gg/SWnda7Mw5u)
|
||||
4
.github/workflows/labels.yml
vendored
4
.github/workflows/labels.yml
vendored
@ -3,7 +3,7 @@ name: Import open source standard labels
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- rolling
|
||||
|
||||
jobs:
|
||||
labels:
|
||||
@ -19,4 +19,4 @@ jobs:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
owner-name: ${{ github.repository_owner }}
|
||||
repository-name: ${{ github.event.repository.name }}
|
||||
force: true # optional to clear existing labels, default to true
|
||||
force: false
|
||||
|
||||
@ -1,34 +1,54 @@
|
||||
# Things to Consider Before Contributing
|
||||
# What You Can Contribute To?
|
||||
|
||||
## Knowledge Required
|
||||
## Documentation/Wiki
|
||||
|
||||
- Rust basics
|
||||
- Actix-web crate basics
|
||||
- Tokio crate and async/await
|
||||
- Reqwest crate basics
|
||||
- Serde and serde~json~ crate basics
|
||||
- fake~useragent~ crate basics
|
||||
- pyo3/hlua/rlua crates basics
|
||||
Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Edit the [wiki](https://github.com/neon-mmd/websurfx/wiki) to add to or improve the documentation. This will help future users get Websurfx up and running more easily.
|
||||
|
||||
## Readme
|
||||
|
||||
Found a typo, or the Readme is not very clear as it should be?. Consider Submitting a Pull request to the [Readme](https://github.com/neon-mmd/websurfx/blob/master/README.md) to add to or improve the Readme. This will help future users to better understand the project more clearly.
|
||||
|
||||
## Help Improve Github Actions
|
||||
|
||||
Know how to fix or improve a github action?. Consider Submitting a Pull request to help make automation and testing better.
|
||||
|
||||
## Source Code
|
||||
|
||||
You should know atleast one of the things below to start contributing:
|
||||
|
||||
- Rust basics
|
||||
- Actix-web crate basics
|
||||
- Tokio crate and async/await
|
||||
- Reqwest crate basics
|
||||
- Serde and serde_json crate basics
|
||||
- Scraper crate basics
|
||||
- Frontend (handlebars, css and js).
|
||||
- Fake useragent crate basics
|
||||
- pyo3/hlua/rlua crates basics
|
||||
|
||||
## Report a Bug/Issue
|
||||
|
||||
If you've found a bug, then please consider raising it as an issue [here](https://github.com/neon-mmd/websurfx/issues). This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.
|
||||
|
||||
## Spread the word
|
||||
|
||||
Websurfx is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms.
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Please be patient.
|
||||
- Please be patient.
|
||||
- Treat everyone with respect -- \"give respect and take respect.\"
|
||||
- Document your code properly with Rust coding conventions in mind.
|
||||
- Provide a brief description of the changes you made in the pull request.
|
||||
- Provide an appropriate header for the pull request.
|
||||
|
||||
- Treat everyone with respect -- \"give respect and take respect.\"
|
||||
## Join the discussion
|
||||
|
||||
- Document your code properly with Rust coding conventions in mind.
|
||||
We have a [Discord](https://discord.gg/SWnda7Mw5u) channel, feel free to join and share your ideas and ask questions about the project, we would be glad to hear you out.
|
||||
|
||||
- Provide a brief description of the changes you made in the pull
|
||||
request.
|
||||
# Where To Contribute?
|
||||
|
||||
- Provide an appropriate header for the pull request.
|
||||
The _rolling branch_ is where we intend all contributions should go.
|
||||
|
||||
**NOTE:** The rolling branch is where all contributions should go.
|
||||
In other words, it is the working branch for this project.
|
||||
|
||||
We appreciate any contributions and suggestions to help improve the
|
||||
Websurfx project. Please keep in mind the above requirements and
|
||||
guidelines before submitting a pull request and also if you have any
|
||||
doubts/concerns/questions about the project, its source code or anything
|
||||
related to the project than feel free to ask by opening an
|
||||
\[issue\](<https://github.com/neon-mmd/websurfx/issues>).
|
||||
We appreciate any contributions whether be of any size or topic and suggestions to help improve the Websurfx project. Please keep in mind the above requirements and guidelines before submitting a pull request and also if you have any doubts/concerns/questions about the project, its source code or anything related to the project than feel free to ask by opening an [issue](https://github.com/neon-mmd/websurfx/issues) or by asking us on our [Discord](https://discord.gg/SWnda7Mw5u) channel.
|
||||
|
||||
142
README.md
142
README.md
@ -1,68 +1,34 @@
|
||||
<h1 align="center">Websurfx</h1>
|
||||
<h1 align="center">
|
||||
<img src="./images/websurfx_logo.png" alt="websurfx logo" align="center" />
|
||||
</h1>
|
||||
<p align="center">
|
||||
<b align="center"><a href="README.org">Readme</a></b> |
|
||||
<b align="center"><a href="README.md">Readme</a></b> |
|
||||
<b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
|
||||
<b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
|
||||
<b><a href="https://github.com/neon-mmd/websurfx/wiki">Documentation</a></b>
|
||||
<b><a href="./docs/README.md">Documentation</a></b>
|
||||
<br /><br />
|
||||
<a href="./LICENSE">
|
||||
<img
|
||||
alt="GitHub"
|
||||
src="https://img.shields.io/github/license/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/neon-mmd/websurfx/stargazers">
|
||||
<img
|
||||
alt="GitHub Repo stars"
|
||||
src="https://img.shields.io/github/stars/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/neon-mmd/websurfx/forks">
|
||||
<img
|
||||
alt="GitHub forks"
|
||||
src="https://img.shields.io/github/forks/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="#">
|
||||
<img
|
||||
alt="GitHub code size in bytes"
|
||||
src="https://img.shields.io/github/languages/code-size/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/neon-mmd/websurfx/issues">
|
||||
<img
|
||||
alt="GitHub issues"
|
||||
src="https://img.shields.io/github/issues/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/neon-mmd/websurfx/pulls">
|
||||
<img
|
||||
alt="GitHub pull requests"
|
||||
src="https://img.shields.io/github/issues-pr/neon-mmd/websurfx?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/neon-mmd/websurfx/actions">
|
||||
<img
|
||||
alt="GitHub Workflow Status"
|
||||
src="https://img.shields.io/github/actions/workflow/status/neon-mmd/websurfx/rust.yml?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="">
|
||||
<img
|
||||
alt="GitHub release (latest by date including pre-releases)"
|
||||
src="https://img.shields.io/github/v/release/neon-mmd/websurfx?include_prereleases"
|
||||
/>
|
||||
</a>
|
||||
<a href=""
|
||||
><img
|
||||
alt="Maintenance"
|
||||
src="https://img.shields.io/maintenance/yes/2023?style=flat-square"
|
||||
/>
|
||||
</a>
|
||||
<a href="">
|
||||
<a href="https://gitpod.io/#https://github.com/neon-mmd/websurfx">
|
||||
<img
|
||||
alt="GitHub contributors"
|
||||
src="https://img.shields.io/github/contributors-anon/neon-mmd/websurfx?style=flat-square"
|
||||
alt="Gitpod"
|
||||
src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod"
|
||||
/>
|
||||
</a>
|
||||
<br />
|
||||
@ -73,7 +39,7 @@
|
||||
>meta search engine</a
|
||||
>
|
||||
(pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It
|
||||
provides a fast and secure search experience while respecting user
|
||||
provides a quick and secure search experience while maintaining user
|
||||
privacy.</i
|
||||
>
|
||||
</p>
|
||||
@ -84,7 +50,7 @@
|
||||
|
||||
- **Getting Started**
|
||||
- [🔭 Preview](#preview-)
|
||||
- [🌈 Features](#features-)
|
||||
- [🚀 Features](#features-)
|
||||
- [🛠️ Installation and Testing](#installation-and-testing-)
|
||||
- [🔧 Configuration](#configuration-)
|
||||
- **Feature Overview**
|
||||
@ -118,30 +84,32 @@
|
||||
|
||||
<img align="center" src="./images/404_error_page.png" />
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Features 🌈
|
||||
# Features 🚀
|
||||
|
||||
- 🎨 High level customizability with 9 colorchemes provided by default with a simple theme, also supporting creation of your custom themes and colorschemes very quickly and easily
|
||||
- 🔐 Fast, private and secure
|
||||
- 🎨 High level of customizability with nine color schemes provided by default with a simple theme, also supporting the creation of your custom themes and colorschemes very quickly and easily
|
||||
- 🔐 Fast, private, and secure
|
||||
- 🆓 100% free and open source
|
||||
- 🧹 Ad free and clean results
|
||||
- 🌈 and lots more...
|
||||
- 💨 Ad-free and clean results
|
||||
- 🌟 and lots more...
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Installation and Testing 🛠️
|
||||
|
||||
> For full setup instructions, see: [**Installation**](https://github.com/neon-mmd/websurfx/wiki/installation)
|
||||
> For full setup instructions, see: [**Installation**](./docs/installation.md)
|
||||
|
||||
To get started with Websurfx, clone the repository, edit the config file which is located in the `websurfx`{.verbatim} directory and install redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands:
|
||||
Before you can start building `websurfx`, you will need to have `Cargo` installed on your system. You can find the installation instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
|
||||
|
||||
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](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands:
|
||||
|
||||
``` shell
|
||||
git clone https://github.com/neon-mmd/websurfx.git
|
||||
cd websurfx
|
||||
cargo build
|
||||
redis-server -p 8082 &
|
||||
./target/debug/websurfx
|
||||
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.
|
||||
@ -149,91 +117,91 @@ Once you have started the server, open your preferred web browser and navigate t
|
||||
> **Warning**
|
||||
> Please be aware that the project is still in the testing phase and is not ready for production use.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Configuration 🔧
|
||||
|
||||
> For full configuration instructions, see: [**Configuration**](https://github.com/neon-mmd/websurfx/wiki/configuration)
|
||||
> For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
|
||||
|
||||
Websurfx is configured through the config.lua file, located at `websurfx/config.lua`.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Theming 🎨
|
||||
|
||||
> For full theming and customization instructions, see: [**Theming**](https://github.com/neon-mmd/websurfx/wiki/theming)
|
||||
> For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
|
||||
|
||||
Websurfx comes with several themes and colorschemes by default which you can apply and edit through the config file. Support for custom themes and colorschemes using css and develop your own unique-looking website.
|
||||
Websurfx comes with several themes and color schemes by default, which you can apply and edit through the config file. Supports custom themes and color schemes using CSS, allowing you to develop your own unique-looking website.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Multi-Language Support 🌍
|
||||
|
||||
> **Note**
|
||||
> Currently, we do not support other languages but in future we would start accepting contributions regarding language support because we believe that language should not be a barrier for entry.
|
||||
> Currently, we do not support other languages, but in the future, we will start accepting contributions regarding language support because we believe that language should not be a barrier to entry.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# System Requirements 📊
|
||||
|
||||
At present, we only support x86_64 architecture systems but will love to have contributions to extend to other architectures as well.
|
||||
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](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# FAQ (Frequently Asked Questions) 🗨️
|
||||
|
||||
## Why Websurfx?
|
||||
|
||||
The main goal of the Websurfx project is to provide a fast, secure, and privacy-focused [meta search engine](https://en.wikipedia.org/wiki/Metasearch_engine). While there are many meta search engines available, they do not always guarantee the security of their search engine, which is essential for ensuring privacy. For example, memory vulnerabilities can leak private or sensitive information, which is never good. Websurfx is written in Rust, which guarantees memory safety and eliminates such problems. Many meta search engines also lack key features such as advanced image search, which is required by many graphic designers, content creators, and others. Websurfx aims to provide these features and others, such as proper NSFW blocking, to improve the user experience.
|
||||
The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused meta-search engine. While there are numerous meta-search engines available, not all of them guarantee the security of their search engine, which is critical for maintaining privacy. Memory flaws, for example, can expose private or sensitive information, which is never a good thing. Also, there is the added problem of Spam, ads, and unorganic results which most engines don't have the full-proof answer to it till now but with Websurfx I finally put a full stop to this problem, also, Rust is used to write Websurfx, which ensures memory safety and removes such issues. Many meta-search engines also lack important features like advanced picture search, which is required by many graphic designers, content providers, and others. Websurfx attempts to improve the user experience by providing these and other features, such as proper NSFW blocking and Micro-apps or Quick results (like providing a calculator, currency exchanges, etc in the search results).
|
||||
|
||||
## Why AGPLv3?
|
||||
|
||||
Websurfx is released under the **AGPLv3** license to ensure that the source code remains open and transparent. This helps to prevent the inclusion of spyware, telemetry, or other malicious code in the project. **AGPLv3** is a strong copyleft license that ensures the source code of the software remains open and available to everyone, including any modifications or improvements made to the code.
|
||||
Websurfx is distributed under the **AGPLv3** license to keep the source code open and transparent. This helps to keep malware, telemetry, and other dangerous programs 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?
|
||||
|
||||
Rust was chosen as the programming language for Websurfx due to its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which helps to make Websurfx fast and responsive. In addition, Rust\'s ownership and borrowing system allows for safe concurrency and thread safety in the codebase.
|
||||
Rust was chosen as the programming language for Websurfx because of its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which contributes to Websurfx's speed and responsiveness. Furthermore, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# More Contributers 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](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.org](CONTRIBUTING.org) file for guidelines and rules for making contributions.
|
||||
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](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines and rules for making contributions.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Supporting Websurfx 💖
|
||||
|
||||
> For full details and other ways you can help out, see: [**Contributing**]()
|
||||
|
||||
If you're using Websurfx and would like to help support its development, then that would be awesome! Contributions of any type, any size, are always very much appreciated, and we will appropriately credit you for your effort.
|
||||
If you use Websurfx and would like to contribute to its development, that would be fantastic! Contributions of any size or type are always welcome, and we will properly acknowledge your efforts.
|
||||
|
||||
Several areas that we need a bit of help with at the moment are:
|
||||
- **Better and more colorchemes** - Help fix colorchemes and add other famous colorchemes.
|
||||
- **Improve evasion code for bot detection** - Help improve code related to evade ip blocking and emulate human behaviours located in everyone engine file.
|
||||
- **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 something else.
|
||||
- **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 something else.
|
||||
- Star Websurfx on GitHub.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Documentation 📘
|
||||
|
||||
> **Note**
|
||||
> We are willing to have any contribution regarding [documentation](https://github.com/neon-mmd/websurfx/wiki) as this helps everyone using this project.
|
||||
> We welcome any contributions to the [documentation](./docs/) as this will benefit everyone who uses this project.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Roadmap 🛣️
|
||||
|
||||
> Coming soon!! 🙂.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ 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 way.
|
||||
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?
|
||||
|
||||
@ -241,15 +209,15 @@ Check out this [video](https://youtu.be/FccdqCucVSI) by Mr. Nick on how to contr
|
||||
|
||||
## Developer
|
||||
|
||||
If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.org) document for more information.
|
||||
If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) document for more information.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# License 📜
|
||||
|
||||
Websurfx is available under the [AGPLv3](LICENSE) license.
|
||||
Websurfx is licensed under the [AGPLv3](LICENSE) license.
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
# Credits 🤝
|
||||
|
||||
@ -263,7 +231,7 @@ We would like to thank the following people for their contributions and support:
|
||||
<br />
|
||||
</p>
|
||||
|
||||
**[⬆️ Back to Top](#websurfx)**
|
||||
**[⬆️ Back to Top](#--)**
|
||||
|
||||
---
|
||||
|
||||
|
||||
17
docs/README.md
Normal file
17
docs/README.md
Normal file
@ -0,0 +1,17 @@
|
||||
<h1 align="center"><img src="../images/websurfx_docs_image.png" alt="Websurfx Docs" align="center"></h1>
|
||||
|
||||
# General
|
||||
|
||||
- [Introduction](./introduction.md)
|
||||
- [**FAQ**](./faq.md)
|
||||
|
||||
# Users
|
||||
|
||||
- [Installation](./installation.md)
|
||||
- [Configuration](./configuration.md)
|
||||
- [Theming](./theming.md)
|
||||
|
||||
# Developers
|
||||
|
||||
- [**Contribute**](https://github.com/neon-mmd/websurfx/blob/master/CONTRIBUTING.md)
|
||||
- [**Coding style**](https://rust-lang.github.io/api-guidelines/naming.html)
|
||||
52
docs/configuration.md
Normal file
52
docs/configuration.md
Normal file
@ -0,0 +1,52 @@
|
||||
# Configuration
|
||||
|
||||
## Installed From Source
|
||||
|
||||
If you have built `websurfx` from source then the configuration file will be located under project directory (codebase) at `websurfx/`
|
||||
|
||||
> **Note**
|
||||
> If you have built websurfx with unstable/rolling/edge branch then you can copy the configuration file from `websurfx/config.lua` located under project directory (codebase) to `~/.config/websurfx/` and make the changes there and rerun the websurfx server. _This is only available from unstable/rolling/edge version_.
|
||||
|
||||
## Installed From Package
|
||||
|
||||
If you have installed `websurfx` using the package manager of your Linux distro then the default configuration file will be located at `/etc/xdg/websurfx/`. You can copy the default config to `~/.config/websurfx/` and make the changes there and rerun the websurfx server.
|
||||
|
||||
Some of the configuration options provided in the file are stated below. These are subdivided into three categories:
|
||||
|
||||
- Server
|
||||
- Website
|
||||
- Cache
|
||||
|
||||
## Server
|
||||
|
||||
- **port:** Port number on which server should be launched.
|
||||
- **binding_ip_addr:** IP address on the which server should be launched.
|
||||
- **production_use:** 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). 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. This is newly added option and hence is only available in the **edge version**.
|
||||
|
||||
## Website
|
||||
|
||||
- **colorscheme:** The colorscheme name which should be used for the website theme (the name should be in accordance to the colorscheme file name present in `public/static/colorschemes` folder).
|
||||
|
||||
> By Default we provide 9 colorschemes to choose from these are:
|
||||
>
|
||||
> 1. catppuccin-mocha
|
||||
> 2. dracula
|
||||
> 3. monokai
|
||||
> 4. nord
|
||||
> 5. oceanic-next
|
||||
> 6. solarized-dark
|
||||
> 7. solarized-light
|
||||
> 8. tomorrow-night
|
||||
> 9. gruvbox-dark
|
||||
|
||||
- **theme:** The theme name which should be used for the website (again, the name should be in accordance to the theme file name present in `public/static/themes` folder).
|
||||
|
||||
> By Default we provide 1 theme to choose from these are:
|
||||
>
|
||||
> 1. simple
|
||||
|
||||
## Cache
|
||||
|
||||
- **redis_connection_url:** Redis connection url address on which the client should connect on.
|
||||
|
||||
[⬅️ Go back to Home](./README.md)
|
||||
15
docs/faq.md
Normal file
15
docs/faq.md
Normal file
@ -0,0 +1,15 @@
|
||||
# General Questions
|
||||
|
||||
## Why Websurfx?
|
||||
|
||||
The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused [meta-search engine](https://en.wikipedia.org/wiki/Metasearch_engine). While there are numerous meta-search engines available, not all of them guarantee the security of their search engine, which is critical for maintaining privacy. Memory flaws, for example, can expose private or sensitive information, which is never a good thing. Also, there is the added problem of Spam, ads, and unorganic results which most engines don't have the full-proof answer to it till now but with Websurfx I finally put a full stop to this problem, also, Rust is used to write Websurfx, which ensures memory safety and removes such issues. Many meta-search engines also lack important features like advanced picture search, which is required by many graphic designers, content providers, and others. Websurfx attempts to improve the user experience by providing these and other features, such as proper NSFW blocking and Micro-apps or Quick results (like providing a calculator, currency exchanges, etc in the search results).
|
||||
|
||||
## Why AGPLv3?
|
||||
|
||||
Websurfx is released under the AGPLv3 license to ensure that the source code remains open and transparent. This helps to prevent the inclusion of spyware, telemetry, or other malicious code in the project. AGPLv3 is a strong copyleft license that ensures the source code of the software remains open and available to everyone, including any modifications or improvements made to the code.
|
||||
|
||||
## Why Rust?
|
||||
|
||||
Rust was chosen as the programming language for Websurfx due to its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which helps to make Websurfx fast and responsive. In addition, Rust's ownership and borrowing system allows for safe concurrency and thread safety in the codebase.
|
||||
|
||||
[⬅️ Go back to Home](./README.md)
|
||||
124
docs/installation.md
Normal file
124
docs/installation.md
Normal file
@ -0,0 +1,124 @@
|
||||
# Install From Package
|
||||
|
||||
## Arch Linux
|
||||
|
||||
You can install `Websurfx` through the [Aur](https://aur.archlinux.org/packages/websurfx-git), Currently we only support `Rolling/Edge` version. You can install the rolling/edge version by running the following command (using [paru](https://github.com/Morganamilo/paru)):
|
||||
|
||||
```bash
|
||||
paru -S websurfx-edge-git
|
||||
```
|
||||
|
||||
After installing it you can run the websurfx server by running the following commands:
|
||||
|
||||
``` bash
|
||||
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](./configuration.md).
|
||||
|
||||
## 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](https://doc.rust-lang.org/cargo/getting-started/installation.html).
|
||||
|
||||
## 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](https://redis.io/docs/getting-started/) and then build and run the websurfx server by running the following commands:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/neon-mmd/websurfx.git
|
||||
cd websurfx
|
||||
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](./configuration.md).
|
||||
|
||||
## Rolling/Edge/Unstable
|
||||
|
||||
If you want to use the rolling/edge branch, run the following commands instead:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/neon-mmd/websurfx.git
|
||||
cd websurfx
|
||||
git checkout rolling
|
||||
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](./configuration.md).
|
||||
|
||||
# Docker Deployment
|
||||
|
||||
Before you start, you will need [Docker](https://docs.docker.com/get-docker/) installed on your system first.
|
||||
|
||||
## Stable
|
||||
|
||||
First clone the the repository by running the following command:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```lua
|
||||
-- Server
|
||||
port = "8080" -- port on which server should be launched
|
||||
binding_ip_addr = "0.0.0.0" --ip address on the which server should be launched.
|
||||
|
||||
-- Website
|
||||
-- The different colorschemes provided are:
|
||||
-- {{
|
||||
-- catppuccin-mocha
|
||||
-- dracula
|
||||
-- monokai
|
||||
-- nord
|
||||
-- oceanic-next
|
||||
-- solarized-dark
|
||||
-- solarized-light
|
||||
-- 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_connection_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on.
|
||||
|
||||
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)
|
||||
-- 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.
|
||||
```
|
||||
|
||||
After this run the following command to deploy the app:
|
||||
|
||||
```bash
|
||||
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>`.
|
||||
|
||||
## Unstable/Edge/Rolling
|
||||
|
||||
For the unstable/rolling/edge version, follow the same steps as above (as mentioned for the stable 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:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/neon-mmd/websurfx.git
|
||||
cd websurfx
|
||||
git checkout rolling
|
||||
```
|
||||
|
||||
[⬅️ Go back to Home](./README.md)
|
||||
13
docs/introduction.md
Normal file
13
docs/introduction.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Introduction
|
||||
|
||||
A modern-looking, lightning-fast, privacy-respecting, secure [meta search engine](https://en.wikipedia.org/wiki/Metasearch_engine) (pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It provides a fast and secure search experience while respecting user privacy.
|
||||
|
||||
# Motivation
|
||||
|
||||
Most meta search engines tend to be slow, lack high level of customization and missing many features and all of them like security as they are written in unsafe languages like python, javascript, etc which tend to open a wide variety of vulnerabilities which can also sometimes pose a threat to privacy as sometimes this can be exploited and can be used to leveraged to leak out sensitive information which is never good.
|
||||
|
||||
# Solution
|
||||
|
||||
Websurfx is a project which seeks to provide privacy, security, speed and all the features which the user wants.
|
||||
|
||||
[⬅️ Go back to Home](./README.md)
|
||||
365
docs/theming.md
Normal file
365
docs/theming.md
Normal file
@ -0,0 +1,365 @@
|
||||
# Colorschemes
|
||||
|
||||
## Built-in
|
||||
|
||||
By default `websurfx` comes with 9 colorschemes to choose from which can be easily chosen using the config file. To how to change colorschemes please view the [Configuration](https://github.com/neon-mmd/websurfx/wiki/configuration) section of the wiki.
|
||||
|
||||
## Custom
|
||||
|
||||
Creating coloschemes is as easy as it gets it requires the user to have a theme file name with the colorscheme in which every space should be replaced with a `-` (dash) and it should end with a `.css` file extension. After creating the file you need to add the following code with the `colors` you want:
|
||||
|
||||
``` css
|
||||
:root{
|
||||
--bg: <background color>;
|
||||
--fg: <foreground color (text color)>;
|
||||
--1: <color 1>;
|
||||
--2: <color 2>;
|
||||
--3: <color 3>;
|
||||
--4: <color 4>;
|
||||
--5: <color 5>;
|
||||
--6: <color 6>;
|
||||
--7: <color 7>;
|
||||
}
|
||||
```
|
||||
|
||||
> **Note**
|
||||
> Please infer the theme file located under `public/static/themes` to better understand where each color is being used.
|
||||
|
||||
**Example of `catppuccin-mocha` colorscheme:**
|
||||
|
||||
``` css
|
||||
:root {
|
||||
--bg: #1e1e2e;
|
||||
--fg: #cdd6f4;
|
||||
--1: #45475a;
|
||||
--2: #f38ba8;
|
||||
--3: #a6e3a1;
|
||||
--4: #f9e2af;
|
||||
--5: #89b4fa;
|
||||
--6: #f5c2e7;
|
||||
--7: #ffffff;
|
||||
}
|
||||
```
|
||||
|
||||
# Themes
|
||||
|
||||
## Built-in
|
||||
|
||||
By default `websurfx` comes with 1 theme to choose from which can be easily chosen using the config file. To how to change themes please view the [Configuration](https://github.com/neon-mmd/websurfx/wiki/configuration) section of the wiki.
|
||||
|
||||
## Custom
|
||||
|
||||
To write custom color scheme, it requires the user to have some knowledge of `css stylesheets`.
|
||||
|
||||
**Here is an example of `simple theme` (which we provide by default with the app) which will give the user a better idea on how to create a custom theme using it as a template:**
|
||||
|
||||
### General
|
||||
``` css
|
||||
* {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html {
|
||||
font-size: 62.5%;
|
||||
}
|
||||
|
||||
body {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
height: 100vh;
|
||||
background: var(--1);
|
||||
}
|
||||
```
|
||||
### Styles for the index page
|
||||
``` css
|
||||
.search-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 5rem;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.search-container div {
|
||||
display: flex;
|
||||
}
|
||||
```
|
||||
### Styles for the search box and search button
|
||||
``` css
|
||||
.search_bar {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.search_bar input {
|
||||
padding: 1rem;
|
||||
width: 50rem;
|
||||
height: 3rem;
|
||||
outline: none;
|
||||
border: none;
|
||||
box-shadow: rgba(0, 0, 0, 1);
|
||||
background: var(--fg);
|
||||
}
|
||||
|
||||
.search_bar button {
|
||||
padding: 1rem;
|
||||
border-radius: 0;
|
||||
height: 3rem;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
outline: none;
|
||||
border: none;
|
||||
gap: 0;
|
||||
background: var(--bg);
|
||||
color: var(--3);
|
||||
font-weight: 600;
|
||||
letter-spacing: 0.1rem;
|
||||
}
|
||||
|
||||
.search_bar button:active,
|
||||
.search_bar button:hover {
|
||||
filter: brightness(1.2);
|
||||
}
|
||||
```
|
||||
### Styles for the footer and header
|
||||
``` css
|
||||
header {
|
||||
background: var(--bg);
|
||||
width: 100%;
|
||||
display: flex;
|
||||
justify-content: right;
|
||||
align-items: center;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
header ul,
|
||||
footer ul {
|
||||
list-style: none;
|
||||
display: flex;
|
||||
justify-content: space-around;
|
||||
align-items: center;
|
||||
font-size: 1.5rem;
|
||||
gap: 2rem;
|
||||
}
|
||||
|
||||
header ul li a,
|
||||
footer ul li a,
|
||||
header ul li a:visited,
|
||||
footer ul li a:visited {
|
||||
text-decoration: none;
|
||||
color: var(--2);
|
||||
text-transform: capitalize;
|
||||
letter-spacing: 0.1rem;
|
||||
}
|
||||
|
||||
header ul li a {
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
header ul li a:hover,
|
||||
footer ul li a:hover {
|
||||
color: var(--5);
|
||||
}
|
||||
|
||||
footer div span {
|
||||
font-size: 1.5rem;
|
||||
color: var(--4);
|
||||
}
|
||||
|
||||
footer div {
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
footer {
|
||||
background: var(--bg);
|
||||
width: 100%;
|
||||
padding: 1rem;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
}
|
||||
```
|
||||
### Styles for the search page
|
||||
``` css
|
||||
.results {
|
||||
width: 90%;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: space-around;
|
||||
}
|
||||
|
||||
.results .search_bar {
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
.results_aggregated {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: space-between;
|
||||
margin: 2rem 0;
|
||||
}
|
||||
|
||||
.results_aggregated .result {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
margin-top: 1rem;
|
||||
}
|
||||
|
||||
.results_aggregated .result h1 a {
|
||||
font-size: 1.5rem;
|
||||
color: var(--2);
|
||||
text-decoration: none;
|
||||
letter-spacing: 0.1rem;
|
||||
}
|
||||
|
||||
.results_aggregated .result h1 a:hover {
|
||||
color: var(--5);
|
||||
}
|
||||
|
||||
.results_aggregated .result h1 a:visited {
|
||||
color: var(--bg);
|
||||
}
|
||||
|
||||
.results_aggregated .result small {
|
||||
color: var(--3);
|
||||
font-size: 1.1rem;
|
||||
word-wrap: break-word;
|
||||
line-break: anywhere;
|
||||
}
|
||||
|
||||
.results_aggregated .result p {
|
||||
color: var(--fg);
|
||||
font-size: 1.2rem;
|
||||
margin-top: 0.3rem;
|
||||
word-wrap: break-word;
|
||||
line-break: anywhere;
|
||||
}
|
||||
|
||||
.results_aggregated .result .upstream_engines {
|
||||
text-align: right;
|
||||
font-size: 1.2rem;
|
||||
padding: 1rem;
|
||||
color: var(--5);
|
||||
}
|
||||
```
|
||||
|
||||
### Styles for the 404 page
|
||||
|
||||
``` css
|
||||
.error_container {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
width: 100%;
|
||||
gap: 5rem;
|
||||
}
|
||||
|
||||
.error_container img {
|
||||
width: 30%;
|
||||
}
|
||||
|
||||
.error_content {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
.error_content h1,
|
||||
.error_content h2 {
|
||||
letter-spacing: 0.1rem;
|
||||
}
|
||||
|
||||
.error_content h1 {
|
||||
font-size: 3rem;
|
||||
}
|
||||
|
||||
.error_content h2 {
|
||||
font-size: 2rem;
|
||||
}
|
||||
|
||||
.error_content p {
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.error_content p a,
|
||||
.error_content p a:visited {
|
||||
color: var(--2);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.error_content p a:hover {
|
||||
color: var(--5);
|
||||
}
|
||||
```
|
||||
### Styles for the previous and next button on the search page
|
||||
``` css
|
||||
.page_navigation {
|
||||
padding: 0 0 2rem 0;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.page_navigation button {
|
||||
background: var(--bg);
|
||||
color: var(--fg);
|
||||
padding: 1rem;
|
||||
border-radius: 0.5rem;
|
||||
outline: none;
|
||||
border: none;
|
||||
}
|
||||
|
||||
.page_navigation button:active {
|
||||
filter: brightness(1.2);
|
||||
}
|
||||
```
|
||||
|
||||
### Styles for the about page
|
||||
|
||||
This part is only available right now in the **rolling/edge/unstable** version
|
||||
|
||||
```css
|
||||
.about-container article{
|
||||
font-size: 1.5rem;
|
||||
color:var(--fg);
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
.about-container article h1{
|
||||
color: var(--2);
|
||||
font-size: 2.8rem;
|
||||
}
|
||||
|
||||
.about-container article div{
|
||||
padding-bottom: 15px;
|
||||
}
|
||||
|
||||
.about-container a{
|
||||
color:var(--3);
|
||||
}
|
||||
|
||||
.about-container article h2{
|
||||
color: var(--3);
|
||||
font-size: 1.8rem;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
.about-container p{
|
||||
color:var(--fg);
|
||||
font-size: 1.6rem;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
.about-container h3{
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
```
|
||||
|
||||
[⬅️ Go back to Home](./README.md)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
BIN
images/websurfx_docs_image.png
Normal file
BIN
images/websurfx_docs_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
BIN
images/websurfx_logo.png
Normal file
BIN
images/websurfx_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.1 KiB |
Loading…
Reference in New Issue
Block a user