Git Product home page Git Product logo

crawler-extension's Introduction

banner

Mwmbl - No ads, no tracking, no cruft, no profit

Matrix

Mwmbl is a non-profit, ad-free, free-libre and free-lunch search engine with a focus on useability and speed. At the moment it is little more than an idea together with a proof of concept implementation of the web front-end and search technology on a small index.

Our vision is a community working to provide top quality search particularly for hackers, funded purely by donations.

mwmbl

Crawling

Update 2022-02-05: We now have a distributed crawler that runs on our volunteers' machines! If you have Firefox you can help out by installing our extension. This will crawl the web in the background, retrieving one page a second. It does not use or access any of your personal data. Instead it crawls the web at random, using the top scoring sites on Hacker News as seed pages. After extracting a summary of each page, it batches these up and sends the data to a central server to be stored and indexed.

Why a non-profit search engine?

The motives of ad-funded search engine are at odds with providing an optimal user experience. These sites are optimised for ad revenue, with user experience taking second place. This means that pages are loaded with ads which are often not clearly distinguished from search results. Also, eitland on Hacker News comments:

Thinking about it it seems logical that for a search engine that practically speaking has monopoly both on users and as mattgb points out - [to some] degree also on indexing - serving the correct answer first is just dumb: if they can keep me going between their search results and tech blogs with their ads embedded one, two or five times extra that means one, two or five times more ad impressions.

But what about...?

The space of alternative search engines has expanded rapidly in recent years. Here's a very incomplete list of some that have interested me:

  • YaCy - an open source distributed search engine
  • search.marginalia.nu - a search engine favouring text-heavy websites
  • Gigablast - a privacy-focused search engine whose owner makes money by selling the technology to third parties
  • Brave
  • DuckDuckGo

Of these, YaCy is the closest in spirit to the idea of a non-profit search engine. The index is distributed across a peer-to-peer network. Unfortunately this design decision makes search very slow.

Marginalia Search is fantastic, but it is more of a personal project than an open source community.

All other search engines that I've come across are for-profit. Please let me know if I've missed one!

Designing for non-profit

To be a good search engine, we need to store many items, but the cost of running the engine is at least proportional to the number of items stored. Our main consideration is thus to reduce the cost per item stored.

The design is founded on the observation that most items rank for a small set of terms. In the extreme version of this, where each item ranks for a single term, the usual inverted index design is grossly inefficient, since we have to store each term at least twice: once in the index and once in the item data itself.

Our design is a giant hash map. We have a single store consisting of a fixed number N of pages. Each page is of a fixed size (currently 4096 bytes to match a page of memory), and consists of a compressed list of items. Given a term for which we want an item to rank, we compute a hash of the term, a value between 0 and N - 1. The item is then stored in the corresponding page.

To retrieve pages, we simply compute the hash of the terms in the user query and load the corresponding pages, filter the items to those containing the term and rank the items. Since each page is small, this can be done very quickly.

Because we compress the list of items, we can rank for more than a single term and maintain an index smaller than the inverted index design. Well, that's the theory. This idea has yet to be tested out on a large scale.

How to contribute

There are lots of ways to help:

If you would like to help in any of these or other ways, thank you! Please join our Matrix chat server or email the main author (email address is in the git commit history).

Development

Local Testing

For trying out the service locally see the section in the Mwmbl book.

Using Dokku

Note: this method is not recommended as it is more involved, and your index will not have any data in it unless you set up a crawler to crawl to your server. You will need to set up your own Backblaze or S3 equivalent storage, or have access to the production keys, which we probably won't give you.

Follow the deployment instructions

Frequently Asked Question

How do you pronounce "mwmbl"?

Like "mumble". I live in Mumbles, which is spelt "Mwmbwls" in Welsh. But the intended meaning is "to mumble", as in "don't search, just mwmbl!"

crawler-extension's People

Contributors

adjagu avatar colinespinas avatar daoudclarke avatar omasanori avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

marxo

crawler-extension's Issues

Don't try and crawl really large pages

Our extension can potentially cause our user issues if it attempts to crawl a really large page. We should have a safeguard so that if we attempt to fetch a large page we bail out before causing memory issues for our users.

Browser Compatibility

As Chrome Web Store deprecated manifests v2 and Firefox doesn't support them we will need a different version for each of those.

The ideal solution would be to get a script running on build time to convert a single manifest to each standards and distribute two separate versions for each stores/browsers.

This could be ran by a workflow once/if #5 is done.

Crawl one page at a time

At the moment we use setInterval to crawl one page per second. Instead, it would be safer to ensure we only crawl one page at a time in a continuous loop using async/await.

Also, ensure that this loop is only called once. At the moment this can be triggered by multiple events: onInstalled, onStartup and onEnabled. We need to ensure there is exactly one loop running at all times.

Build Failed

Issue: Build failed when following the "How to build" section of README.md.

Steps to reproduce:

  1. git clone https://github.com/mwmbl/crawler-extension
  2. cd crawler-extension
  3. npm run build

Output:

> [email protected] build
> vite build
/tmp/build-ddf9cdff.sh: line 1: vite: command not found

System Information:

  • NPM v8.14.0
  • NodeJS v18.6.0
  • OS: EndeavourOS
  • Kernel: 5.18.12-zen1-1-zen

I'm probably missing something obvious.

Add dev mode for panel and options

At the moment the dev script from package.json does not serve any file and throws a 404.

We could use the dev mode to live reload the panel and options files to make a better developer experience.

[Feature] Crawl page on demand

I think this one is easy to add.

A contextual menu option to crawl the specific page (not the whole website) of a website you may be visitting.

This could help to crawl your favourite or used pages. Could be tutorials you look from time to time, real useful replies on stackoverflow, etc.

Could be considered these websites were more heavy in the index if satinized properly (avoid SPAM from corporations).

Improve crawler prioritisation

At the moment, the crawler uses heuristics to decide which pages to crawl, however this often fails and it gets stuck in loops of crawling the same rubbish site for days on end.

To get around this, I propose that we choose which sites we wish to crawl, and distribute the crawling across those sites - instead of distributing by individual pages.

So the algorithm would work something like this:

  • We have a list of top sites that we would like to crawl. We will spend say 50% of our time crawling these sites.
  • For each top site, choose a maximum N pages to crawl for that site. We can use our current scoring technique to choose which pages.
  • For every other site, choose a maximum M pages to crawl for those sites, where M < N. Again we can use our current scoring to choose which sites/pages to crawl, up to a maximum of 50% of the total number of pages to crawl.

I would suggest initial values of N = 100 and M = 1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.