LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

add guide for setting up a BT tracker #379

Closed
shyba wants to merge 2 commits from trackers into master
pull from: trackers
merge into: LBRYCommunity:master
Conversation 1 Commits 2 Files changed 1 +14 -14
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 125c4edb49 - Show all commits

28
documents/resources/bt-tracker.md
View file

@ -6,7 +6,7 @@ description: Setting up a tracker for use with LBRY P2P.
*Warning: Unfortunately, some hosting providers explicitly forbids running a tracker in the ToS. Check with your ISP or VPS before running one yourself.* *Warning: Unfortunately, some hosting providers explicitly forbids running a tracker in the ToS. Check with your ISP or VPS before running one yourself.*
The main difference from this guide to any other BitTorrent tracker guide is that it contains optional instructions for configuring a default peer IP fallback from a reflector node in the LBRY network. The main difference from this guide to any other BitTorrent tracker guide is that it contains optional instructions for configuring a default peer IP fallback from a reflector node in the LBRY network.
The software we are going to use is a [fork of chihaya](https://github.com/shyba/chihaya) with support for this optional feature of using default peer IPs. The software we are going to use is a [fork of chihaya](https://github.com/lbryio/tracker) with support for this optional feature of using default peer IPs.
# Configuration # Configuration
A default configuration can be found at `dist/example_config.yaml`. A default configuration can be found at `dist/example_config.yaml`.
@ -15,7 +15,7 @@ This is an example for an UDP server running on 6969 with metrics enabled. Remem
Also, "fixed peers" prehook is enabled with default IPs. This will include reflector on responses. Discard the section to disable it or ask around on Discord for different servers. Enabling it helps as a fallback for content with no seeds. Also, "fixed peers" prehook is enabled with default IPs. This will include reflector on responses. Discard the section to disable it or ask around on Discord for different servers. Enabling it helps as a fallback for content with no seeds.
``` ```
--- ---
chihaya: tracker:
announce_interval: "30m" announce_interval: "30m"
min_announce_interval: "15m" min_announce_interval: "15m"
metrics_addr: "0.0.0.0:6880" metrics_addr: "0.0.0.0:6880"
@ -53,7 +53,7 @@ In order to define a tracker service and let Docker Compose manage it, create a
version: "3" version: "3"
services: services:
tracker: tracker:
image: vshyba/chihaya image: lbry/tracker
command: --config /config/conf.yml command: --config /config/conf.yml
volumes: volumes:
- .:/config - .:/config
@ -73,8 +73,8 @@ To stop:
## Building the containter (optional) ## Building the containter (optional)
A Dockerfile is provided within the repo. To build the container locally, run this command on the same directory the repo was cloned: A Dockerfile is provided within the repo. To build the container locally, run this command on the same directory the repo was cloned:
`sudo docker build -f Dockerfile . -t some_name/chihaya:latest` `sudo docker build -f Dockerfile . -t some_name/tracker:latest`
It will produce an image called `some_name/chihaya`, which can be used in the Docker Compose section. It will produce an image called `some_name/tracker`, which can be used in the Docker Compose section.
# Running from source as a service # Running from source as a service
@ -84,8 +84,8 @@ This section assumes Go language compiler to be installed. If that is not the ca
## Cloning and compiling ## Cloning and compiling
```bash ```bash
git clone https://github.com/shyba/chihaya.git git clone https://github.com/lbryio/tracker.git
cd chihaya cd tracker
go build ./cmd/chihaya go build ./cmd/chihaya
./chihaya --help ./chihaya --help
``` ```
@ -108,18 +108,18 @@ After=network.target
Type=simple Type=simple
#User=chihaya #User=chihaya
#Group=chihaya #Group=chihaya
WorkingDirectory=/home/user/github/chihaya WorkingDirectory=/home/user/github/tracker
ExecStart=/home/user/github/chihaya/chihaya --config dist/example_config.yaml ExecStart=/home/user/github/tracker/chihaya --config dist/example_config.yaml
Restart=on-failure Restart=on-failure
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
To try it, change `/home/user/github/chihaya` to where the code was cloned and run: To try it, change `/home/user/github/tracker` to where the code was cloned and run:
```bash= ```bash=
mkdir -p ~/.config/systemd/user mkdir -p ~/.config/systemd/user
# PASTE FILE IN ~/.config/systemd/user/chihaya.service # PASTE FILE IN ~/.config/systemd/user/tracker.service
systemctl --user enable chihaya systemctl --user enable tracker
systemctl --user start chihaya systemctl --user start tracker
systemctl --user status chihaya systemctl --user status tracker
``` ```