From e931f484641c097357ab73b2e8dca33d86889a6e Mon Sep 17 00:00:00 2001 From: VladislavOstapov Date: Tue, 12 Mar 2024 09:47:08 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D0=BB=20?= =?UTF-8?q?=D1=81=D0=BE=D0=B4=D0=B5=D1=80=D0=B6=D0=B8=D0=BC=D0=BE=D0=B5=20?= =?UTF-8?q?README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e324165..ef9958a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # ospaz-site +## Необходимое ПО + +Для запуска данного сайта требуется следующее ПО: +* база данных _PostgreSQL_ +* реверс-прокси сервер _nginx_ +* интерпретатор _Python_ с версией не ниже 3.11 + ## Первый запуск ### Подготовка python-venv @@ -17,8 +24,24 @@ https://docs.python.org/3/library/venv.html#how-venvs-work После успешной установки зависимостей виртуальное окружение готово к работе. При запуске проекта в следующий раз виртуальное окружение нужно будет только активировать. +Далее для всех команд считается, что виртуальное окружение активировано. + ### Подготовка переменных окружения +Пароли, ключи и прочие настройки сайта задаются через переменные окружения. +Для корректной работы сайта нужно скопировать файл [.env-template](.env-template) с новым именем _.env_. + +После копирования необходимо отредактировать файл _.env_, вставив корректные значения следующих переменных: +* DB_NAME="db_name" - Название базы данных +* DB_USERNAME="db_user" - Имя пользователя базы данных +* DB_PASSWORD="db_pass" - Пароль пользователя базы данных +* DB_HOST="example.com" - Имя хоста базы данных, доменное имя или IP-адрес +* DB_PORT=5432 - Порт базы данных, изменять по умолчанию не требуется +* DJANGO_SECRET="django-secure-******" - Секретный ключ django для подписи сессий. Вместо звездочек нужно вставить + длинную строку (>40) рандомных символов. Этот ключ не нужно запоминать или где-то хранить. + +Остальные переменные окружения не следует изменять, если в этом нет необходимости. + ### Применение миграций После клонирования репозитория и настройки venv нужно выполнить следующие команды: @@ -36,4 +59,30 @@ https://docs.python.org/3/library/venv.html#how-venvs-work ### Запуск сервера -Для запуска сервера в тестовом режиме нужно +Для запуска сервера нужно ввести команду + + python manage.py runserver localhost:39080 --noreload + +В данном случае сервер будет прослушивать адрес localhost и порт HTTP 39080. +Порт и прослушиваемый адрес можно изменять. + +### Конфигурация nginx + +Для корректной работы сайта нужно вставить следующую конфигурацию в _nginx.conf_ в секцию виртуального хоста: + + location /static { + alias "/static"; + } + + location /favicon.ico { + add_header Content-type "image/svg+xml"; + alias "/static/favicon.svg"; + } + + location / { + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_pass http://localhost:39080; // адрес и порт, указанные при запуске сервера + } + +При этом нужно заменить __ на путь к папке, в которой расположен сайт.