Skip to content

Commit

Permalink
Improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SergTyapkin committed Mar 24, 2024
1 parent ac79bb6 commit 5ba3628
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,32 @@

# Веб-вервис в докере с авто-деплоем на _Nginx_ и получением сертификатов _Letsencript_

Всё делается через команды `make`
## Развертка для разработки
```SHELL
npm run dev
```
_У вас должна быть установлена `node`. [Установка Node.js](https://nodejs.org/en/download)_

# Развертка в деплой
Развертка выполняется через команды в `Makefile`

### 1. Клонируем репозиторий:
## 1. Клонируем репозиторий:
```SHELL
git clone [email protected]:SergTyapkin/vue-frontend-template.git
```

### 2. Настраиваем вообще всё.
## 2. Настраиваем вообще всё.
В самом начале нужно будет настроить `.env` файл, прописать правильный `DOMAIN_URL`
```SHELL
cd vue-frontend-template
make all
make all # not just "make"!
````

Всё. Наслаждаемся тем, что за нас всё сделали, установили докер, сайт раздаётся, сертификаты обновляются.
Теперь `Github CI` сам будет проверять, собирается ли контейнер при **Pull Request**'ах, а при **Push**'ах в ветку `master` будет автоматически выполняться `make update` на сервере и обновлять деплой!

## Полный список действий скриптов
_После выполнения не забываем прописать переменные, значения которых команда выдала в консоль, в настройки окружения репозитория на Github, как это написано в пункте 3._

### Полный список действий скриптов
1. Устанавливает `docker`, если его ещё нет
2. Добавляет текущего пользователя в группу `Docker`, чтобы запускать его без `sudo`
3. Предлагает настроить `.env` файл
Expand All @@ -28,7 +36,7 @@ make all
6. Создаёт пару SSH ключей, публичный добавляет в `~/.ssh/authorized_keys`, приватный выводит в консоль, его нужно добавить как секретную переменную среды `SSH_DEPLOY_KEY` в настройках Github.
7. Собирает приложение из последнего коммита в ветку `master`, запускает финальный docker-контейнер с ним

### 3. Установка переменных
## 3. Установка переменных
1. Заходим в `Settings` -> `Environments`, создаём новое окружение под названием `deploy` (важно).
![](/README_res/1.png)
2. Создаём внутри окружения все необходимые переменные. Их выведет `make all` после завершения выполнения, или можно прописать самому.
Expand Down

0 comments on commit 5ba3628

Please sign in to comment.