Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FinemechanicPub committed Aug 12, 2024
1 parent dca73bb commit 8f985e6
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions infra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
- на сервере должен быть установлен `Docker` ([инструкции](https://docs.docker.com/engine/install/)).

## Копирование файлов
Скопируйте содержимое папки [infra](../infra/) на сервер. Пример использования команды `scp` для копирования файлов по протоколу `ssh` в папку пользователя `username` на сервере `example.com` (предварительно нужно перейти в корневую папку этого репозитория):
Загрузите содержимое папки [infra](../infra/) на сервер.

Это можно сделать загрузив репозиторий непосредственно на сервере.

Другим способом можно загрузить репозиторий на локальный компьютер и выполнить копирование командой `scp`:
```bash
scp -r infra [email protected]:~
scp -r infra [имя-пользователя]@[адрес-сервера]:~
```

## Замечания по архитектуре
Expand All @@ -19,12 +23,19 @@ scp -r infra [email protected]:~
## Настройка основного прокси-сервера

Конфигурационные файлы находятся в папке [proxy](./proxy/).
Если планируется использовать для приложения поддомен, отличный от "puzzle", нужно внести соответствующие изменения в строке `server_name` в файле конфигурации [puzzle.subdomain.conf](proxy/proxy-confs/puzzle.subdomain.conf). При желании, файл конфигурации также можно переименовать[^1].

Для использования прокси-сервера у вас должно быть настроено **доменное имя**.
Если планируется использовать для приложения поддомен, отличный от **puzzle**, нужно внести соответствующие изменения в строке `server_name` в файле конфигурации [puzzle.subdomain.conf](proxy/proxy-confs/puzzle.subdomain.conf). При желании, файл конфигурации также можно переименовать[^1].

[^1]: имя файла должно оканчиваться на ".subdomain.conf".

### Настройка получения SSL сертификатов
Скопируйте содержимое файла [.env.sample](proxy/.env.sample) в файл .env в той же папке. Замените значения переменных на соответствующие вашему серверу:
Перейдите в папку [proxy](./proxy/).
Скопируйте содержимое файла [.env.sample](proxy/.env.sample) в файл .env в той же папке:
```bash
cp -i .env.sample .env
```
Замените значения переменных на соответствующие вашему серверу:
- TZ - часовой пояс;
- URL - основной домен приложения;
- EXTRA_DOMAINS - дополнительные домены, например, для отладочной версии приложения;
Expand All @@ -48,7 +59,10 @@ docker logs -f swag
Конфигурационные файлы находятся в папке [puzzle](./puzzle/).

### Переменные
Скопируйте содержимое файла [.env.sample](puzzle/.env.sample) в файл .env в той же папке.
Скопируйте содержимое файла [.env.sample](puzzle/.env.sample) в файл .env в той же папке:
```bash
cp -i .env.sample .env
```

Отредактируйте значения переменных в файле .env. Обязательно нужно изменить значения следующих переменных: `POSTGRES_PASSWORD`, `CONNECTION_STRING`, `SECRET`.

Expand All @@ -71,6 +85,13 @@ docker logs -f swag
Переменные `BACKEND_IMAGE` и `BACKEND_IMAGE` по умолчанию указывают на хранилище образов этого репозитория. Измените их, если вы собрали свои образы для приложения.

### Запуск сервера приложения

Если используются образы из частного репозитория, пройдите аутентификацию с помощью команды [`docker login`](https://docs.docker.com/reference/cli/docker/login/), например:

```bash
docker login ghcr.io
```

Находясь в папке [puzzle](./puzzle/), выполните команду
```bash
docker compose up -d
Expand Down

0 comments on commit 8f985e6

Please sign in to comment.