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 or newer (required)
- Memcached (required)
- Sphinx 2.0.6 or newer (required)
- procps-ng (recommended)
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
Gazelle can be run through Docker (container) or Vagrant (Virtual Machine). Historically, Vagrant was used, but recently Docker support was added and is the preferred method of development.
Install Docker for your preferred system and run the following command:
docker-compose up
This 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.
You may want to install additional packages:
apt update
apt 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
This repository comes pre-setup to be run through
Vagrant for ease of development and
without having to modify your local machine. You can look through
the docs for how it works, but to start, you just need to download
Vagrant and VirtualBox (and it's recommended to get the
vagrant-vbguest
plugin) and then simply run: vagrant up
This will build a Debian Jessie on a Virtual Machine and serve this
repository through /var/www
on the machine.
Both Docker and Vagrant will forward the following ports:
- 80 -> 8080 (web)
- 3306 -> 36000 (mysql)
- 34000 -> 34000 (ocelot)
You can access the site by going to http://localhost:8080
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!