- 84.201.177.209
- http://yatube.duckdns.org/admin/
- http://yatube.duckdns.org/redoc/
- Регистрация на dockerhub
- Настроенный SSH доступ к серверу по ключу с паролем
- Регистрация на GitHub
- Выделенный сервер Linux Ubuntu 20.04 с с публичным IP адресом
Клонируйте репозиторий и настройте переменные GitHub secrets согласно Вашему окружению
- DOCKER_PASSWORD
- DOCKER_USERNAME
- SERVER_HOST #публичный адрес сервера для доступа по SSH
- SERVER_SUDO_USER
- SSH_KEY #Скопируйте приватный ключ с компьютера, имеющего доступ к боевому серверу: cat ~/.ssh/id_rsa
- SSH_PASSWORD
- TELEGRAM_TOKEN #токен чат бота который будет отправлять сообщение
- TELEGRAM_CHAT_ID #кому отправлять сообщение
- DB_ENGINE пример django.db.backends.postgresql
- DB_NAME #имя образа docker-compose с базой - db
- DB_POSTGRES_USER
- DB_POSTGRES_PASSWORD
- DB_HOST
- DB_PORT
На боевом сервере установите docker и docker-compose Остановите службу nginx Скопируйте файлы из директории infra в домашную папку пользователя docker-compose.yaml nginx - сохраняя стурктуру и название папок
при git pus запускается скрипт GitHub actions который выполняет автоматический deploy на сервер
Проект YaMDb собирает отзывы пользователей на различные художественные произведения.
Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email
и username
на эндпоинт /api/v1/auth/signup/
.
YaMDB отправляет письмо с кодом подтверждения (confirmation_code
) на адрес email
.
Пользователь отправляет POST-запрос с параметрами username
и confirmation_code
на эндпоинт /api/v1/auth/token/
, в ответе на запрос ему приходит token (JWT-токен).
При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/
и заполняет поля в своём профайле (описание полей — в документации).
- Аноним — может просматривать описания произведений, читать отзывы и комментарии.
- Аутентифицированный пользователь (
user
) — может читать всё, как и Аноним, может публиковать отзывы и ставить оценки произведениям (фильмам/книгам/песенкам), может комментировать отзывы; может редактировать и удалять свои отзывы и комментарии, редактировать свои оценки произведений. Эта роль присваивается по умолчанию каждому новому пользователю. - Модератор (
moderator
) — те же права, что и у Аутентифицированного пользователя, плюс право удалять и редактировать любые отзывы и комментарии. - Администратор (
admin
) — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям. - Суперюзер Django должен всегда обладать правами администратора, пользователя с правами
admin
. Даже если изменить пользовательскую роль суперюзера — это не лишит его прав администратора. Суперюзер — всегда администратор, но администратор — не обязательно суперюзер.
Пользователь отправляет POST-запрос с параметрами email
и username
на эндпоинт /api/v1/auth/signup/
.
Сервис YaMDB отправляет письмо с кодом подтверждения (confirmation_code
) на указанный адрес email
.
Пользователь отправляет POST-запрос с параметрами username и confirmation_code
на эндпоинт /api/v1/auth/token/
, в ответе на запрос ему приходит token (JWT-токен).
В результате пользователь получает токен и может работать с API проекта, отправляя этот токен с каждым запросом.
После регистрации и получения токена пользователь может отправить PATCH-запрос на эндпоинт /api/v1/users/me/
и заполнить поля в своём профайле (описание полей — в документации).
Пользователя может создать администратор — через админ-зону сайта или через POST-запрос на специальный эндпоинт api/v1/users/
(описание полей запроса для этого случая — в документации). В этот момент письмо с кодом подтверждения пользователю отправлять не нужно.
После этого пользователь должен самостоятельно отправить свой email
и username на эндпоинт /api/v1/auth/signup/
, в ответ ему должно прийти письмо с кодом подтверждения.
Далее пользователь отправляет POST-запрос с параметрами username
и confirmation_code
на эндпоинт /api/v1/auth/token/
, в ответе на запрос ему приходит token
(JWT-токен), как и при самостоятельной регистрации.
- Ресурс
auth
: аутентификация. - Ресурс
users
: пользователи. - Ресурс
titles
: произведения, к которым пишут отзывы (определённый фильм, книга или песенка). - Ресурс
categories
: категории (типы) произведений («Фильмы», «Книги», «Музыка»). - Ресурс
genres
: жанры произведений. Одно произведение может быть привязано к нескольким жанрам. - Ресурс
reviews
: отзывы на произведения. Отзыв привязан к определённому произведению. - Ресурс
comments
: комментарии к отзывам. Комментарий привязан к определённому отзыву. Каждый ресурс описан в документации Redoc: указаны эндпоинты (адреса, по которым можно сделать запрос), разрешённые типы запросов, права доступа и дополнительные параметры, если это необходимо.
Используется аутентификация с использованием JWT-токенов
Security Scheme Type | API Key |
---|---|
Header parameter name | Bearer |