Add a seeder

[drew2a]

This PR introduces scripts for easily set up a seedbox (for propagating data to Tribler's network).

Linked to #21

The seedbox consists of two parts:

1. Torrent seeding (by using a LibTorrent protocol)
2. Channel disseminating (by using the Tribler network)

Prerequisites

1. Clone the tribler repo include sub modules:

   git clone --recursive https://github.com/Tribler/tribler.git

2. Install requirements:

   python3 -m pip install -r requirements.txt 

3. Add necessary folders to PYTHONPATH (below the bash example)

   export PYTHONPATH=${PYTHONPATH}:`echo .. ../src/{pyipv8,tribler-common,tribler-core} | tr " " :`

Torrent seeding

To start torrents' seeding run the following script:

python3 seeder.py <source folder>

Consider the following folder structure:

source folder
├ sub_directory
| ├ file1
| └file2
├ sub_directory2
| ├ file3
| └ file4
├ thumbnail.png
└ description.md

In this particular example, seeder.py will create two torrents:
sub_directory.torrent and sub_directory2.torrent.

seeder.py will start to seed them through BitTorrent protocol after creating.

Data disseminating

To start disseminating data through Tribler's network run the following script:

python3 disseminator.py <source folder>

This script will create a channel and will disseminate it to Tribler.

Consider the following folder structure:

source folder
├ sub_directory.torrent
├ sub_directory2.torrent
├ thumbnail.png
└ description.md

Above you can see two "special" files:

• thumbnail.png
• description.md

The channel will be created with description based on these files.
As the channel name, the source folder's name will be used.

Error reporting

In case you want errors to be reported, you can use Sentry

To enable error reporting, specify the following environment variable:

export SENTRY_URL=<sentry_url>

URL can be taken directly from a corresponding Sentry project.

Generate test data

The following script generates 1GB dataset divided into 1024 folders:

python3 generate_test_data.py -d /tmp/test_data  

References:

• Seeding a million torrents - two major issues arvidn/libtorrent#63
• https://github.com/dessalines/torrenttunes-client/blob/master/src/main/java/com/torrenttunes/client/LibtorrentEngine.java
• https://stackoverflow.com/questions/57895821/how-to-seed-with-python-libtorrent-dht
• https://libtorrent.org/python_binding.html

[ichorid]

Could you please move the seeder dir into either the src dir or experiments dir?

It is better to keep the toplevel structure of the project repository clean, if possible.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information