Merge pull request #288 from neon-mmd/rolling

🚀 Release the first stable version of the app

.cspell.json

@@ -0,0 +1,20 @@
+{
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/vscode-extension/**",
+    "**/.git/**",
+    "**/.pnpm-lock.json",
+    ".vscode",
+    "megalinter",
+    "package-lock.json",
+    "report"
+  ],
+  "language": "en",
+  "noConfigSearch": true,
+  "words": [
+    "megalinter",
+    "oxsecurity",
+    "websurfx"
+  ],
+  "version": "0.2"
+}

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,40 @@
+name: 🐛 Bug
+description: Report an issue to help improve the project.
+title: "🐛 <description>"
+labels: ["🛠️ goal: fix","🚦 status: awaiting triage"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief description of the question or issue, also include what you tried and what didn't work
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable
+    validations:
+      required: false
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: false
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: false
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this bug?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,36 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG] <your bug report title>"
-labels: bug
-assignees: ''
-
----
-
-<!-- PLEASE FILL THESE FIELDS, IT REALLY HELPS THE MAINTAINERS OF Websurfx -->
-
-**Version of Websurfx, commit number if you are using on master branch**
-<!-- If you are running on master branch using git execute this command
-in order to fetch the latest commit ID:
-```
-git log -1
-``` 
--->
-
-**How did you install Websurfx?**
-<!-- Did you install Websurfx following the README ? -->
-
-**What happened?**
-<!-- A clear and concise description of what the bug is. -->
-
-**Steps To Reproduce**
-<!-- How can we reproduce this issue? (as minimally and as precisely as possible) -->
-
-**Expected behavior**
-<!-- A clear and concise description of what you expected to happen. -->
-
-**Screenshots**
-<!-- If applicable, provide screenshots to help explain your problem better. -->
-
-**Additional context**
-<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,5 @@
-blank_issues_enabled: true
+blank_issues_enabled: false
+contact_links:
+  - name: Question?
+    url: https://discord.gg/SWnda7Mw5u
+    about: Feel free to ask your question by joining our Discord server.

.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,40 @@
+name: 📝 Documentation issue
+description: Found an issue in the documentation? You can use this one!
+title: "📝 <description>"
+labels: ["📄 aspect: text","🚦 status: awaiting triage"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief description of the question or issue, also include what you tried and what didn't work
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable
+    validations:
+      required: false
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: false
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: false
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this issue?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u)

.github/ISSUE_TEMPLATE/engine-request.md

@@ -1,27 +0,0 @@
----
-name: Engine request
-about: 'Suggest a new engine to be add '
-title: "[ENGINE] <your engine request title>"
-labels: engine
-assignees: ''
-
----
-
-<!-- PLEASE FILL THESE FIELDS, IT REALLY HELPS THE MAINTAINERS OF Websurfx -->
-
-**Working URL of the engine**
-<!-- Please check if the engine is responding correctly before submitting it. -->
-
-**Why do you want to add this engine?**
-<!-- What's special about this engine? Is it open source or libre? -->
-
-**Features of this engine**
-<!-- Features of this engine: Doesn't track its users, fast, easy to integrate, ... -->
-
-**Applicable category of this engine**
-<!-- Where should this new engine fit in Websurfx? Current categories in Websurfx:
-general, files, images, it, map, music, news, science, social media and videos.
-You can add multiple categories at the same time. -->
-
-**Additional context**
-<!-- Add any other context about this engine here. -->

.github/ISSUE_TEMPLATE/engine.yml

@@ -0,0 +1,72 @@
+name: ✨ Engine
+description: Have a new engine to suggest for Websurfx? Please suggest!
+title: '✨ <your engine request title>'
+labels: ['⭐ goal: addition', '🚦 status: awaiting triage']
+body:
+  - type: textarea
+    id: workingUrl
+    attributes:
+      label: Working URL of the engine
+      description: Please check if the engine is responding correctly before submitting it.
+    validations:
+      required: true
+  - type: textarea
+    id: reason
+    attributes:
+      label: Why do you want to add this engine?
+      description: What's special about this engine? Is it open source or libre?
+    validations:
+      required: true
+  - type: textarea
+    id: features
+    attributes:
+      label: Features of this engine
+      description: Features of this engine: Doesn't track its users, fast, easy to integrate, or anything else that we can know about. 
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable
+    validations:
+      required: false
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: true
+      options:
+        - 'General'
+        - 'Files' 
+        - 'Images' 
+        - 'IT' 
+        - 'Map' 
+        - 'Music' 
+        - 'News' 
+        - 'Science' 
+        - 'Social Media' 
+        - 'Videos'
+    validations:
+      required: true
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: false
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: false
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this idea?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u)

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,40 @@
+name: 💡 General Feature Request
+description: Have a new idea/feature for Websurfx? Please suggest!
+title: "✨ <description>"
+labels: ["⭐ goal: addition", "🚦 status: awaiting triage"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief description of the enhancement you propose, also include what you tried and what worked.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable
+    validations:
+      required: false
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: false
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: false
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this idea?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEATURE] <your feature request title>"
-labels: enhancement
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,36 @@
+name: 🧱 Other
+description: Use this for any other issues. Please do NOT create blank issues
+title: "🧱 <Add your title here>"
+labels: ["🚦 status: awaiting triage"]
+body:
+  - type: markdown
+    attributes:
+      value: "# Other issue"
+  - type: textarea
+    id: issuedescription
+    attributes:
+      label: What would you like to share?
+      description: Provide a clear and concise explanation of your issue.
+    validations:
+      required: true
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: Do you want to work on this issue?
+      multiple: false
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: false
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this issue?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u)

.github/label-actions.yml

@@ -0,0 +1,11 @@
+"🚦 status: awaiting triage":
+  issues:
+    comment: >
+      To reduce notifications, issues are locked until they are https://github.com/neon-mmd/websurfx/labels/%F0%9F%8F%81%20status%3A%20ready%20for%20dev and to be assigned. You can learn more in our contributing guide https://github.com/neon-mmd/websurfx/blob/rolling/CONTRIBUTING.md
+    lock: true
+
+"🏁 status: ready for dev":
+  issues:
+    comment: >
+      The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you. You can learn more in our contributing guide https://github.com/neon-mmd/websurfx/blob/rolling/CONTRIBUTING.md
+    unlock: true

.github/labeler.yml

