Updated READMEs

This commit is contained in:
Roman Kelesidis 2023-06-24 11:14:49 +07:00
parent a3c5b55c62
commit 96151a5799
2 changed files with 12 additions and 12 deletions

View File

@ -1,4 +1,4 @@
# Change Log
# 📖 Change Log
## [v2.1.5-2023.06](https://github.com/torrentpier/torrentpier-lts/tree/v2.1.5-2023.06) (2023-07-04) (В разработке)
[Full Changelog](https://github.com/torrentpier/torrentpier-lts/compare/v2.1.5-2023.05...v2.1.5-2023.06)

View File

@ -12,11 +12,11 @@ TorrentPier II - движок торрент-трекера, написанны
> Список изменений: [CHANGELOG.md](CHANGELOG.md)
## Предупреждение
## 🚧️ Предупреждение
Настоятельно рекомендуется использовать движок со стандартным шаблоном, поскольку в tpl файлах тоже есть фиксы, которых может не быть в готовых шаблонах (сторонних). В любом случае вы можете интегрировать нужные исправления самостоятельно в сторонний шаблон. Для этого нужно воспользоваться историей коммитов папки [templates](https://github.com/torrentpier/torrentpier-lts/commits/main/styles/templates).
## Установка
## 💾 Установка
Для установки вам необходимо выполнить несколько простых шагов:
@ -37,7 +37,7 @@ TorrentPier II - движок торрент-трекера, написанны
+ **opensearch_desc.xml** (меняем описание и адрес на свои)
+ **opensearch_desc_bt.xml** (меняем описание и адрес на свои)
## Права доступа на папки и файлы
## 🔑 Права доступа на папки и файлы
Исходя из настроек вашего сервера, устанавливаем рекомендуемые права доступа (chmod) на указанные папки **777**, а на файлы внутри этих папок (кроме файлов **.htaccess** и **.keep**) **666**:
- data/avatars
@ -50,41 +50,41 @@ TorrentPier II - движок торрент-трекера, написанны
- internal_data/sitemap
- internal_data/triggers
## Необходимая версия php
## ⚓️ Необходимая версия php
Минимально поддерживаемой версией в настоящий момент является 5.3. Существует поддержка вплоть до версии 5.6.
## Необходимые настройки php
## ⚓️ Необходимые настройки php
mbstring.internal_encoding = UTF-8
magic_quotes_gpc = Off
Внести данные настройки необходимо в файл **php.ini**. Их вам может установить ваш хостер по запросу, если у вас возникают какие-либо проблемы с их самостоятельной установкой. Впрочем, эти настройки могут быть установлены на сервере по-умолчанию, поэтому их внесение требуется исключительно по необходимости.
## Необходимые модули php
## ⚓️ Необходимые модули php
php5-tidy
Начиная с версии 2.0.9 (ревизия 592 в старой нумерации) данный модуль не является обязательным, но его установка крайне рекомендуется для повышения качества обработки html-кода тем и сообщений пользователей.
## Рекомендуемый способ запуска cron.php
## ⚓️ Рекомендуемый способ запуска cron.php
Для значительного ускорения работы трекера может потребоваться отвязка встроенного форумного крона. С более подробной информацией об отвязке крона, вы можете ознакомиться в данной теме https://torrentpier.com/threads/52/ на нашем форуме поддержки.
## Локальный файл конфигурации
## ⚓️ Локальный файл конфигурации
Начиная с ревизии 599 была добавлена поддерка автоматического подключения файла config.local.php, при создании его вами. В данном файле вы можете переопределять настройки файла config.php для конкретного сервера, на котором запущен трекер или в целом менять стандартные значения файла config.php, для более простого обновления файлов движка в дальнейшем.
## Установка Ocelot
## ⚓️ Установка Ocelot
В движок встроена по-умолчанию поддержка альтернативного компилируемого анонсера - Ocelot. Настройка производится в файле **library/config.php**, сам анонсер находится в репозитории https://github.com/torrentpier/ocelot
Инструкция по сборке приведена на нашем форуме: https://torrentpier.com/threads/sborka-ocelot-pod-debian-7-1.26078/
Для работы анонсера требуется замена двух таблиц в базе данных - дамп в файле: **install/sql/ocelot.sql**
## Папка install
## ⚓️ Папка install
В корне движка присутствует папка **install**, в которой находятся служебные файлы, необходимые для его установки (дамп базы, примеры конфигов) и обновления (дамперы, скрипты конвертации). Доступ к данной папке по-умолчанию закрыт, но если ее присутствие вам мешает - вы можете ее удалить. На файлы **README.md** и **CONTRIBUTORS.md** это также распространяется.
## Полезные ссылки
## 📌 Полезные ссылки
+ Наш форум https://torrentpier.com/
+ Центр загрузки https://get.torrentpier.com/