diff --git a/README.md b/README.md new file mode 100644 index 0000000..358816f --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Работа с репозиторием sb + +Данный репозиторий содержит инструменты для автоматизированной настройки конфигураций. Ниже приведена инструкция по развертыванию и использованию. + +## 1. Клонирование репозитория + +Для начала работы склонируйте проект на локальный компьютер: + +```bash +git clone [http://gitea.vector.ru/Shulga_ND/sb](http://gitea.vector.ru/Shulga_ND/sb) +``` + +## 2. Настройка конфигурации + +Перед запуском необходимо создать файл с вашими персональными данными: + +1. В корне проекта создайте текстовый файл с названием `params.txt`. +2. Скопируйте и вставьте в него следующие строки: + + ```text + LOCAL_ADDR=YOUR_ADDR + PRIV_KEY=YOUR_KEY + ``` + +3. Отредактируйте файл, заменив значения на актуальные: + * Вместо `YOUR_ADDR` — укажите ваш **IP-адрес Wireguard**. + * Вместо `YOUR_KEY` — укажите ваш **приватный ключ Wireguard**. +4. Сохраните изменения в файле. + +## 3. Применение изменений + +После настройки параметров выполните следующие действия: + +1. Запустите файл `change.bat` (двойным кликом или через консоль). +2. Дождитесь завершения процесса. Если изменения прошли успешно, нажмите любую клавишу для выхода. +3. После этого вы можете приступать к работе с конфигурациями в соответствующих папках. + +## Важное примечание + +Скрипт `change.bat` необходимо запускать **каждый раз после выполнения команды `git pull`**, чтобы актуализировать настройки под новые изменения в репозитории. \ No newline at end of file