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, Twig and JavaScript. It traditionally uses Mysql and Sphinx, but work is under way to replace those with Postgresql.
- PHP 8.2.13+ (required)
- nginx (required)
- nodeJS 20+ (required)
- memcached (required)
- sphinx 2.1.1 or newer (required)
- ocelot (optional)
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 obtain 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.
By default, Windows Subsystem for Linux (WSL) does not support the use of
docker compose. As root, you should to run the following command
apt-get install ca-certificates curl \
&& install -m 0755 -d /etc/apt/keyrings \
&& curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
&& chmod a+r /etc/apt/keyrings/docker.asc \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "$VERSION_CODENAME") stable" \
> /etc/apt/sources.list.d/docker.list \
&& apt-get update \
&& apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
In the root folder of the Gazelle repository, run the following command:
docker compose up -d
This will pull and build the needed images to run Gazelle on Debian.
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.
If you receive the error "http: invalid Host header", run the following
DOCKER_BUILDKIT=0 docker compose up -d
You can access the site by viewing http://localhost:7001/
Follow the "Register" link on the homepage to create the first account. The first account created is assigned the highest operational role (Sysop) automatically.
The Sysop account might not have all the permissions that have been added recently. Navigate to the /tools.php?action=userclass page and tick everything for the Sysop class.
Once the Gazelle container has been built successfully, it may be stopped and subsequently restarted without requiring connectivity with the outside world. This also means that composer and npm are not automatically updated during a container restart and is a manual chore to perform periodically.
The ocelot repository is used to build the Ocelot image. To keep things simple, check out the source in a sibling directory to Gazelle.
$ git clone https://github.com/OPSnet/ocelot
$ cd ocelot
$ docker build . -t ocelotOcelot can be launched by specifying an additional configuration file:
docker compose -f docker-compose.yml -f misc/docker-compose.ocelot.yml up -d
The following ports are forwarded:
- 80 -> 7001 (web)
- 3306 -> 36000 (mysql)
- 5432 -> 54321 (postgresql)
- 34000 -> 34000 (ocelot if present)
If you want to poke around inside the web container, open a shell:
docker compose exec web 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 compose exec -T web vendor/bin/phinx create MyNewMigration
Edit the resulting file and then apply it:
docker compose exec -T web vendor/bin/phinx migrate
For PostgreSQL tables, append -c ./misc/phinx-pg.php to the phinx
commands. The following bash function makes it much easier to work with
phinx:
function pg-phinx { docker compose exec web vendor/bin/phinx $@ -c misc/phinx-pg.php; }
pg-phinx status
pg-phinx create MyNewMigration
pg-phinx migrate
pg-phinx rollback
To access the database, look at misc/docker/mysql-home/.my.cnf
The credentials should match those used in the docker-compose.yml file.
And then:
docker compose exec mysql mysql
In the same vein, you can use mysqldump to perform a backup.
To view the sphinx tables:
docker compose exec sphinxsearch mysql -h 127.0.0.1 -P 9306
You can run Boris directly:
docker compose exec web bin/boris
misc/gitlab.Dockerfile can be used to create a Docker container suitable for
running the test suite in a Gitlab CI runner. The included .gitlab-ci.yml
config runs unit tests with phpunit and afterwards end-to-end tests with
cypress.
To build the container, get the sql files from the OPSnet/gazelle-e2e-testing-docker
repo and place them alongside the gitlab.Dockerfile. Then run
docker build -f misc/gitlab.Dockerfile -t gazelle-e2e-testing:latest --compress .
in the gazelle repo's root directory (this one).
Similarly, the phpstan container can be built with
docker build -t gazelle-phpstan:latest -f misc/phpstan.Dockerfile --compress misc/docker
Major Pg versions require a dump and restore. In the docker environment this means doing the following;
- run 'make pgdump' to dump the current contents
- stop the current postgresql container
- mv misc/docker/data/pg misc/docker/data/pg.old
- mkdir ./docker/data/pg
- docker compose stop && docker compose up -d
- import the dump to the docker pg container
Feel free to join #develop on irc.orpheus.network to discuss any questions concerning Gazelle (or any of the repos published by Orpheus).
Run bin/setup-git-hooks once, to install a git precommit hook that will run linting
checks on PHP, JS, Twig and CSS files at each commit.
Create issues at https://github.com/OPSnet Patches welcome!