torrentpier/README.md

Bull-powered BitTorrent tracker engine

🐂 About TorrentPier

TorrentPier — bull-powered BitTorrent Public/Private tracker engine, written in php. High speed, simple modification, high load architecture. In addition, we have very helpful official support forum, where it's possible to get any support and download modifications for engine.

🌈 Current status

TorrentPier is currently in active development. The goal is to remove all legacy code and rewrite existing to modern standards. If you want to go deep on the code, check our issues and go from there. The documentation will be translated into english in the near future, currently russian is the main language of it.

✨ Features

• Rich forum browsing/moderation tools
• High-load capable, heavily configurable announcer
• Scrape support
• FreeLeech
• BitTorrent v2 support
• Event-based invite system
• Bonus points
• Polls system
• PM system
• Multilingual support
• Atom feeds
• and MUCH MORE!

🖥️ Demo

• URL: https://torrentpier.duckdns.org
• Username: admin
• Password: admin

Note

Demo is resetting every 24 hours!

🔧 Requirements

• Apache / nginx
• MySQL 5.5.3 or above / MariaDB 10.0 or above / Percona
• PHP: 8.1 / 8.2 / 8.3
• PHP Extensions: mbstring, bcmath, intl, tidy (optional), xml, xmlwriter
• Crontab (Recommended)

💾 Installation

For installation, you need to follow a few simple steps.

Quick ☕️

1. Download latest version of TorrentPier
2. Open directory with TorrentPier and run in CLI mode php install.php
3. Voila! ✨

Manual 🔩

1. Install Composer
2. Run composer create-project torrentpier/torrentpier
3. Check our system requirements
4. After run composer install on the project directory
5. Create database and import dump located at install/sql/mysql.sql
6. Edit database configuration settings in the environment (.env.example), after rename to .env
7. Provide write permissions to the specified folders:
   • data/avatars, data/uploads, data/uploads/thumbs
   • internal_data/atom, internal_data/cache, internal_data/log, internal_data/triggers
   • sitemap
8. Voila! ✨

Important

The specific settings depend on the server you are using, but in general case we recommend chmod 0755 for folders, and chmod 0644 for files in them.

Additional steps 👣

1. Edit domain name and domain port in the configuration file or a local copy ($reserved_name and $reserved_port)
2. Edit this files:
   • favicon.png (change on your own)
   • robots.txt (change the addresses in lines Host and Sitemap on your own)
   • opensearch_desc.xml (change the description and address on your own)
   • opensearch_desc_bt.xml (change the description and address on your own)
3. Log in to the forum with admin/admin login/password and finish setting up via admin panel

🔐 Security vulnerabilities

If you discover a security vulnerability within TorrentPier, please follow our security policy, so we can address it promptly.

📌 Our recommendations

• The recommended way to run cron.php. - For significant tracker speed increase may be required to replace built-in cron.php by operating system daemon.
• Local configuration copy. - You can override the settings using local configuration file library/config.local.php.

💚 Contributing / Contributors

Please read our contributing policy and code of conduct for details, and the process for submitting pull requests to us. But we are always ready to renew your pull-request for compliance with these requirements. Just send it!

Made with contrib.rocks.

💞 Sponsoring

Support this project by becoming a sponsor or a backer.

Monero

42zJE3FDvN8foP9QYgDrBjgtd7h2FipGCGmAcmG5VFQuRkJBGMbCvoLSmivepmAMEgik2E8MPWUzKaoYsGCtmhvL7ZN73jh

Bitcoin

bc1qselchy0nnh7xl99glfffedqp7p9gpvatdr9dz9

ЮMoney

4100118022415720

📦 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

📖 License

This project is licensed under the MIT License - see the LICENSE file for details.