YGGverse/YGGtracker
1
0
Fork 0
mirror of https://github.com/YGGverse/YGGtracker.git synced 2025-01-22 12:44:25 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ghost 2023-10-14 04:59:30 +03:00
parent 91c9415976
commit 94a86e5acc
1 changed files with 50 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,26 +1,65 @@
# YGGtracker # YGGtracker
Distributed BitTorrent Registry for Yggdrasil BitTorrent Registry for Yggdrasil
YGGtracker uses [Yggdrasil](https://github.com/yggdrasil-network/yggdrasil-go) IPv6 addresses to identify users without registration. YGGtracker uses [Yggdrasil](https://github.com/yggdrasil-network/yggdrasil-go) IPv6 addresses to identify users without registration.
#### Installation #### Installation
##### Production (v.1) ```
symfony check:requirements
```
* `composer create-project yggverse/yggtracker` ##### Production
##### Development (v.2) Install stable release
* `git clone https://github.com/YGGverse/YGGtracker.git` ```
* `cd YGGtracker` composer create-project yggverse/yggtracker
* `composer update` ```
* `php bin/console doctrine:schema:update --force`
* `symfony server:start` ##### Development
Latest codebase available in repository
```
git clone https://github.com/YGGverse/YGGtracker.git
cd YGGtracker
composer update
symfony server:start
```
##### Database
New installation
```
php bin/console doctrine:schema:update --force
```
Existing DB upgrade
```
php bin/console doctrine:migrations:migrate
```
##### Crontab
* `* * * * * /crontab/torrent/scrape` - update seeding stats
##### Routing
YGGtracker uses sub-directory prefix by default,
if your instance running in the document root, please change `prefix` value to `/` in file
`/config/routes.yaml`
##### App settings
Custom settings could be provided in the `/.env.local` file by overwriting default `/.env` values
#### Localization #### Localization
* Community translations by [Crowdin](https://crowdin.com/project/yggtracker) * Join community translations by [Crowdin](https://crowdin.com/project/yggtracker)
#### Contribution #### Contribution
@ -46,6 +85,7 @@ git checkout -b my-pr-branch-name
#### Components #### Components
* [Symfony Framework](https://symfony.com)
* [SVG icons](https://icons.getbootstrap.com) * [SVG icons](https://icons.getbootstrap.com)
* [Scrapper](https://github.com/medariox/scrapeer) / [Composer Edition](https://github.com/YGGverse/scrapeer) * [Scrapper](https://github.com/medariox/scrapeer) / [Composer Edition](https://github.com/YGGverse/scrapeer)
* [Bencode Library](https://github.com/Rhilip/Bencode) * [Bencode Library](https://github.com/Rhilip/Bencode)