aboutsummaryrefslogtreecommitdiff
path: root/plugin/torrent/README.md
blob: 890bb8e3b267f5dc3a0baeb26bccfb730b6df885 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# torrent

## Name

*torrent* - use BitTorrent to disseminate zone data.

## Description

The *torrent* plugin uses the BitTorrent protocol to disseminate zone data. Multiple peers can
connect and down- and upload the data. A couple of nodes can be `seed` only meaning they will update
the torrent when their zone data changes. Non-`seed` peers will write received data back into the
zonefile - once the torrent is fully downloaded.

## Syntax

The simplest syntax is for a peer wanting to receive the zone data:

~~~ txt
torrent DBFILE
~~~

*  **DBFILE** the zone database file to torrent. If the path is relative, the path from the
   *root* plugin will be prepended to it.

For peers seeding the torrent use this, slightly expanded, syntax

~~~ txt
torrent DBFILE {
    seed
}
~~~

* `seed` tells *torrent* to seed content from **DBFILE** to the peers, it will _never_ write to
  **DBFILE**. When `seed` is _not_ specified **DBFILE** will be written to once the entire torrent
  is downloaded.

## Examples

~~~ txt
example.org {
    file db.example.org
    torrent db.example.org
}
~~~

## Also See

## Bugs