Spaces:
Running
Running
neon_arch
commited on
Commit
·
b21c96a
1
Parent(s):
c170de8
updated installations steps and moved goals to project dashboard
Browse files- README.org +9 -3
- goals.org +0 -36
README.org
CHANGED
@@ -18,12 +18,13 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.
|
|
18 |
|
19 |
* Installation and Testing
|
20 |
|
21 |
-
To get started with Websurfx, clone the repository, edit the config file which is located in the =websurfx= directory and run
|
22 |
|
23 |
#+begin_src shell
|
24 |
git clone https://github.com/neon-mmd/websurfx.git
|
25 |
cd websurfx
|
26 |
cargo build
|
|
|
27 |
./target/debug/websurfx
|
28 |
#+end_src
|
29 |
|
@@ -34,16 +35,21 @@ If you want to use the rolling/edge branch, run the following commands instead:
|
|
34 |
cd websurfx
|
35 |
git checkout rolling
|
36 |
cargo build
|
|
|
37 |
./target/debug/websurfx
|
38 |
#+end_src
|
39 |
|
40 |
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx.
|
41 |
|
42 |
-
*Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use.
|
43 |
|
44 |
* More Contributers Wanted
|
45 |
|
46 |
-
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [[file:goals.
|
|
|
|
|
|
|
|
|
47 |
|
48 |
* FAQ (Frequently Asked Questions)
|
49 |
|
|
|
18 |
|
19 |
* Installation and Testing
|
20 |
|
21 |
+
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 [[https://redis.io/docs/getting-started/][here]] and then run the websurfx server and redis server using the following commands:
|
22 |
|
23 |
#+begin_src shell
|
24 |
git clone https://github.com/neon-mmd/websurfx.git
|
25 |
cd websurfx
|
26 |
cargo build
|
27 |
+
redis-server -p 8082 &
|
28 |
./target/debug/websurfx
|
29 |
#+end_src
|
30 |
|
|
|
35 |
cd websurfx
|
36 |
git checkout rolling
|
37 |
cargo build
|
38 |
+
redis-server -p 8082 &
|
39 |
./target/debug/websurfx
|
40 |
#+end_src
|
41 |
|
42 |
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx.
|
43 |
|
44 |
+
*Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use.
|
45 |
|
46 |
* More Contributers Wanted
|
47 |
|
48 |
+
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [[file:goals.orhttps://github.com/neon-mmd/websurfx/projects?query=is%3Aopen][project board]] and the [[file:CONTRIBUTING.org][CONTRIBUTING.org]] file for guidelines and rules for making contributions.
|
49 |
+
|
50 |
+
* Testers Wanted
|
51 |
+
|
52 |
+
We are looking for willing testers to test whether the code to evade IP blocking works and is resillient enough to prevent IP blocks and banning by the upstream servers.
|
53 |
|
54 |
* FAQ (Frequently Asked Questions)
|
55 |
|
goals.org
CHANGED
@@ -1,39 +1,3 @@
|
|
1 |
-
* TODO Goals for v0.1.0
|
2 |
-
|
3 |
-
- [ ] Add unit tests, integration test, and doc tests to the project source code.
|
4 |
-
|
5 |
-
- [ ] Add code to remove NSFW content from search results using a blocklist.
|
6 |
-
|
7 |
-
- [ ] Add code to disallow user from searching for sensitive content (similar functionality to swisscows search engine) if strict safe search is turned on.
|
8 |
-
|
9 |
-
- [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
|
10 |
-
|
11 |
-
- [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
|
12 |
-
|
13 |
-
- [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies.
|
14 |
-
|
15 |
-
- [ ] Add a search engine logo to the index page and the navbar.
|
16 |
-
|
17 |
-
- [X] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
|
18 |
-
|
19 |
-
- [X] Add the ability for users to change the colorscheme of the page. =For example:== If a simple theme is used, then there should be the option of 9 different colorschemes to choose from, such as Catppuccino-Mocha, Solarized Dark, Nord, etc.
|
20 |
-
|
21 |
-
- [X] Write a rust.yml file for automated testing of the project.
|
22 |
-
|
23 |
-
- [X] Improve documentation for the project source code.
|
24 |
-
|
25 |
-
- [X] Add a FAQ section to the README.org file to answer common questions about the project.
|
26 |
-
|
27 |
-
- [X] Add logging to the websurfx project.
|
28 |
-
|
29 |
-
- [X] Generate random user agents to protect user privacy.
|
30 |
-
|
31 |
-
- [X] Add DuckDuckGo and at least one Searx engine instance as upstream providers.
|
32 |
-
|
33 |
-
- [X] Add pagination support for search results.
|
34 |
-
|
35 |
-
- [X] Create basic Handlebars pages and theme with Catppuccino colorscheme.
|
36 |
-
|
37 |
* Goals for future development
|
38 |
|
39 |
- Replace Handlebars with the faster templating engine /Tera/.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
* Goals for future development
|
2 |
|
3 |
- Replace Handlebars with the faster templating engine /Tera/.
|