Gazelle is a web framework geared towards private BitTorrent trackers. Although naturally focusing on music, it can be modified for most needs. Gazelle is written in PHP, JavaScript, and MySQL.
- Nginx (recommended)
- PHP 7.2+ (required)
- NodeJS 12+ (required)
- Memcached (required)
- Sphinx 2.0.6 or newer (required)
- procps-ng (recommended)
- ocelot
Note: This list may not be exhaustive.
To fully utilize the Logchecker, you must install the following
depedencies through pip:
- chardet
- eac-logchecker
- xld-logchecker
We provide installation notes here. These notes are provided as a best effort, and are not guaranteed to be fully up-to-date or accurate.
Due to the nature of torrenting, we HIGHLY recommend not trying to run this in production if you are not prepared or knowledgeable in setting up servers, proxies, and tuning TCP configs to get proper performance and privacy.
Docker is used to develop Gazelle. See https://docs.docker.com/engine/install/ for more information on getting Docker set up locally.
Setup the ocelot container image, by doing the following:
git clone https://github.com/OPSnet/ocelot
docker build . -t ocelotWithin the gazelle folder, run the following command:
docker-compose upThis will build and pull the needed images to run Gazelle on Debian
Buster. A volume is mounted from the base of the git repository at
/var/www in the container. Changes to the source code are
immediately served without rebuilding or restarting.
The following ports are forwarded:
- 80 -> 8080 (web)
- 3306 -> 36000 (mysql)
- 34000 -> 34000 (ocelot)
You can access the site by going to http://localhost:8080
You may want to install additional packages:
apt updateapt install less procps vim
If you want to poke around inside the web container, open a shell:
export WEBCONT=$(docker ps|awk '$2 ~ /web$/ {print $1}')
docker exec -it $WEBCONT bash
To keep an eye on PHP errors during development:
docker exec -it $WEBCONT tail -n 20 -f /var/log/nginx/error.log
To create a Phinx migration:
docker exec -it $WEBCONT vendor/bin/phinx create MyNewMigration
Edit the resulting file and then apply it:
docker exec -it $WEBCONT vendor/bin/phinx migrate
To access the database, save the following in ~root/.my.cnf of
the database container:
[mysql]
user = root
password = <sekret>
database = gazelle
And then:
docker exec -it $(docker ps|awk '$2 ~ /^mariadb/ {print $1}') mysql
In the same vein, you can use mysqldump to perform a backup.
You can run Boris directly:
docker exec -it $WEBCONT /var/www/boris
In order to have Docker run the container using the production mode commands for both Composer and NPM, run this when powering it up:
ENV=prod docker-compose up
Feel free to join #develop on irc.orpheus.network to discuss any questions concerning Gazelle (or any of the repos published by Orpheus).
Open issues at https://github.com/OPSnet. Patches welcome!