github/torrentpier
1
0
Fork 0
mirror of https://github.com/torrentpier/torrentpier synced 2025-08-21 13:54:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update README.md

Browse source
This commit is contained in:
Roman Kelesidis 2023-01-23 19:11:30 +07:00
commit 33b78f8b99
1 changed files with 28 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,20 +1,24 @@
<p align="center"><a href="https://torrentpier.com/"><img src="https://torrentpier.com/forum/styles/default/xenforo/bull-logo.svg" width="400px" /></a></p> <p align="center"><a href="https://torrentpier.com/"><img src="https://torrentpier.com/forum/styles/default/xenforo/bull-logo.svg" width="400px" /></a></p>
<h3 align="center">TorrentPier</h3>
<p align="center"> <p align="center">
<a href="http://torrentpier.herokuapp.com/"><img src="http://torrentpier.herokuapp.com/badge.svg" alt="Slack"></a> Bull-powered BitTorrent tracker engine.
<a href="https://crowdin.com/project/torrentpier"><img src="https://d322cqt584bo4o.cloudfront.net/torrentpier/localized.svg" alt="Crowdin"></a> <br>
<a href="https://scrutinizer-ci.com/g/torrentpier/torrentpier/"><img src="https://img.shields.io/scrutinizer/g/torrentpier/torrentpier.svg" alt="Scrutinizer"></a> </p>
<a href="https://www.codacy.com/app/Exile37/torrentpier"><img src="https://img.shields.io/codacy/grade/8b79a63a6d464b81bf0a39923f42bdf5/master.svg" alt="Codacy"></a>
<br /> <p align="center">
<a href="https://insight.sensiolabs.com/projects/1a5d5098-e0b0-45c2-816a-020dfd50acaf"><img src="https://img.shields.io/sensiolabs/i/1a5d5098-e0b0-45c2-816a-020dfd50acaf.svg" alt="SensioLabs Insight"></a> <a href="https://github.com/torrentpier/torrentpier/blob/master/LICENSE"><img src="https://img.shields.io/github/license/torrentpier/torrentpier" alt="License"></a>
<a href="https://travis-ci.org/torrentpier/torrentpier"><img src="https://img.shields.io/travis/torrentpier/torrentpier/master.svg" alt="Travis"></a> <a href="https://packagist.org/packages/torrentpier/torrentpier"><img src="https://img.shields.io/packagist/stars/torrentpier/torrentpier" alt="Stars Packagist"></a>
<a href="https://circleci.com/gh/torrentpier/torrentpier"><img src="https://img.shields.io/circleci/project/github/torrentpier/torrentpier/master.svg" alt="CircleCI"></a> <a href="https://packagist.org/packages/torrentpier/torrentpier"><img src="https://img.shields.io/packagist/dt/torrentpier/torrentpier" alt="Downloads"></a>
<a href="https://codecov.io/gh/torrentpier/torrentpier"><img src="https://img.shields.io/codecov/c/github/torrentpier/torrentpier/master.svg" alt="Codecov"></a> <a href="https://packagist.org/packages/torrentpier/torrentpier"><img src="https://img.shields.io/packagist/v/torrentpier/torrentpier" alt="Version"></a>
<a href="https://github.com/torrentpier/torrentpier/releases"><img src="https://img.shields.io/github/release-date/torrentpier/torrentpier" alt="Last release"></a>
<img src="https://img.shields.io/github/repo-size/torrentpier/torrentpier" alt="Size">
</p> </p>
## About TorrentPier ## About TorrentPier
TorrentPier — bull-powered BitTorrent tracker engine, written in php. High speed, simple modification, high load TorrentPier — bull-powered BitTorrent tracker engine, written in php. High speed, simple modification, high load
architecture, built-in support for alternative compiled announcers (Ocelot, XBT). In addition we have very helpful architecture, built-in support for alternative compiled announcers (Ocelot, XBT). In addition, we have very helpful
[official support forum](https://torrentpier.com/forum), where among other things it is possible to test the live [official support forum](https://torrentpier.com/forum), where among other things it is possible to test the live
demo, get any support and download modifications for engine. demo, get any support and download modifications for engine.
@ -33,20 +37,21 @@ and go from there. The documentation will be translated into english in the near
## Installation ## Installation
For installation you need to follow a few simple steps: For installation, you need to follow a few simple steps:
1. Unpack to the server the contents of the downloaded folder 1. Install [Composer](https://getcomposer.org/)
1. Install [Composer](https://getcomposer.org/) and run `composer install` on the downloaded directory 2. Run `composer create-project torrentpier/torrentpier`
1. Create database and import dump located at **install/sql/mysql.sql** 3. After run `composer install` on the project directory
1. Edit database configuration settings in the configuration file or a local copy (see below) 4. Create database and import dump located at **install/sql/mysql.sql**
1. Edit domain name in the configuration file or a local copy (see below) 5. Edit database configuration settings in the configuration file or a local copy (see below)
1. Edit domain ssl setting in the configuration file or a local copy (see below) 6. Edit domain name in the configuration file or a local copy (see below)
1. Edit this files: 7. Edit domain ssl setting in the configuration file or a local copy (see below)
8. Edit this files:
1. **favicon.png** (change on your own) 1. **favicon.png** (change on your own)
1. **robots.txt** (change the addresses in lines **Host** and **Sitemap** on your own) 2. **robots.txt** (change the addresses in lines **Host** and **Sitemap** on your own)
1. **opensearch_desc.xml** (change the description and address on your own) 3. **opensearch_desc.xml** (change the description and address on your own)
1. **opensearch_desc_bt.xml** (change the description and address on your own) 4. **opensearch_desc_bt.xml** (change the description and address on your own)
1. Log in to the forum with admin/admin login/password and finish setting up via admin panel 9. Log in to the forum with admin/admin login/password and finish setting up via admin panel
## Access rights on folders and files ## Access rights on folders and files
@ -96,4 +101,4 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
## License ## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details This project is licensed under the MIT License - see the [LICENSE](https://github.com/torrentpier/torrentpier/blob/master/LICENSE) file for details