@@ -0,0 +1,27 @@
+'💻 aspect: code':
+- src/*
+- Cargo.toml
+- Cargo.lock
+- Dockerfile
+- docker-compose.yml
+- websurfx/*
+
+'🤖 aspect: dx':
+- '**/*.json'
+- .dockerignore
+- .gitignore
+- .gitpod.Dockerfile
+- .gitpod.yml
+- .rusty-hook.toml
+- PULL_REQUEST_TEMPLATE.md
+- SECURITY.md
+- .github/* 
+- .mega-linter.yml
+- tests/*
+
+'📄 aspect: text':
+- any: ['**/*.md', '!PULL_REQUEST_TEMPLATE.md', '!SECURITY.md']
+- LICENSE
+
+'🕹️ aspect: interface':
+- public/*

.github/workflows/contributors.yml

@@ -0,0 +1,48 @@
+---
+name: Contributors List
+
+on:
+  workflow_dispatch:
+  
+  schedule:
+    - cron: "0 1 * * *"
+
+jobs:
+  contributors:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.repository.default_branch }}
+          
+      - name: Update contributors list
+        uses: wow-actions/contributors-list@b9e91f91a51a55460fdcae64daad0cb8122cdd53 # v1.1.0
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          svgPath: images/contributors_list.svg
+          round: true
+          includeBots: false
+          noCommit: true
+      
+      - name: Commit & PR
+        uses: peter-evans/create-pull-request@38e0b6e68b4c852a5500a94740f0e535e0d7ba54 # v4.2.4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-paths: .github/assets/CONTRIBUTORS.svg
+          commit-message: 'chore: update contributors-list'
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
+          branch: workflow/update-contributors-list
+          base: main
+          delete-branch: true
+          title: 'chore: update contributors-list'
+          body: |
+            Automated update to `images/contributors_list.svg`

.github/workflows/hello.yml

@@ -1,3 +1,4 @@
+---
 name: Welcome first time contributors 
 
 on:

.github/workflows/issue-lock-unlock.yml

@@ -0,0 +1,16 @@
+name: "lock/unlock issue"
+
+on:
+  issues:
+    types: labeled
+
+permissions:
+  issues: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/label-actions@v3
+        with:
+          process-only: issues

.github/workflows/labels.yml

@@ -1,9 +1,10 @@
+---
 name: Import open source standard labels
 
 on:
   push:
     branches:  
-      - master 
+      - rolling 
 
 jobs:
   labels:

.github/workflows/mega-linter.yml

@@ -0,0 +1,89 @@
+---
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+name: MegaLinter
+
+on:
+  # Trigger mega-linter at every push. Action will also be visible from Pull Requests to rolling
+  push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
+  pull_request:
+    branches: [rolling]
+
+env: # Comment env block if you do not want to apply fixes
+  # Apply linter fixes configuration
+  APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
+  APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
+  APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
+      # Remove the ones you do not need
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+      # MegaLinter
+      - name: MegaLinter
+        id: ml
+        # You can override MegaLinter flavor used to have faster performances
+        # More info at https://megalinter.io/flavors/
+        uses: oxsecurity/megalinter/flavors/cupcake@v7.1.0
+        env:
+          # All available variables are described in documentation
+          # https://megalinter.io/configuration/
+          VALIDATE_ALL_CODEBASE: true # Set ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} to validate only diff with main branch
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
+
+      # Upload MegaLinter artifacts
+      - name: Archive production artifacts
+        if: ${{ success() }} || ${{ failure() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log
+
+      # Create pull request if applicable (for now works only on PR from same repository, not from forks)
+      - name: Create Pull Request with applied fixes
+        id: cpr
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          commit-message: "[MegaLinter] Apply linters automatic fixes"
+          title: "[MegaLinter] Apply linters automatic fixes"
+          labels: bot
+      - name: Create PR output
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+        run: |
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      # Push new commit if applicable (for now works only on PR from same repository, not from forks)
+      - name: Prepare commit
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+        run: sudo chown -Rc $UID .git/
+      - name: Commit and push applied linter fixes
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
+          commit_message: "[MegaLinter] Apply linters fixes"
+          commit_user_name: megalinter-bot
+          commit_user_email: nicolas.vuillamy@ox.security

.github/workflows/pr_labeler.yml

@@ -0,0 +1,15 @@
+name: "Pull Request Auto Labeler"
+on:
+- pull_request_target
+
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v4
+      with: 
+        sync-labels: true
+        dot: true

.github/workflows/releases.yml

@@ -1,78 +0,0 @@
-name: Releases
-on:
-  push:
-    branches:
-      - "rolling"
-
-concurrency:
-  group: "rolling-branch"
-
-jobs:
-  changelog:
-    if: github.repository == 'neon-mmd/websurfx'
-    runs-on: ubuntu-latest
-
-    steps:
-      # Create a temporary, uniquely named branch to push release info to
-      - name: create temporary branch
-        uses: peterjgrainger/action-create-branch@v2.3.0
-        id: create-branch
-        with:
-          branch: "release-from-${{ github.sha }}"
-          sha: "${{ github.sha }}"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      # check out the repository afterwards
-      - uses: actions/checkout@v3
-
-      # fetch branches and switch to the temporary branch
-      - name: switch to new branch
-        run: git fetch --all && git checkout --track origin/release-from-${{ github.sha }}
-
-      # update app config with version
-      - name: Get current rust app version from its Cargo.toml.
-        id: foo
-        uses: dante-signal31/rust-app-version@v1.2.0
-        with:
-           cargo_toml_folder: rust_app_folder/
-         
-      - name: Use the version to update the Cargo.toml version.
-        shell: bash
-        run: sed -i "3s/version = \"[0-9]*.[0-9]*.[0-9]*\"/version = \"${{ steps.foo.outputs.app_version }}\"/g" Cargo.toml
-
-      # create release info and push it upstream
-      - name: conventional Changelog Action
-        id: changelog
-        uses: TriPSs/conventional-changelog-action@v3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          version-file: "./Cargo.toml"
-          git-branch: "release-from-${{ github.sha }}"
-          skip-on-empty: false
-          skip-git-pull: true
-
-      # create PR using GitHub CLI
-      - name: create PR with release info
-        id: create-pr
-        run: gh pr create --base main --head release-from-${{ github.sha }} --title 'Merge new release into rolling' --body 'Created by Github action'
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      # merge PR using GitHub CLI
-      - name: merge PR with release info
-        id: merge-pr
-        run: gh pr merge --admin --merge --subject 'Merge release info' --delete-branch
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      # release info is now in main so we can continue as before
-      - name: create release with last commit
-        uses: actions/create-release@v1
-        if: steps.changelog.outputs.skipped == 'false'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ steps.changelog.outputs.tag }}
-          release_name: ${{ steps.changelog.outputs.tag }}
-          body: ${{ steps.changelog.outputs.clean_changelog }}

.github/workflows/rust.yml

@@ -1,12 +1,13 @@
+---
 name: Rust
 
 on:
   push:
     branches:
-      - "**"
+      - '**'
   pull_request:
     branches:
-      - "rolling" 
+      - 'rolling'
 
 env:
   CARGO_TERM_COLOR: always
@@ -20,23 +21,27 @@ jobs:
           - stable
 
     steps:
-    - uses: actions/checkout@v3
-    - run: rustup toolchain install stable --profile minimal
-    - uses: Swatinem/rust-cache@v2
-      with:
-        prefix-key: ""
-        shared-key: ""
-        key: ""
-        env-vars: ""
-        workspaces: ""
-        cache-directories: ""
-        cache-targets: ""
-        cache-on-failure: ""
-        cache-all-crates: ""
-        save-if: ""    
-    - uses: actions/checkout@v3
-    - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose
+      - name: Install LuaJIT and Lua
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends liblua5.4-dev liblua5.3-dev liblua5.2-dev liblua5.1-0-dev libluajit-5.1-dev
+      - uses: actions/checkout@v3
+      - run: rustup toolchain install stable --profile minimal
+      - uses: Swatinem/rust-cache@v2
+        with:
+          prefix-key: ''
+          shared-key: ''
+          key: ''
+          env-vars: ''
+          workspaces: ''
+          cache-directories: ''
+          cache-targets: ''
+          cache-on-failure: ''
+          cache-all-crates: ''
+          save-if: ''
+      - uses: actions/checkout@v3
+      - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose

.github/workflows/rust_format.yml

@@ -1,3 +1,4 @@
+---
 name: Rust format and clippy checks
 on:
   push:
@@ -12,6 +13,10 @@ jobs:
     name: Rust project
     runs-on: ubuntu-latest
     steps:
+      - name: Install LuaJIT and Lua 
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends liblua5.4-dev liblua5.3-dev liblua5.2-dev liblua5.1-0-dev libluajit-5.1-dev
       - uses: actions/checkout@v2
       - name: Install minimal stable with clippy and rustfmt
         uses: actions-rs/toolchain@v1
@@ -19,7 +24,16 @@ jobs:
           profile: minimal
           toolchain: stable
           components: rustfmt, clippy
-
+      - name: Format
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: -- --check
+      - name: Clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --all-targets --all
       - name: Run cargo check
         uses: actions-rs/cargo@v1
         with:

.github/workflows/stale.yml

@@ -1,3 +1,4 @@
+---
 # This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
 #
 # You can adjust the behavior by modifying this file.

.gitignore

@@ -1 +1,8 @@
+.vscode
 /target
+dhat-heap.json
+dump.rdb
+megalinter-reports/
+package-lock.json
+package.json
+result

.gitpod.Dockerfile

@@ -0,0 +1,3 @@
+FROM gitpod/workspace-rust
+
+RUN sudo install-packages redis-server nodejs npm liblua5.4-dev liblua5.3-dev liblua5.2-dev liblua5.1-0-dev libluajit-5.1-dev

.gitpod.yml

@@ -0,0 +1,50 @@
+---
+image:
+    file: .gitpod.Dockerfile
+
+# Commands that will run on workspace start 
+tasks: 
+    - name: Start Redis Server
+      command: redis-server --port 8082
+    - name: Run The App
+      init: cargo build
+      command: PKG_ENV=dev ./target/debug/websurfx
+    - name: Tests
+      command: cargo test
+    - name: Clippy Checks
+      command: cargo clippy
+
+# vscode IDE setup
+vscode: 
+   extensions: 
+    - vadimcn.vscode-lldb
+    - cschleiden.vscode-github-actions
+    - rust-lang.rust-analyzer
+    - bungcip.better-toml
+    - serayuzgur.crates
+    - usernamehw.errorlens
+    - DavidAnson.vscode-markdownlint
+    - esbenp.prettier-vscode
+    - stylelint.vscode-stylelint
+    - dbaeumer.vscode-eslint
+    - evgeniypeshkov.syntax-highlighter
+    - ms-azuretools.vscode-docker
+    - Catppuccin.catppuccin-vsc
+    - PKief.material-icon-theme
+    - oderwat.indent-rainbow
+    - formulahendry.auto-rename-tag
+    - swellaby.vscode-rust-test-adapter
+    - belfz.search-crates-io
+    - hbenl.test-adapter-converter
+    - hbenl.vscode-test-explorer
+    - eamodio.gitlens
+
+github: 
+   prebuilds: 
+      master: true 
+      branches: true 
+      pullRequests: true 
+      pullRequestsFromForks: true 
+      addCheck: true 
+      addComment: false
+      addBadge: true

.mega-linter.yml

@@ -0,0 +1,22 @@
+---
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/ and in linters documentation
+
+APPLY_FIXES: all # all, none, or list of linter keys
+# ENABLE: # If you use ENABLE variable, all other languages/formats/tooling-formats will be disabled by default
+ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
+ - RUST_CLIPPY
+ - JAVASCRIPT_ES
+ - CSS_STYLELINT
+ - MARKDOWN_MARKDOWNLINT
+ - YAML_YAMLLINT
+ - HTML_DJLINT
+ - ACTION_ACTIONLINT
+ - DOCKERFILE_HADOLINT
+ - SPELL_CSPELL
+# DISABLE:
+  # - COPYPASTE # Uncomment to disable checks of excessive copy-pastes
+  # - SPELL # Uncomment to disable checks of spelling mistakes
+SHOW_ELAPSED_TIME: true
+FILEIO_REPORTER: false
+# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect errors but not block CI to pass

.rusty-hook.toml

@@ -0,0 +1,5 @@
+[hooks]
+pre-commit = "cargo test && cargo fmt -- --check && cargo clippy && stylelint ./public/static/themes/*.css ./public/static/colorschemes/*.css ./public/static/*.js" 
+
+[logging]
+verbose = true

.stylelintrc.json

@@ -0,0 +1,13 @@
+{  
+ "extends": "stylelint-config-standard",
+  "rules": {
+    "alpha-value-notation": "number",
+    "selector-class-pattern": null
+  },
+"overrides": [
+    {
+      "files": ["*.js"],
+      "customSyntax": "postcss-lit"
+    }
+  ]
+}

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Documentation/Wiki
 
-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.
+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 [docs](./docs/) to add to or improve the documentation. This will help future users get Websurfx up and running more easily.
 
 ## Readme
 
@@ -14,7 +14,7 @@ Know how to fix or improve a github action?. Consider Submitting a Pull request
 
 ## Source Code
 
-You should know atleast one of the things below to start contributing:
+You should know at least one of the things below to start contributing:
 
 - Rust basics
 - Actix-web crate basics
@@ -48,23 +48,7 @@ We have a [Discord](https://discord.gg/SWnda7Mw5u) channel, feel free to join an
 
 # Where To Contribute?
 
-## For Source Code Contributions
-
-The _rolling branch_ is where we intend all source code contributions should go.
-
-## For Readme Contributions
-
-The _master branch_ is where we intend all source code contributions should go.
-
-# How To Fork
-
-![image](./images/fork_button.png)
-
-![image](./images/fork_options_page.png)
-
-Please make sure to leave the `Copy the master branch only` option ticked off. 
-
-![image](./images/create_fork_button.png)
+The _rolling branch_ is where we intend all contributions should go.
 
 
 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.

Cargo.toml

@@ -1,23 +1,73 @@
 [package]
 name = "websurfx"
-version = "0.6.0"
+version = "1.0.0"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+description = "An open-source alternative to Searx that provides clean, ad-free, and organic results with incredible speed while keeping privacy and security in mind."
+repository = "https://github.com/neon-mmd/websurfx"
+license = "AGPL-3.0"
 
 [dependencies]
-reqwest = {version="*",features=["json"]}
-tokio = {version="*",features=["full"]}
-serde = {version="*",features=["derive"]}
-handlebars = { version = "4.3.6", features = ["dir_source"] }
-scraper = {version="*"}
-actix-web = {version="4.3.1"}
+reqwest = {version="0.11.20",features=["json"]}
+tokio = {version="1.32.0",features=["rt-multi-thread","macros"]}
+serde = {version="1.0.188",features=["derive"]}
+handlebars = { version = "4.4.0", features = ["dir_source"] }
+scraper = {version="0.17.1"}
+actix-web = {version="4.4.0", features = ["cookies"]}
 actix-files = {version="0.6.2"}
-serde_json = {version="*"}
-fake-useragent = {version="*"}
+actix-cors = {version="0.6.4"}
+serde_json = {version="1.0.105"}
+fake-useragent = {version="0.1.3"}
 env_logger = {version="0.10.0"}
-log = {version="0.4.17"}
-rlua = {version="*"}
-redis = {version="*"}
-md5 = {version="*"}
-rand={version="*"}
+log = {version="0.4.20"}
+mlua = {version="0.8.10", features=["luajit", "vendored"]}
+redis = {version="0.23.3", features=["tokio-comp","connection-manager"], optional = true}
+md5 = {version="0.7.0"}
+rand={version="0.8.5"}
+once_cell = {version="1.18.0"}
+error-stack = {version="0.4.0"}
+async-trait = {version="0.1.73"}
+regex = {version="1.9.4", features=["perf"]}
+smallvec = {version="1.11.0", features=["union", "serde"]}
+futures = {version="0.3.28"}
+dhat = {version="0.3.2", optional = true}
+mimalloc = { version = "0.1.38", default-features = false }
+async-once-cell = {version="0.5.3"}
+actix-governor = {version="0.4.1"}
+mini-moka = { version="0.10", optional = true}
+
+[dev-dependencies]
+rusty-hook = "^0.11.2"
+criterion = "0.5.1"
+tempfile = "3.8.0"
+
+[profile.dev]
+opt-level = 0
+debug = true
+split-debuginfo = '...'
+debug-assertions = true
+overflow-checks = true
+lto = false
+panic = 'unwind'
+incremental = true
+codegen-units = 256
+rpath = false
+
+[profile.release]
+opt-level = 3
+debug = false # This should only be commented when testing with dhat profiler
+# debug = 1 # This should only be uncommented when testing with dhat profiler
+split-debuginfo = '...'
+debug-assertions = false
+overflow-checks = false
+lto = true
+panic = 'abort'
+incremental = false
+codegen-units = 1
+rpath = false
+strip = "debuginfo"
+
+[features]
+default = ["memory-cache"]
+dhat-heap = ["dep:dhat"] 
+memory-cache = ["dep:mini-moka"]
+redis-cache = ["dep:redis"]

Dockerfile

@@ -1,9 +1,9 @@
 FROM rust:latest AS chef
 # We only pay the installation cost once,
 # it will be cached from the second build onwards
-RUN cargo install cargo-chef
+RUN cargo install cargo-chef --locked
 
-WORKDIR app
+WORKDIR /app
 
 FROM chef AS planner
 COPY . . 
@@ -12,15 +12,29 @@ RUN cargo chef prepare --recipe-path recipe.json
 FROM chef AS builder
 COPY --from=planner /app/recipe.json recipe.json
 # Build dependencies - this is the caching Docker layer!
+# Uncomment the line below if you want to use the `hybrid` caching feature.
+# RUN cargo chef cook --release --features redis-cache --recipe-path recipe.json
+# Comment the line below if you don't want to use the `In-Memory` caching feature.
 RUN cargo chef cook --release --recipe-path recipe.json
+# Uncomment the line below if you want to use the `no cache` feature.
+# RUN cargo chef cook --release --no-default-features --recipe-path recipe.json
+# Uncomment the line below if you want to use the `redis` caching feature.
+# RUN cargo chef cook --release --no-default-features --features redis-cache --recipe-path recipe.json
 
 # Build application
 COPY . .
+# Uncomment the line below if you want to use the `hybrid` caching feature.
+# RUN cargo install --path . --features redis-cache
+# Comment the line below if you don't want to use the `In-Memory` caching feature.
 RUN cargo install --path .
+# Uncomment the line below if you want to use the `no cache` feature.
+# RUN cargo install --path . --no-default-features 
+# Uncomment the line below if you want to use the `redis` caching feature.
+# RUN cargo install --path . --no-default-features --features redis-cache
 
 # We do not need the Rust toolchain to run the binary!
-FROM gcr.io/distroless/cc-debian11
-COPY --from=builder ./public/ ./public/
-COPY --from=builder ./websurfx/ ./websurfx/
+FROM gcr.io/distroless/cc-debian12
+COPY --from=builder /app/public/ /opt/websurfx/public/
+VOLUME ["/etc/xdg/websurfx/"]
 COPY --from=builder /usr/local/cargo/bin/* /usr/local/bin/
 CMD ["websurfx"]

PULL_REQUEST_TEMPLATE.md

@@ -16,7 +16,7 @@
 
 ## Author's checklist
 
-<!-- additional notes for reviewiers -->
+<!-- additional notes for reviewers -->
 
 ## Related issues
 

README.md

@@ -1,12 +1,22 @@
-<h1 align="center">
+<h1 align="center">
   <img src="./images/websurfx_logo.png" alt="websurfx logo" align="center" />
 </h1>
 <p align="center">
   <b align="center"><a href="README.md">Readme</a></b> |
   <b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
+  <b><a href="../../tree/HEAD/docs/instances.md">Instances</a></b> |
+  <b><a href="https://discord.gg/VKCAememnr">User Showcase</a></b> |
   <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
-  <b><a href="./docs/README.md">Documentation</a></b>
+  <b><a href="../../tree/HEAD/docs/">Documentation</a></b>
   <br /><br />
+   <a
+      href="https://github.com/awesome-selfhosted/awesome-selfhosted#search-engines"
+   >
+  <img
+    src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"
+    alt="Awesome Self-Hosted"
+  />
+  </a>
   <a href="#">
     <img
       alt="GitHub code size in bytes"
@@ -39,7 +49,7 @@
       >meta search engine</a
     >
     (pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It
-    provides a quick and secure search experience while maintaining user
+    provides a quick and secure search experience while completely respecting user
     privacy.</i
   >
 </p>
@@ -49,30 +59,31 @@
   <p>
 
 - **Getting Started**
-    - [🔭 Preview](#preview-)
-    - [🚀 Features](#features-)
-    - [🛠️ Installation and Testing](#installation-and-testing-)
-    - [🔧 Configuration](#configuration-)
+  - [🔭 Preview](#preview-)
+  - [🚀 Features](#features-)
+  - [🔗 Instances](instances-)
+  - [🛠️ Installation and Testing](#installation-and-testing-%EF%B8%8F)
+  - [🔧 Configuration](#configuration-)
 - **Feature Overview**
-    - [🎨 Theming](#theming-)
-    - [🌍 Multi-Language Support](#multi-language-support-)
+  - [🎨 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-)
+  - [📊 System Requirements](#system-requirements-)
+  - [🗨️ FAQ (Frequently Asked Questions)](#faq-frequently-asked-questions-)
+  - [📣 More Contributors Wanted](#more-contributors-wanted-)
+  - [💖 Supporting Websurfx](#supporting-websurfx-)
+  - [📘 Documentation](#documentation-)
+  - [🛣️ Roadmap](#roadmap-)
+  - [🙋 Contributing](#contributing-)
+  - [📜 License](#license-)
+  - [🤝 Credits](#credits-)
 
   </p>
 </details>
 
-# Preview 🔭 
+# Preview 🔭
 
-## Main Page
+## Home Page
 
 <img align="center" src="./images/main_page.png" />
 
@@ -86,9 +97,15 @@
 
 **[⬆️ Back to Top](#--)**
 
-# Features 🚀 
+# Instances 🔗
+
+> For a full list of publicly available community driven `websurfx` instances to test or for daily use. see [**Instances**](./docs/instances.md)
+
+**[⬆️ Back to Top](#--)**
 
-- 🎨 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
+# Features 🚀
+
+- 🎨 Make Websurfx uniquely yours with twelve color schemes provided by default. It also supports creation of custom themes and color schemes in a quick and easy way, so unleash your creativity!
 - 🔐 Fast, private, and secure
 - 🆓 100% free and open source
 - 💨 Ad-free and clean results
@@ -96,7 +113,7 @@
 
 **[⬆️ Back to Top](#--)**
 
-# Installation and Testing 🛠️ 
+# Installation and Testing 🛠️
 
 > For full setup instructions, see: [**Installation**](./docs/installation.md)
 
@@ -104,9 +121,10 @@ Before you can start building `websurfx`, you will need to have `Cargo` installe
 
 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
+```shell
 git clone https://github.com/neon-mmd/websurfx.git
 cd websurfx
+git checkout stable
 cargo build -r
 redis-server --port 8082 &
 ./target/release/websurfx
@@ -114,12 +132,14 @@ redis-server --port 8082 &
 
 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.
+> **Note**
+>
+> 1. The project is no longer in the testing phase and is now ready for production use.
+> 2. There are many features still missing like `support for image search`, `different categories`, `quick apps`, etc but they will be added soon as part of future releases.
 
 **[⬆️ Back to Top](#--)**
 
-# Configuration 🔧 
+# Configuration 🔧
 
 > For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
 
@@ -127,18 +147,18 @@ Websurfx is configured through the config.lua file, located at `websurfx/config.
 
 **[⬆️ Back to Top](#--)**
 
-# Theming 🎨 
+# Theming 🎨
 
 > For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
 
-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.
+Websurfx comes loaded with several themes and color schemes, which you can apply and edit through the config file. It also supports custom themes and color schemes using CSS, allowing you to make it truly yours.
 
 **[⬆️ Back to Top](#--)**
 
 # Multi-Language Support 🌍
 
 > **Note**
-> 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.
+> Currently, we do not support other languages but we will start accepting contributions regarding language support in the future. We believe language should never be a barrier to entry.
 
 **[⬆️ Back to Top](#--)**
 
@@ -152,19 +172,19 @@ At present, we only support x86_64 architecture systems, but we would love to ha
 
 ## Why Websurfx?
 
-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).
+The primary purpose of the Websurfx project is to create a fast, secure, and privacy-focused meta-search engine. There are numerous meta-search engines available, but not all 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 understandably bad. There is also the added problem of spam, ads, and inorganic results which most engines don't have a fool-proof answer to. Until now. With Websurfx I finally put a full stop to this problem. Websurfx is based on Rust, which ensures memory safety and removes such issues. Many meta-search engines also lack important features like advanced picture search, required by graphic designers, content providers, and others. Websurfx improves the user experience by providing these and other features, such as proper NSFW blocking and Micro-apps or Quick Results (providing a calculator, currency exchanges, etc in the search results).
 
 ## Why AGPLv3?
 
-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.
+Websurfx is distributed under the **AGPLv3** license to keep the source code open and transparent. This helps keep malware, telemetry, and other dangers 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 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.
+Websurfx is based on Rust due to its memory safety features, which prevents vulnerabilities and makes the codebase more secure. Rust is also faster than C++, contributing to Websurfx's speed and responsiveness. Finally, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
 
 **[⬆️ Back to Top](#--)**
 
-# More Contributers Wanted 📣 
+# More Contributors 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.md](CONTRIBUTING.md) file for guidelines and rules for making contributions.
 
@@ -174,14 +194,15 @@ We are looking for more willing contributors to help grow this project. For more
 
 > For full details and other ways you can help out, see: [**Contributing**]()
 
-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.
+If you use Websurfx and would like to contribute to its development, we're glad to have you on board! Contributions of any size or type are always welcome, and we will always acknowledge your efforts.
 
 Several areas that we need a bit of help with at the moment are:
+
 - **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.
+- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or anything else.
 - Star Websurfx on GitHub.
 
 **[⬆️ Back to Top](#--)**
@@ -189,19 +210,19 @@ Several areas that we need a bit of help with at the moment are:
 # Documentation 📘
 
 > **Note**
-> We welcome any contributions to the [documentation](./docs/) as this will benefit everyone who uses this project. 
+> We welcome any contributions to the [documentation](../../tree/HEAD/docs/) as this will benefit everyone who uses this project.
 
 **[⬆️ Back to Top](#--)**
 
 # Roadmap 🛣️
 
-> Coming soon!! 🙂.
+> Coming soon! 🙂.
 
 **[⬆️ Back to Top](#--)**
 
-# Contributing 🙋 
+# Contributing 🙋
 
-Contributions are welcome from anyone. It doesn\'t matter who you are; you can still contribute to the project in your own 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?
 
@@ -213,16 +234,18 @@ If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) d
 
 **[⬆️ Back to Top](#--)**
 
-# License 📜 
+# License 📜
 
 Websurfx is licensed under the [AGPLv3](LICENSE) license.
 
 **[⬆️ Back to Top](#--)**
 
-# Credits 🤝 
+# Credits 🤝
 
 We would like to thank the following people for their contributions and support:
 
+**Contributors**
+
 <p>
   <br />
   <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
@@ -231,6 +254,14 @@ We would like to thank the following people for their contributions and support:
   <br />
 </p>
 
+**Stargazers**
+
+<p>
+  <a href="https://github.com/neon-mmd/websurfx/stargazers">
+    <img src="https://reporoster.com/stars/dark/neon-mmd/websurfx" />
+  </a>
+</p>
+
 **[⬆️ Back to Top](#--)**
 
 ---

docker-compose.yml

@@ -1,3 +1,4 @@
+---
 version: "3.9"
 services:
   app:
@@ -5,11 +6,15 @@ services:
     build: .
     ports:
       - 8080:8080
-    depends_on:
-      - redis
-    links:
-      - redis
-  redis:
-    image: redis:latest
-    ports:
-      - 6379:6379
+    # Uncomment the following lines if you are using the `hybrid` or `redis` caching feature.
+    # depends_on:
+    #   - redis
+    # links:
+    #   - redis
+    volumes:
+      - ./websurfx/:/etc/xdg/websurfx/
+  # Uncomment the following lines if you are using the `hybrid` or `redis` caching feature.
+  # redis:
+  #   image: redis:latest
+  #   ports:
+  #     - 6379:6379

docs/README.md

@@ -7,7 +7,9 @@
 
 # Users
 
+- [Instances](./instances.md)
 - [Installation](./installation.md)
+- [Features](./features.md)
 - [Configuration](./configuration.md)
 - [Theming](./theming.md)
 

docs/configuration.md

@@ -11,33 +11,59 @@ If you have built `websurfx` from source then the configuration file will be loc
 
 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:
+Some of the configuration options provided in the file are stated below. These are subdivided into the following categories:
 
+- General
 - Server
+- Search
 - Website
 - Cache
+- Search Engines
+
+# General
+
+- **logging:** An option to enable or disable logs.
+- **debug:** An option to enable or disable debug mode.
+- **threads:** The amount of threads that the app will use to run (the value should be greater than 0).
 
 ## 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**.
+- **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.
+- **request_timeout:** Timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
+- **rate_limiter:** The configuration option to configure rate limiting on the search engine website.
+
+## Search
+
+- **safe_search:** This option is used to configure the search filtering based on different safe search levels. (value a number between 0 to 4)
+
+> This option provides 4 levels of search filtering:
+>
+> - Level 0 - With this level no search filtering occurs.
+> - Level 1 - With this level some search filtering occurs.
+> - Level 2 - With this level the upstream search engines are restricted to send sensitive contents like NSFW search results, etc.
+> - Level 3 - With this level the regex based filter lists is used alongside level 2 to filter more search results that have slipped in or custom results that needs to be filtered using the filter lists.
+> - Level 4 - This level is similar to level 3 except in this level the regex based filter lists are used to disallow users to search sensitive or disallowed content. This level could be useful if you are parent or someone who wants to completely disallow their kids or yourself from watching sensitive content.
 
 ## 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:
+> By Default we provide 12 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
+> 2. dark-chocolate
+> 3. dracula
+> 4. gruvbox-dark
+> 5. monokai
+> 6. nord
+> 7. oceanic-next
+> 8. one-dark
+> 9. solarized-dark
+> 10. solarized-light
+> 11. tokyo-night
+> 12. tomorrow-night
 
 - **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).
 
@@ -47,6 +73,13 @@ Some of the configuration options provided in the file are stated below. These a
 
 ## Cache
 
-- **redis_connection_url:** Redis connection url address on which the client should connect on.
+- **redis_url:** Redis connection url address on which the client should connect on.
+
+> **Note**
+> This option can be commented out if you have compiled the app without the `redis-cache` feature. For more information, See [**building**](./building.md).
+
+## Search Engines
+
+- **upstream_search_engines:** Select from the different upstream search engines from which the results should be fetched.
 
-[⬅️  Go back to Home](./README.md)
+[⬅️ Go back to Home](./README.md)

docs/features.md

@@ -0,0 +1,42 @@
+# Features 
+
+The project provides 4 caching options as conditionally compiled features. This helps reduce the size of the compiled app by only including the code that is necessary for a particular caching option. 
+
+The different caching features provided are as follows: 
+- No cache
+- Redis cache
+- In memory cache
+- Hybrid cache
+
+## Explaination
+
+### No Cache 
+
+This feature can drastically reduce binary size but with the cost that subsequent search requests and previous & next page search results are not cached which can make navigating between pages slower. As well as page refreshes of the same page also becomes slower as each refresh has to fetch the results from the upstream search engines. 
+
+### Redis Cache
+
+This feature allows the search engine to cache the results on the redis server. This feature can be useful for having a dedicated cache server for multiple devices hosted with the `Websurfx` server which can use the one dedicated cache server for hosting their cache on it. But a disadvantage of this solution is that if the `Redis`server is located far away (for example provided by a vps as service) and if it is unavailable or down for some reason then the `Websurfx` server would not be able to function properly or will crash on startup.
+
+### In Memory Cache 
+
+This feature is the default feature provided by the project. This feature allows the search engine to cache the results in the memory which can help increase the speed of the fetched cache results and it also has an advantage that it is extremely reliable as all the results are stored in memory within the search engine. Though the disadvantage of this solution are that caching of results is slightly slower than the `redis-cache` solution, it requires a good amount of memory on the system and as such is not ideal for very low memory devices and is highly unscalable.
+
+### Hybrid Cache
+
+This feature provides the advantages of both `In Memory` caching and `Redis` caching and it is an ideal solution if you need a very resiliant and reliable solution for the `Websurfx` which can provide both speed and reliability. Like for example if the `Redis` server becomes unavailable then the search engine switches to `In Memory` caching until the server becomes available again. This solution can be useful for hosting `Websurfx` instance which will be used by hundreds or thousands of users over the world.
+
+## Tabular Summary 
+
+
+| **Attributes**                          | **Hybrid** | **In-Memory**                                        | **No Cache**    | **Redis**              |
+|-----------------------------------------|------------|------------------------------------------------------|-----------------|------------------------|
+| **Speed**                               | Fast       | Caching is slow, but retrieval of cache data is fast | Slow            | Fastest                |
+| **Reliability**                         | ✅          | ✅                                                    | ✅               | ❌                      |
+| **Scalability**                         | ✅          | ❌                                                    | -               | ✅                      |
+| **Resiliancy**                          | ✅          | ✅                                                    | ✅               | ❌                      |
+| **Production/Large Scale/Instance use** | ✅          | Not Recommended                                      | Not Recommended | Not Recommended        |
+| **Low Memory Support**                  | ❌          | ❌                                                    | ✅               | ❌                      |
+| **Binary Size**                         | Big        | Bigger than `No Cache`                               | small           | Bigger than `No Cache` |
+
+[⬅️ Go back to Home](./README.md)

docs/installation.md

@@ -2,16 +2,17 @@
 
 ## 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)):
+### Rolling/Edge/Unstable
 
-```bash
+You can install `Websurfx` through the [Aur](https://aur.archlinux.org/packages/websurfx-git), By running the following command (using [paru](https://github.com/Morganamilo/paru)):
+
+```shell
 paru -S websurfx-edge-git
 ```
 
 After installing it you can run the websurfx server by running the following commands:
 
-``` bash
-redis-server --port 8082 &
+```shell
 websurfx
 ```
 
@@ -19,7 +20,79 @@ Once you have started the server, open your preferred web browser and navigate t
 
 If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
 
-## Other Distros 
+### Stable
+
+For the stable version, follow the same steps as above (as mentioned for the `unstable/rolling/edge` version) with the only difference being that the package to be installed for stable version is called `websurfx-git` instead of `websurfx-edge-git`.
+
+## NixOS
+
+A `flake.nix` has been provided to allow installing `websurfx` easily. It utilizes [nearsk](https://github.com/nix-community/naersk) to automatically generate a derivation based on `Cargo.toml` and `Cargo.lock`.
+
+The Websurfx project provides 2 versions/flavours for the flake `stable` and `rolling/unstable/edge`. The steps for each are covered below in different sections.
+
+### Rolling/Edge/Unstable
+
+To get started, First clone the repository, edit the config file which is located in the `websurfx` directory 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
+cp -rf ./websurfx/ ~/.config/
+$ mkdir /opt/websurfx/
+$ cp -rf ./public/ /opt/websurfx/
+nix build .#websurfx
+nix run .#websurfx
+```
+
+> **Note**
+> In the above command the dollar sign(**$**) refers to running the command in privilaged mode by using utilities `sudo`, `doas`, `pkgexec` or any other privilage access methods.
+
+Once you have run the above set of commands, then 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).
+
+> Optionally, you may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages` as follows:
+>
+> ```nix
+> {
+>   description = "My awesome configuration";
+>
+>   inputs = {
+>     websurfx.url = "github:neon-mmd/websurfx";
+>   };
+>
+>   outputs = { nixpkgs, ... }@inputs: {
+>     nixosConfigurations = {
+>       hostname = nixpkgs.lib.nixosSystem {
+>         system = "x86_64-linux";
+>         modules = [{
+>           environment.systemPackages = [inputs.websurfx.packages.x86_64-linux.websurfx];
+>         }];
+>       };
+>     };
+>   };
+> }
+> ```
+
+### Stable
+
+For the stable version, follow the same steps as above (as mentioned for the `unstable/rolling/edge version`) with an addition of one command which has to be performed after cloning and changing directory into the repository which makes the building step as follows:
+
+```shell
+git clone https://github.com/neon-mmd/websurfx.git
+cd websurfx
+git checkout stable
+cp -rf ./websurfx/ ~/.config/
+$ mkdir /opt/websurfx/
+$ cp -rf ./public/ /opt/websurfx/
+nix build .#websurfx
+nix run .#websurfx
+```
+
+> **Note**
+> In the above command the dollar sign(**$**) refers to running the command in privilaged mode by using utilities `sudo`, `doas`, `pkgexec` or any other privilage access methods.
+
+## 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 🙂.
 
@@ -34,6 +107,7 @@ To get started with Websurfx, clone the repository, edit the config file which i
 ```shell
 git clone https://github.com/neon-mmd/websurfx.git
 cd websurfx
+git checkout stable
 cargo build -r
 redis-server --port 8082 &
 ./target/release/websurfx
@@ -50,13 +124,63 @@ 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
+```
+
+Once you have changed the directory to the `websurfx` directory then follow the build options listed below:
+
+### Hybrid Cache
+
+> For more information on the features and their pros and cons. see: [**Features**](./features.md)
+
+To build the search engine with the `Hybrid caching` feature. Run the following build command:
+
+```shell
+cargo build -r --features redis-cache
+```
+
+### Memory Cache (Default Feature)
+
+> For more information on the features and their pros and cons. see: [**Features**](./features.md)
+
+To build the search engine with the `In-Memory caching` feature. Run the following build command:
+
+```shell
 cargo build -r
-redis-server --port 8082 &
+```
+
+### No Cache
+
+> For more information on the features and their pros and cons. see: [**Features**](./features.md)
+
+To build the search engine with the `No caching` feature. Run the following build command:
+
+```shell
+cargo build -r --no-default-features
+```
+
+### Redis Cache
+
+> For more information on the features and their pros and cons. see: [**Features**](./features.md)
+
+To build the search engine with the `hybrid caching` feature. Run the following build command:
+
+```shell
+cargo build -r --no-default-features --features redis-cache
+```
+
+> Optionally, If you have build the app with the `Redis cache`or `Hybrid cache` feature (as mentioned above) then before launching the search engine run the following command:
+>
+> ```shell
+> redis-server --port 8082 &
+> ```
+
+Once you have finished building the `search engine`. then run the following command to start the search engine:
+
+```shell
 ./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.
+Once you have started the server, then launch 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).
 
@@ -64,7 +188,121 @@ If you want to change the port or the ip or any other configuration setting chec
 
 Before you start, you will need [Docker](https://docs.docker.com/get-docker/) installed on your system first.
 
-## Stable
+## Prebuild
+
+The Websurfx project provides several prebuild images based on the different features provided by the search engine. To get started using the prebuild image, you will first need to create a `docker-compose.yml` file with the following content:
+
+```yaml
+---
+version: '3.9'
+services:
+  app:
+    # Comment the line below if you don't want to use the `hybrid/latest` image.
+    image: neonmmd/websurfx:latest
+    # Uncomment the line below if you want to use the `no cache` image.
+    # image: neonmmd/websurfx:nocache
+    # Uncomment the line below if you want to use the `memory` image.
+    # image: neonmmd/websurfx:memory
+    # Uncomment the line below if you want to use the `redis` image.
+    # image: neonmmd/websurfx:redis
+    ports:
+      - 8080:8080
+    # Uncomment the following lines if you are using the `hybrid/latest` or `redis` image.
+    # depends_on:
+    #   - redis
+    # links:
+    #   - redis
+    volumes:
+      - ./websurfx/:/etc/xdg/websurfx/
+  # Uncomment the following lines if you are using the `hybrid/latest` or `redis` image.
+  # redis:
+  #   image: redis:latest
+  #   ports:
+  #     - 6379:6379
+```
+
+Then make sure to edit the `docker-compose.yml` file as required. After that create a directory `websurfx` in the directory you have placed the `docker-compose.yml` file, and then in the new directory create two new empty files named `allowlist.txt` and `blocklist.txt`. Finally, create a new config file `config.lua` with the default configuration, which looks something like this:
+
+```lua
+-- ### General ###
+logging = true -- an option to enable or disable logs.
+debug = false -- an option to enable or disable debug mode.
+threads = 8 -- the amount of threads that the app will use to run (the value should be greater than 0).
+
+-- ### Server ###
+port = "8080" -- port on which server should be launched
+binding_ip = "0.0.0.0" --ip address on the which server should be launched.
+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 (more than one))
+-- 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.
+request_timeout = 30 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
+rate_limiter = {
+	number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
+	time_limit = 3, -- The time limit in which the quantity of requests that should be accepted.
+}
+
+-- ### Search ###
+-- Filter results based on different levels. The levels provided are:
+-- {{
+-- 0 - None
+-- 1 - Low
+-- 2 - Moderate
+-- 3 - High
+-- 4 - Aggressive
+-- }}
+safe_search = 2
+
+-- ### Website ###
+-- The different colorschemes provided are:
+-- {{
+-- catppuccin-mocha
+-- dark-chocolate
+-- dracula
+-- gruvbox-dark
+-- monokai
+-- nord
+-- oceanic-next
+-- one-dark
+-- solarized-dark
+-- solarized-light
+-- tokyo-night
+-- 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_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
+
+-- ### Search Engines ###
+upstream_search_engines = {
+	DuckDuckGo = true,
+	Searx = false,
+} -- select the upstream search engines from which the results should be fetched.
+```
+
+Then run the following command to deploy the search engine:
+
+```shell
+$ docker compose up -d
+```
+
+> **Note**
+> In the above command the dollar sign(**$**) refers to running the command in privilaged mode by using utilities `sudo`, `doas`, `pkgexec` or any other privilage access methods.
+
+Then launch the browser of your choice and navigate to http://<ip_address_of_the_device>:<whatever_port_you_provided_in_the_config>.
+
+> **Note**
+> The official prebuild images only support `stable` versions of the app and will not support `rolling/edge/unstable` versions. But with support and contribution it could be made available for these versions as well 🙂.
+
+## Manual Deployment
+
+This section covers how to deploy the app with docker manually by manually building the image and deploying it.
+
+> **Note**
+> This section is provided for those who want to futher customize the docker image or for those who are extra cautious about security.
+
+### Unstable/Edge/Rolling
 
 First clone the the repository by running the following command:
 
@@ -76,49 +314,82 @@ 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
+-- ### General ###
+logging = true -- an option to enable or disable logs.
+debug = false -- an option to enable or disable debug mode.
+threads = 8 -- the amount of threads that the app will use to run (the value should be greater than 0).
+
+-- ### 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.
+binding_ip = "0.0.0.0" --ip address on the which server should be launched.
+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 (more than one))
+-- 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.
+request_timeout = 30 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
+rate_limiter = {
+	number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
+	time_limit = 3, -- The time limit in which the quantity of requests that should be accepted.
+}
+
+-- ### Search ###
+-- Filter results based on different levels. The levels provided are:
+-- {{
+-- 0 - None
+-- 1 - Low
+-- 2 - Moderate
+-- 3 - High
+-- 4 - Aggressive
+-- }}
+safe_search = 2
 
--- Website
+-- ### Website ###
 -- The different colorschemes provided are:
 -- {{
 -- catppuccin-mocha
+-- dark-chocolate
 -- dracula
+-- gruvbox-dark
 -- monokai
 -- nord
 -- oceanic-next
+-- one-dark
 -- solarized-dark
 -- solarized-light
+-- tokyo-night
 -- 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.
+-- ### Caching ###
+redis_url = "redis://redis:6379" -- 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.
+-- ### Search Engines ###
+upstream_search_engines = {
+	DuckDuckGo = true,
+	Searx = false,
+} -- select the upstream search engines from which the results should be fetched.
 ```
 
-After this run the following command to deploy the app:
+After this make sure to edit the `docker-compose.yml` and `Dockerfile` files as required and run the following command to deploy the app:
 
 ```bash
-docker compose up -d --build
+$ docker compose up -d --build
 ```
 
+> **Note**
+> In the above command the dollar sign(**$**) refers to running the command in privilaged mode by using utilities `sudo`, `doas`, `pkgexec` or any other privilage access methods.
+
 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
+### Stable
 
-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:
+For the stable version, follow the same steps as above (as mentioned for the unstable/rolling/edge 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
+git checkout stable
 ```
 
-[⬅️  Go back to Home](./README.md)
+[⬅️ Go back to Home](./README.md)

docs/instances.md

@@ -0,0 +1,12 @@
+# Instances 
+
+> To contribute your server instance, check out the contributing guide [here](https://github.com/neon-mmd/websurfx/blob/HEAD/CONTRIBUTING.md).
+
+This page provides a list of `Websurfx` instances provided by us and our community. 
+
+|URL|Network|Version|Location|Behind Cloudflare?|Maintained By|TLS|IPv6|Comment|
+|-|-|-|-|-|-|-|-|-|
+|https://alamin655-websurfx.hf.space/|www|v0.21.4|🇺🇸 US||[websurfx project](https://github.com/neon-mmd/websurfx)|✅|||
+
+
+[⬅️ Go back to Home](./README.md)

docs/theming.md

@@ -8,17 +8,17 @@ By default `websurfx` comes with 9 colorschemes to choose from which can be easi
 
 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>;
+```css
+:root {
+  --background-color: <background color>;
+  --foreground-color: <foreground color (text color on the website) >;
+  --color-one: <color 1>;
+  --color-two: <color 2>;
+  --color-three: <color 3>;
+  --color-four: <color 4>;
+  --color-five: <color 5>;
+  --color-six: <color 6>;
+  --color-seven: <color 7>;
 }
 ```
 
@@ -27,17 +27,17 @@ Creating coloschemes is as easy as it gets it requires the user to have a theme
 
 **Example of `catppuccin-mocha` colorscheme:**
 
-``` css
+```css
 :root {
-  --bg: #1e1e2e;
-  --fg: #cdd6f4;
-  --1: #45475a;
-  --2: #f38ba8;
-  --3: #a6e3a1;
-  --4: #f9e2af;
-  --5: #89b4fa;
-  --6: #f5c2e7;
-  --7: #ffffff;
+  --background-color: #1e1e2e;
+  --foreground-color: #cdd6f4;
+  --color-one: #45475a;
+  --color-two: #f38ba8;
+  --color-three: #a6e3a1;
+  --color-four: #f9e2af;
+  --color-five: #89b4fa;
+  --color-six: #f5c2e7;
+  --color-seven: #ffffff;
 }
 ```
 
@@ -47,14 +47,15 @@ Creating coloschemes is as easy as it gets it requires the user to have a theme
 
 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 
+## Custom
 
-To write custom color scheme, it requires the user to have some knowledge of `css stylesheets`. 
+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
+
+```css
 * {
   padding: 0;
   margin: 0;
@@ -71,11 +72,13 @@ body {
   justify-content: space-between;
   align-items: center;
   height: 100vh;
-  background: var(--1);
+  background: var(--color-one);
 }
 ```
+
 ### Styles for the index page
-``` css
+
+```css
 .search-container {
   display: flex;
   flex-direction: column;
@@ -88,8 +91,10 @@ body {
   display: flex;
 }
 ```
+
 ### Styles for the search box and search button
-``` css
+
+```css
 .search_bar {
   display: flex;
 }
@@ -101,7 +106,7 @@ body {
   outline: none;
   border: none;
   box-shadow: rgba(0, 0, 0, 1);
-  background: var(--fg);
+  background: var(--foreground-color);
 }
 
 .search_bar button {
@@ -114,8 +119,8 @@ body {
   outline: none;
   border: none;
   gap: 0;
-  background: var(--bg);
-  color: var(--3);
+  background: var(--background-color);
+  color: var(--color-three);
   font-weight: 600;
   letter-spacing: 0.1rem;
 }
@@ -124,11 +129,133 @@ body {
 .search_bar button:hover {
   filter: brightness(1.2);
 }
+
+.search_area .search_options {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.search_area .search_options select {
+  margin: 0.7rem 0;
+  width: 20rem;
+  background-color: var(--color-one);
+  color: var(--foreground-color);
+  padding: 1rem 2rem;
+  border-radius: 0.5rem;
+  outline: none;
+  border: none;
+  text-transform: capitalize;
+}
+
+.search_area .search_options option:hover {
+  background-color: var(--color-one);
+}
+
+.result_not_found {
+  display: flex;
+  flex-direction: column;
+  font-size: 1.5rem;
+  color: var(--foreground-color);
+}
+
+.result_not_found p {
+  margin: 1rem 0;
+}
+
+.result_not_found ul {
+  margin: 1rem 0;
+}
+
+.result_not_found img {
+  width: 40rem;
+}
 ```
+
+```css
+/* styles for the error box */
+.error_box .error_box_toggle_button {
+  background: var(--foreground-color);
+}
+
+.error_box .dropdown_error_box {
+  position: absolute;
+  display: none;
+  flex-direction: column;
+  background: var(--background-color);
+  border-radius: 0;
+  margin-left: 2rem;
+  min-height: 20rem;
+  min-width: 22rem;
+}
+.error_box .dropdown_error_box.show {
+  display: flex;
+}
+.error_box .dropdown_error_box .error_item,
+.error_box .dropdown_error_box .no_errors {
+  display: flex;
+  align-items: center;
+  color: var(--foreground-color);
+  letter-spacing: 0.1rem;
+  padding: 1rem;
+  font-size: 1.2rem;
+}
+.error_box .dropdown_error_box .error_item {
+  justify-content: space-between;
+}
+.error_box .dropdown_error_box .no_errors {
+  min-height: 18rem;
+  justify-content: center;
+}
+
+.error_box .dropdown_error_box .error_item:hover {
+  box-shadow: inset 0 0 100px 100px rgba(255, 255, 255, 0.1);
+}
+
+.error_box .error_item .severity_color {
+  width: 1.2rem;
+  height: 1.2rem;
+}
+.results .result_disallowed,
+.results .result_filtered,
+.results .result_engine_not_selected {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  gap: 10rem;
+  font-size: 2rem;
+  color: var(--foreground-color);
+  margin: 0rem 7rem;
+}
+
+.results .result_disallowed .user_query,
+.results .result_filtered .user_query,
+.results .result_engine_not_selected .user_query {
+  color: var(--background-color);
+  font-weight: 300;
+}
+
+.results .result_disallowed img,
+.results .result_filtered img,
+.results .result_engine_not_selected img {
+  width: 30rem;
+}
+
+.results .result_disallowed div,
+.results .result_filtered div,
+.results .result_engine_not_selected div {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+  line-break: strict;
+}
+```
+
 ### Styles for the footer and header
-``` css
+
+```css
 header {
-  background: var(--bg);
+  background: var(--background-color);
   width: 100%;
   display: flex;
   justify-content: right;
@@ -151,7 +278,7 @@ footer ul li a,
 header ul li a:visited,
 footer ul li a:visited {
   text-decoration: none;
-  color: var(--2);
+  color: var(--color-two);
   text-transform: capitalize;
   letter-spacing: 0.1rem;
 }
@@ -162,7 +289,27 @@ header ul li a {
 
 header ul li a:hover,
 footer ul li a:hover {
-  color: var(--5);
+  color: var(--color-five);
+}
+
+footer div span {
+  font-size: 1.5rem;
+  color: var(--color-four);
+}
+
+footer div {
+  display: flex;
+  gap: 1rem;
+}
+
+footer {
+  background: var(--background-color);
+  width: 100%;
+  padding: 1rem;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
 }
 
 footer div span {
@@ -185,8 +332,10 @@ footer {
   align-items: center;
 }
 ```
