From 253e4def43cfa56b5193402cbdfe3060d118bec9 Mon Sep 17 00:00:00 2001 From: Masahiko AMANO Date: Tue, 7 Jan 2025 21:59:38 +0300 Subject: [PATCH] docs: add installation guide --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index caff51b..3053850 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,21 @@ ## Как установить -*Скоро здесь будет гайд!* +Процесс установки несложен, однако требует следования чётким инструкциям, которые приведены ниже. Если что-то пошло не так по причине самовольности юзверя, разработчик не виноват! + +И да, процесс установки описан для линукс энджойеров. Разработчик не гарантирует корректную работу прилажки на ОСях других семейств. Впрочем, никто вам не запрещает пробовать и экспериментировать... Короче, я вас предупредил. + +Перед началом надо скачать данный репозиторий и распаковать. Распаковывать можно куда угодно, но не меняйте структуру без чёткого понимания, что вы и зачем делаете. Я вас снова предупредил. + +Итак, первым делом надо подготовить базу данных, в которой СказаНулл будет хранить цитаты и прочие данные. Вам понадобится PostgreSQL. Установите (если не установлен) и запустите сервер СУБД. Создайте отдельную пустую базу данных, затем подгрузите и выполните скрипт [`database/db-create.sql`](database/db-create.sql). Поздравляю, база данных готова. + +Далее необходимо создать файл конфига. Специально для вас я сделал, так сказать, рыбу данного файла — она находится в файле [`web/web.conf.yml.example`](web/web.conf.yml.example). Но не спешите его менять: лучше его продублировать в `web/web.conf.yml`, и вот уже его можно и нужно изменить в соответствии с вашим сетапом. Параметров там немного, не заблудитесь, да и объяснение к каждому из них приведено. На аглицком. + +Затем убедитесь, что у вас установлен `go` — он необходим для сборки исполняемого бинаря. Если не установлен — установите. + +И наконец, запустите скрипт [`install-web.sh`](install-web.sh). Обязательно под рутом, иначе он (скрипт) вас отругает. Зато если сделаете как сказано, то он вам и конфиг в нужную папку положит, и бинарник соберёт, и даже сервис в systemctl добавит. Красота! + +На этом всё. Теперь на вашей шайтан-машине работает веб-сервис пацанского цитатника СказаНулл. ---