You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Aloïs Micard c752eb95e0
Release 0.5.1
4 years ago
.github/workflows Do not fails CI if go report card update fails 4 years ago
api Finalize proper error management + fix 4 years ago
build/docker Finalize whole implementation 4 years ago
cmd Finalize whole implementation 4 years ago
deployments/docker Finalize usage of authentication for components 4 years ago
docs architecture.svg -> architecture.png 4 years ago
internal Release 0.5.1 4 years ago
scripts Fix log.sh (oops) 4 years ago
.dockerignore Start implementing new architecture 4 years ago
.gitignore Implement API authentication 4 years ago
.goreleaser.yml Release executables using CD pipeline 4 years ago
LICENSE Initial commit 4 years ago
README.md architecture.svg -> architecture.png 4 years ago
go.mod Use resty client 4 years ago
go.sum Finalize proper error management + fix 4 years ago
snapcraft.yaml Release 0.2.0 4 years ago

README.md

Trandoshan dark web crawler

CI

This repository is a complete rewrite of the Trandoshan dark web crawler. Everything has been written inside a single Git repository to ease maintenance.

Why a rewrite?

The first version of Trandoshan (available here) is working great but not really professional, the code start to be a mess, hard to manage since split in multiple repositories, etc.

I have therefore decided to create & maintain the project in this specific repository, where all components code will be available (as a Go module).

How to start the crawler

To start the crawler, one just need to execute the following command:

$ ./scripts/start.sh

and wait for all containers to start.

Notes

  • You can start the crawler in detached mode by passing --detach to start.sh.
  • Ensure you have at least 3 GB of memory as the Elasticsearch stack docker will require 2 GB.

How to initiate crawling

Since the API is exposed on localhost:15005, one can use it to start crawling:

using trandoshanctl executable:

$ trandoshanctl schedule https://www.facebookcorewwwi.onion

or using the docker image:

$ docker run creekorful/trandoshanctl --api-uri <uri> schedule https://www.facebookcorewwwi.onion

(you'll need to specify the api uri if you use the docker container)

this will schedule given URL for crawling.

How to speed up crawling

If one want to speed up the crawling, he can scale the instance of crawling component in order to increase performances. This may be done by issuing the following command after the crawler is started:

$ ./scripts/scale.sh crawler=5

this will set the number of crawler instance to 5.

How to view results

Using trandoshanctl

$ trandoshanctl search <term>

Using kibana

You can use the Kibana dashboard available at http://localhost:15004. You will need to create an index pattern named 'resources', and when it asks for the time field, choose 'time'.

How to hack the crawler

If you've made a change to one of the crawler component and wish to use the updated version when running start.sh you just need to issue the following command:

$ ./script/build.sh

this will rebuild all crawler images using local changes. After that just run start.sh again to have the updated version running.

Architecture

The architecture details are available here.