Skip to main content

Installation

This guide will help you install TorrentPier on your server.

Requirements​

  • PHP 8.4 or higher
  • MySQL 8.0+ / MariaDB 10.5+ / Percona Server
  • Composer 2.0 or higher
  • Web server: Apache or Nginx

PHP extensions​

Ensure these PHP extensions are installed:

  • BCMath
  • Ctype
  • cURL
  • DOM
  • Fileinfo
  • JSON
  • Mbstring
  • OpenSSL
  • PDO + pdo_mysql
  • Tokenizer
  • XML
  • Zlib

Installation methods​

git clone https://github.com/torrentpier/torrentpier.git
cd torrentpier
composer install
php bull app:install

The installation wizard will guide you through:

  • System requirements check
  • Database configuration
  • Environment setup
  • Running migrations
  • Web server hints

Method 2: Composer create-project​

composer create-project torrentpier/torrentpier
cd torrentpier
php bull app:install

Method 3: Manual installation​

  1. Clone or download the repository
  2. Run composer install
  3. Copy .env.example to .env
  4. Configure database settings in .env
  5. Run migrations: php bull migrate
  6. Configure your web server

Method 4: Docker​

  1. Ensure Docker and Docker Compose are installed on your system
  2. Verify that ports 80 (HTTP) and 443 (HTTPS) are free or adjust them in docker-compose.yml
  3. Clone the repository: 
    git clone https://github.com/torrentpier/torrentpier.git
    cd torrentpier
  4. Create environment file: 
    cp .env.example .env
  5. Configure .env for Docker — update these values: 
    DB_HOST=database           # Docker service name, not localhost
    APP_CRON_ENABLED=false     # Docker image has its own cron
  6. Start the application: 
    docker compose up -d
Permissions

We recommend chmod 0755 for folders and chmod 0644 for files.

Bull CLI​

TorrentPier includes a powerful CLI tool for management:

# List all available commands
php bull list

# Run installation wizard
php bull app:install

# Check migration status
php bull migrate:status

# Run pending migrations
php bull migrate

# Clear cache
php bull cache:clear

# View system info
php bull about

Environment configuration​

Edit .env file with your settings:

# Application
APP_ENV=production

# Database
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=torrentpier
DB_USERNAME=your_username
DB_PASSWORD=your_password

# Site
TP_HOST=your-domain.com

Web server configuration​

Nginx​

Use the provided configuration template:

cp install/nginx.conf /etc/nginx/sites-available/torrentpier

Or use this basic configuration:

server {
    listen 80;
    server_name your-domain.com;
    root /path/to/torrentpier;
    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.4-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~ /\.(ht|git|env) {
        deny all;
    }
}

Apache​

Ensure mod_rewrite is enabled. The .htaccess file is included in the repository.

Caddy​

Use the provided Caddyfile:

cp install/Caddyfile /etc/caddy/Caddyfile

Post-installation​

Set up cron jobs​

Add to your crontab:

# Run maintenance tasks every minute
* * * * * php /path/to/torrentpier/bull cron:run >> /dev/null 2>&1

Directory permissions​

The installer sets permissions automatically, but if needed:

chmod -R 755 storage
chown -R www-data:www-data storage

Troubleshooting​

Permission issues​

chmod -R 755 storage
chmod 644 .env

Database connection errors​

  • Verify credentials in .env
  • Check MySQL is running
  • Ensure database exists

Blank page / 500 error​

  • Check PHP error log
  • Verify all PHP extensions are installed
  • Run composer install again

Migration issues​

# Check migration status
php bull migrate:status

# Run migrations with verbose output
php bull migrate -v