Документация к API проекта YAMDB (v1)

Описание

Проект YaMDb собирает отзывы пользователей на различные произведения. Он полность готов для автоматического развертывания его на удаленном nginx сервере, с использованием CI/CD. При каждом пуше на гит-хаб. С помощью CI/CD проект запустит тесты, сделает пуш образа на DockerHub и развернет проект на удаленном сервере, после успешного выполнения всех этапов получите уведомление в Telegram.

Ресурс доступен на удаленном сервере

Ознакомиться с документацией - тут

Как запустить проект на удаленном сервере:

Подготовить сервер

sudo apt update && sudo apt upgrade -y && sudo apt install curl -y

• Установим докер

sudo curl -fsSL https://get.docker.com -o get-docker.sh && sudo sh get-docker.sh && sudo rm get-docker.sh

• Установить docker-compose

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

Apply executable permissions to the binary:

sudo chmod +x /usr/local/bin/docker-compose

создать папку nginx

mkdir nginx

Настройка инфраструктуры

• Зайти в папку infra и перенести файлы docker-compose.yaml и /nginx/default.conf на удаленный сервер:

scp ./docker-compose.yaml <имя-пользователя>@<ip-address>:~/

scp ./nginx/default.conf <имя-пользователя>@<ip-address>:~/nginx/

• Прописать секреты в https://github.com/<ваш-username>/yamdb_final/settings/secrets/actions:

для удаленного сервера:

HOST
USER
SSH_PASSWORD

для базы данных:

DB_ENGINE
DB_NAME
POSTGRES_USER
POSTGRES_PASSWORD
DB_HOST
DB_PORT

для логина в DockerHub:

DOCKER_USERNAME
DOCKER_PASSWORD

для почтового сервера

EMAIL_SMTP
EMAIL
EMAIL_PASSWORD

для уведомлений от Телеграм-бота

TELEGRAM_TOKEN
TELEGRAM_TO

• Выполнить миграции на удаленном сервере:

sudo docker-compose exec web python manage.py migrate

• Подключить статику:

docker-compose exec web python manage.py collectstatic --no-input

Получить SSL сертификат

для получения серфтифика воспользоваться certbot от Let’s Encrypt и прописать полученнный сертификат в nginx/default.conf

Алгоритм получения токена:

1. Получить код подтвержения.

в теле передать JSON { "username": "имя_пользователя", "email": "адрес эл. почты" } POST-запрос на эндпоинт:

/api/v1/auth/signup/

в папке sent_emails найти письмо и скопировать полученный код подвтерждения.

2. Получить токен.

в теле передать JSON { "username": "имя_пользователя", "confirmation_code": "код_подвтержения" } POST-запрос на эндпоинт:

/api/v1/auth/token/

Использовать полученный токен для авторизации.

Дополнительные команды:

• Создать Супер Пользовтеля:

docker-compose exec web python manage.py createsuperuser

• Загрузить тестовую Базу Данных:

docker-compose exec web python manage.py importcsv

• Посмотреть структуру проекта на сервере:

sudo docker-compose run web bash

• Создать дамп (резервную копию) базы:

docker-compose exec web python manage.py dumpdata > fixtures.json
#(unicode != UTF-8)

• Удалить запущенные контейнеры:

docker-compose down -v

• Остановить все запущенные контейнеры:

sudo docker stop $(sudo docker ps -a -q)

• Удалить все неиспользуемые контейнеры и образы:

docker system prune -a

• Скачать образ с DockerHub:

docker pull afivan20/api_yamdb:latest

Автор

Иван Афанасьев, python-devloper