+
 ### Styles for the search page
-``` css
+
+```css
 .results {
   width: 90%;
   display: flex;
@@ -213,28 +362,28 @@ footer {
 
 .results_aggregated .result h1 a {
   font-size: 1.5rem;
-  color: var(--2);
+  color: var(--color-two);
   text-decoration: none;
   letter-spacing: 0.1rem;
 }
 
 .results_aggregated .result h1 a:hover {
-  color: var(--5);
+  color: var(--color-five);
 }
 
 .results_aggregated .result h1 a:visited {
-  color: var(--bg);
+  color: var(--background-color);
 }
 
 .results_aggregated .result small {
-  color: var(--3);
+  color: var(--color-three);
   font-size: 1.1rem;
   word-wrap: break-word;
   line-break: anywhere;
 }
 
 .results_aggregated .result p {
-  color: var(--fg);
+  color: var(--foreground-color);
   font-size: 1.2rem;
   margin-top: 0.3rem;
   word-wrap: break-word;
@@ -245,13 +394,13 @@ footer {
   text-align: right;
   font-size: 1.2rem;
   padding: 1rem;
-  color: var(--5);
+  color: var(--color-five);
 }
 ```
 
-### Styles for the 404 page 
+### Styles for the 404 page
 
-``` css
+```css
 .error_container {
   display: flex;
   justify-content: center;
@@ -290,16 +439,18 @@ footer {
 
 .error_content p a,
 .error_content p a:visited {
-  color: var(--2);
+  color: var(--color-two);
   text-decoration: none;
 }
 
 .error_content p a:hover {
-  color: var(--5);
+  color: var(--color-five);
 }
 ```
+
 ### Styles for the previous and next button on the search page
-``` css
+
+```css
 .page_navigation {
   padding: 0 0 2rem 0;
   display: flex;
@@ -308,8 +459,8 @@ footer {
 }
 
 .page_navigation button {
-  background: var(--bg);
-  color: var(--fg);
+  background: var(--background-color);
+  color: var(--foreground-color);
   padding: 1rem;
   border-radius: 0.5rem;
   outline: none;
@@ -326,40 +477,258 @@ footer {
 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 {
+  font-size: 1.5rem;
+  color: var(--foreground-color);
+  padding-bottom: 10px;
+}
 
-.about-container article h1{
-    color: var(--2);
-    font-size: 2.8rem;
-  }
+.about-container article h1 {
+  color: var(--color-two);
+  font-size: 2.8rem;
+}
 
-.about-container article div{
-    padding-bottom: 15px;
-  }
+.about-container article div {
+  padding-bottom: 15px;
+}
 
-.about-container a{
-  color:var(--3);
+.about-container a {
+  color: var(--color-three);
 }
 
-.about-container article h2{
-  color: var(--3);
+.about-container article h2 {
+  color: var(--color-three);
   font-size: 1.8rem;
   padding-bottom: 10px;
 }
 
-.about-container p{
-  color:var(--fg);
-  font-size:  1.6rem;
+.about-container p {
+  color: var(--foreground-color);
+  font-size: 1.6rem;
   padding-bottom: 10px;
 }
 
-.about-container h3{
+.about-container h3 {
+  font-size: 1.5rem;
+}
+
+.about-container {
+  width: 80%;
+}
+```
+
+### Styles for the Settings Page
+
+This part is only available right now in the **rolling/edge/unstable** version
+
+```css
+.settings_container {
+  display: flex;
+  justify-content: space-around;
+  width: 80dvw;
+}
+
+.settings h1 {
+  color: var(--color-two);
+  font-size: 2.5rem;
+}
+
+.settings hr {
+  border-color: var(--color-three);
+  margin: 0.3rem 0 1rem 0;
+}
+
+.settings_container .sidebar {
+  width: 30%;
+  cursor: pointer;
+  font-size: 2rem;
+  display: flex;
+  flex-direction: column;
+  margin-right: 0.5rem;
+  margin-left: -0.7rem;
+  padding: 0.7rem;
+  border-radius: 5px;
+  font-weight: bold;
+  margin-bottom: 0.5rem;
+  color: var(--foreground-color);
+  text-transform: capitalize;
+  gap: 1.5rem;
+}
+
+.settings_container .sidebar .btn {
+  padding: 0.5rem;
+  border-radius: 0.5rem;
+}
+
+.settings_container .sidebar .btn.active {
+  background-color: var(--color-two);
+}
+
+.settings_container .main_container {
+  width: 70%;
+  border-left: 1.5px solid var(--color-three);
+  padding-left: 3rem;
+}
+
+.settings_container .tab {
+  display: none;
+}
+
+.settings_container .tab.active {
+  display: flex;
+  flex-direction: column;
+  justify-content: space-around;
+}
+
+.settings_container button {
+  margin-top: 1rem;
+  padding: 1rem 2rem;
+  font-size: 1.5rem;
+  background: var(--color-three);
+  color: var(--background-color);
+  border-radius: 0.5rem;
+  border: 2px solid transparent;
+  font-weight: bold;
+  transition: all 0.1s ease-out;
+  cursor: pointer;
+  box-shadow: 5px 5px;
+  outline: none;
+}
+
+.settings_container button:active {
+  box-shadow: none;
+  translate: 5px 5px;
+}
+
+.settings_container .main_container .message {
+  font-size: 1.5rem;
+  color: var(--foreground-color);
+}
+
+.settings_container .tab h3 {
+  font-size: 2rem;
+  font-weight: bold;
+  color: var(--color-four);
+  margin-top: 1.5rem;
+  text-transform: capitalize;
+}
+
+.settings_container .tab .description {
   font-size: 1.5rem;
+  margin-bottom: 0.5rem;
+  color: var(--foreground-color);
+}
+
+.settings_container .user_interface select,
+.settings_container .general select {
+  margin: 0.7rem 0;
+  width: 20rem;
+  background-color: var(--background-color);
+  color: var(--foreground-color);
+  padding: 1rem 2rem;
+  border-radius: 0.5rem;
+  outline: none;
+  border: none;
+  text-transform: capitalize;
+}
+
+.settings_container .user_interface option:hover,
+.settings_container .general option:hover {
+  background-color: var(--color-one);
+}
+
+.settings_container .engines .engine_selection {
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  gap: 1rem;
+  padding: 1rem 0;
+}
+
+.settings_container .engines .toggle_btn {
+  color: var(--foreground-color);
+  font-size: 1.5rem;
+  display: flex;
+  gap: 0.5rem;
+  align-items: center;
+}
+
+.settings_container .engines hr {
+  margin: 0;
+}
+
+.settings_container .cookies input {
+  margin: 1rem 0rem;
+}
+```
+
+### Styles for the Toggle Button
+
+This part is only available right now in the **rolling/edge/unstable** version
+
+```css
+/* The switch - the box around the slider */
+.switch {
+  position: relative;
+  display: inline-block;
+  width: 6rem;
+  height: 3.4rem;
+}
+
+/* Hide default HTML checkbox */
+.switch input {
+  opacity: 0;
+  width: 0;
+  height: 0;
+}
+
+/* The slider */
+.slider {
+  position: absolute;
+  cursor: pointer;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background-color: var(--background-color);
+  -webkit-transition: 0.4s;
+  transition: 0.4s;
+}
+
+.slider:before {
+  position: absolute;
+  content: '';
+  height: 2.6rem;
+  width: 2.6rem;
+  left: 0.4rem;
+  bottom: 0.4rem;
+  background-color: var(--foreground-color);
+  -webkit-transition: 0.4s;
+  transition: 0.4s;
+}
+
+input:checked + .slider {
+  background-color: var(--color-three);
+}
+
+input:focus + .slider {
+  box-shadow: 0 0 1px var(--color-three);
+}
+
+input:checked + .slider:before {
+  -webkit-transform: translateX(2.6rem);
+  -ms-transform: translateX(2.6rem);
+  transform: translateX(2.6rem);
+}
+
+/* Rounded sliders */
+.slider.round {
+  border-radius: 3.4rem;
+}
+
+.slider.round:before {
+  border-radius: 50%;
 }
 ```
 
-[⬅️  Go back to Home](./README.md)
+[⬅️ Go back to Home](./README.md)

flake.lock

@@ -0,0 +1,94 @@
+{
+  "nodes": {
+    "naersk": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      },
+      "locked": {
+        "lastModified": 1694081375,
+        "narHash": "sha256-vzJXOUnmkMCm3xw8yfPP5m8kypQ3BhAIRe4RRCWpzy8=",
+        "owner": "nix-community",
+        "repo": "naersk",
+        "rev": "3f976d822b7b37fc6fb8e6f157c2dd05e7e94e89",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "ref": "master",
+        "repo": "naersk",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1695318763,
+        "narHash": "sha256-FHVPDRP2AfvsxAdc+AsgFJevMz5VBmnZglFUMlxBkcY=",
+        "path": "/nix/store/p7iz0r8gs6ppkhj83zjmwyd21k8b7v3y-source",
+        "rev": "e12483116b3b51a185a33a272bf351e357ba9a99",
+        "type": "path"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1695318763,
+        "narHash": "sha256-FHVPDRP2AfvsxAdc+AsgFJevMz5VBmnZglFUMlxBkcY=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e12483116b3b51a185a33a272bf351e357ba9a99",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "naersk": "naersk",
+        "nixpkgs": "nixpkgs_2",
+        "utils": "utils"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1694529238,
+        "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,52 @@
+{
+  # Websurfx NixOS flake
+  inputs = {
+    naersk.url = "github:nix-community/naersk/master";
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = {
+    naersk,
+    nixpkgs,
+    self,
+    utils,
+  }:
+  # We do this for all systems - namely x86_64-linux, aarch64-linux,
+  # x86_64-darwin and aarch64-darwin
+    utils.lib.eachDefaultSystem (system: let
+      pkgs = import nixpkgs {inherit system;};
+      naersk-lib = pkgs.callPackage naersk {};
+    in rec {
+      # Build via "nix build .#default"
+      packages.default = naersk-lib.buildPackage {
+        # The build dependencies
+        buildInputs = with pkgs; [pkg-config openssl];
+        src = ./.;
+      };
+
+      # Enter devshell with all the tools via "nix develop"
+      # or "nix-shell"
+      devShells.default = with pkgs;
+        mkShell {
+          buildInputs = [
+            actionlint
+            cargo
+            haskellPackages.hadolint
+            nodePackages_latest.cspell
+            nodePackages_latest.eslint
+            nodePackages_latest.markdownlint-cli2
+            nodePackages_latest.stylelint
+            redis
+            rustPackages.clippy
+            rustc
+            yamllint
+          ];
+          RUST_SRC_PATH = rustPlatform.rustLibSrc;
+        };
+
+      # Build via "nix build .#websurfx", which is basically just
+      # calls the build function
+      packages.websurfx = packages.default;
+    });
+}