File size: 10,440 Bytes
3a984ed
1720135
3a984ed
58a3527
3a984ed
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5f27393
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d80d4c1
 
 
 
 
 
 
 
 
 
 
1720135
 
3a984ed
 
 
 
 
9ba07cb
d80d4c1
9ba07cb
 
3a984ed
9ba07cb
 
3a984ed
9ba07cb
 
 
 
 
 
 
 
 
3a984ed
 
 
 
 
1720135
 
 
 
3a984ed
1720135
 
 
3a984ed
1720135
 
 
 
3a984ed
 
d80d4c1
 
 
 
 
 
 
 
 
 
3a984ed
 
ba014f3
3a984ed
 
1720135
 
 
 
 
 
 
 
 
3a984ed
 
 
 
 
 
1720135
3a984ed
1720135
ba014f3
1720135
3a984ed
1720135
3a984ed
1720135
3a984ed
1720135
ba014f3
1720135
3a984ed
1720135
3a984ed
 
 
 
 
 
 
 
 
 
 
3357fa2
3a984ed
 
 
 
1720135
 
 
3a984ed
1720135
 
 
3a984ed
1720135
 
 
3a984ed
 
 
 
 
1720135
3a984ed
1720135
3a984ed
 
 
 
 
 
3be13d0
3a984ed
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1720135
 
 
3a984ed
1720135
 
 
3a984ed
 
 
1720135
3a984ed
1720135
 
 
3a984ed
1720135
3a984ed
 
 
1720135
3357fa2
 
 
 
 
 
 
3a984ed
 
 
 
 
1720135
3357fa2
 
 
 
 
1720135
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<h1 align="center">Websurfx</h1>
<p align="center">
  <b align="center"><a href="README.org">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>
  <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="">
    <img
      alt="GitHub contributors"
      src="https://img.shields.io/github/contributors-anon/neon-mmd/websurfx?style=flat-square"
    />
  </a>
  <br />
  <br />
  <i>
    A modern-looking, lightning-fast, privacy-respecting, secure
    <a href="https://en.wikipedia.org/wiki/Metasearch_engine"
      >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
    privacy.</i
  >
</p>

<details>
  <summary><b>Table of Contents</b></summary>
  <p>

- **Getting Started**
    - [πŸ”­ Preview](#preview-)
    - [🌈 Features](#features-)
    - [πŸ› οΈ Installation and Testing](#installation-and-testing-)
    - [πŸ”§ Configuration](#configuration-)
- **Feature Overview**
    - [🎨 Theming](#theming-)
    - [🌍 Multi-Language Support](#multi-language-support-)
- **Community**
    - [πŸ“Š System Requirements](#system-requirements-)
    - [πŸ—¨οΈ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-)
    - [πŸ“£ More Contributers Wanted](#more-contributers-wanted-)
    - [πŸ’– Supporting Websurfx](#supporting-websurfx-)
    - [πŸ“˜ Documentation](#documentation-)
    - [πŸ›£οΈ Roadmap](#roadmap-)
    - [πŸ™‹ Contributing](#contributing-)
    - [πŸ“œ License](#license-)
    - [🀝 Credits](#credits-)

  </p>
</details>

# Preview πŸ”­ 

## Main Page

<img align="center" src="./images/main_page.png" />

## Search Page

<img align="center" src="./images/search_page.png" />

## 404 Error Page

<img align="center" src="./images/404_error_page.png" />

**[⬆️ Back to Top](#websurfx)**

# 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
- πŸ†“ 100% free and open source
- 🧹 Ad free and clean results
- 🌈 and lots more...

**[⬆️ Back to Top](#websurfx)**

# Installation and Testing πŸ› οΈ 

> For full setup instructions, see: [**Installation**](https://github.com/neon-mmd/websurfx/wiki/installation)

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:

``` shell
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
cargo build
redis-server -p 8082 &
./target/debug/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.

> **Warning**
> Please be aware that the project is still in the testing phase and is not ready for production use.

**[⬆️ Back to Top](#websurfx)**

# Configuration πŸ”§ 

> For full configuration instructions, see: [**Configuration**](https://github.com/neon-mmd/websurfx/wiki/configuration)

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

**[⬆️ Back to Top](#websurfx)**

# Theming 🎨 

> For full theming and customization instructions, see: [**Theming**](https://github.com/neon-mmd/websurfx/wiki/theming)

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.

**[⬆️ Back to Top](#websurfx)**

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

**[⬆️ Back to Top](#websurfx)**

# System Requirements πŸ“Š

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

**[⬆️ Back to Top](#websurfx)**

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

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

**[⬆️ Back to Top](#websurfx)**

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

**[⬆️ Back to Top](#websurfx)**

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

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.
- **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.
- Star Websurfx on GitHub.

**[⬆️ Back to Top](#websurfx)**

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

**[⬆️ Back to Top](#websurfx)**

# Roadmap πŸ›£οΈ

> Coming soon!! πŸ™‚.

**[⬆️ Back to Top](#websurfx)**

# Contributing πŸ™‹ 

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

## Not a developer but still want to contribute?

Check out this [video](https://youtu.be/FccdqCucVSI) by Mr. Nick on how to contribute.

## Developer

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

**[⬆️ Back to Top](#websurfx)**

# License πŸ“œ 

Websurfx is available under the [AGPLv3](LICENSE) license.

**[⬆️ Back to Top](#websurfx)**

# Credits 🀝 

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

<p>
  <br />
  <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
    <img src="https://contrib.rocks/image?repo=neon-mmd/websurfx" />
  </a>
  <br />
</p>

**[⬆️ Back to Top](#websurfx)**

---

<p align="center">
  <a href="https://github.com/neon-mmd/websurfx">
    <img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
  </a>
  <br /><br />
  <i>Thank you for Visiting</i>
</p>