====== YGGbro - пресеты прокси для Yggdrasil ======

Для создания прокси с нуля, необходимо настроить сервер с учетом специфики клиентской части отдельно взятого ресурса. 

Зачастую, это делается силами одного администратора и внесение каких либо доработок сообществом не предусматривается;\\
с другой стороны - ресурс может быть хорошо настроен, но в виду закрытых настроек, поднять еще одну инстанцию можно только создав конфигурацию с нуля или используя устаревшие инструкции в интернете, затратив время на тестирование и доработки.

Проект создан с целью открытого сопровождения таких настроек сообществом, а также легкой установки и обновлений.

===== Nginx =====

==== Установка ====

Установка предусматривает копирование репозитория в директорию /etc/yggbro:

<code>
git clone https://github.com/YGGverse/YGGbro.git /etc/yggbro
</code>

По-умолчанию, реестр /etc/yggbro никак не взаимодействует с веб сервером и являет собой локальную копию репозитория.

Затем производится активация нужного прокси из набора методами nginx, описанными для каждого из провайдеров, например [[ https://github.com/YGGverse/YGGbro/tree/main/nginx/opennet.ru/yggbro/opennet.ru | opennet.ru ]]
(для виртуальных хостов - это просто создание ярлыка в директории /etc/nginx/sites-enabled из реестра) 

<code>
nginx -t
service nginx reload
</code>


==== Обновление ====

<code>
cd /etc/yggbro
git pull
nginx -t
service nginx reload
</code>

==== Удаление ====

Для каждого провайдера указан собственный файл README.md в котором описаны инструкции по установке и удалению настроек.

Чтобы полностью удалить реестр YGGbo, отключаем активных провайдеров, затем удаляем проект и обновляем конфигурацию nginx:

<code>
rm -R /etc/yggbro
nginx -t
service nginx reload
</code>
===== Контрибуция =====

Модель пресетов предусматривает унифицированную структуру и пространства имен для предотвращения конфликтов с имеющимися настройками.

Чтобы добавить новые настройки в реестр, нужно выполнить несколько простых правил:

  * название директории прокси должно соответствовать проксируемому домену (proxy_pass в nginx)
  * поддиректория настроек провайдера должна быть названа доменным именем провайдера если используется директория - указывается название без точек.
  * настройки провайдера требуют наличия следующих файлов:
    * server.conf - пример настройки виртуального хоста
    * location.conf - набор правил location для включения в существующие блоки server
    * README.md - описание установки и удаления 

====== Ссылки ======

Репозиторий проекта: https://github.com/YGGverse/YGGbro\\
Список доступных прокси: https://github.com/YGGverse/YGGbro#registry