Есть приложение на nextjs и удаленный сервер. Как с помощью github настроить cd, чтобы…
- User
Есть приложение на nextjs и удаленный сервер. Как с помощью github настроить cd, чтобы при пуше в ветку master приложение пересобиралось на сервере?
- Assistant
Для настройки непрерывного развертывания (CD) с использованием GitHub Actions для приложения на Next.js, которое будет автоматически пересобираться и разворачиваться на удаленном сервере при пуше в ветку
master, следуйте этой инструкции:-
Подготовка сервера:
- Убедитесь, что у вас есть доступ по SSH к вашему серверу.
- Установите все необходимые зависимости на сервере для запуска Next.js приложения (Node.js, npm/yarn и т.д.).
-
Настройка GitHub Actions:
- Перейдите в ваш репозиторий на GitHub.
- Создайте папку
.github/workflowsв корне репозитория, если её ещё нет. - Внутри этой папки создайте файл, например,
deploy.yml.
-
Конфигурация GitHub Actions:
- В файл
deploy.ymlдобавьте следующую конфигурацию, изменив параметры под ваши нужды:
name: Deploy to Server on: push: branches: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Install dependencies run: | npm install - name: Build application run: | npm run build - name: Copy files via SSH uses: appleboy/scp-action@master with: host: ${{ secrets.SERVER_HOST }} username: ${{ secrets.SERVER_USER }} key: ${{ secrets.SERVER_SSH_KEY }} source: "your/build/output/path/*" target: "your/server/deployment/path" - name: Restart Application uses: appleboy/ssh-action@master with: host: ${{ secrets.SERVER_HOST }} username: ${{ secrets.SERVER_USER }} key: ${{ secrets.SERVER_SSH_KEY }} script: | cd your/server/deployment/path npm install --production pm2 restart your-application-name - В файл
-
Секреты и переменные окружения:
- В репозитории на GitHub перейдите в
Settings>Secrets and variables>Actions. - Создайте необходимые секреты:
SERVER_HOST: хост вашего сервера.SERVER_USER: имя пользователя для SSH.SERVER_SSH_KEY: приватный SSH-ключ для подключения к серверу. Убедитесь, что публичный ключ добавлен в~/.ssh/authorized_keysна сервере.
- В репозитории на GitHub перейдите в
-
Настройка сервера:
- Убедитесь, что на сервере установлен
pm2или другой процесс-менеджер для управления приложением. - Настройте вашу среду так, чтобы сервер автоматически перезапускался при изменении файлов (в этом примере используется
pm2).
- Убедитесь, что на сервере установлен
-
Проверка работы:
- Запушьте изменения в ветку
masterи проверьте, как GitHub Actions выполнит задачу по деплою.
- Запушьте изменения в ветку
Этот процесс настроит авторазвертывание вашего приложения каждый раз, когда вы вносите изменения в ветку
master. Не забудьте протестировать это с осторожностью, чтобы избежать неожиданных сбоев на продакшене. -
- User
Напиши скрипт, который бы поднимал приложение в докере
- Assistant
Чтобы развернуть приложение на Next.js в Docker, вы можете создать Dockerfile для сборки образа и скрипт для его запуска. Вот как это сделать шаг за шагом:
-
Создание Dockerfile:
В корне вашего проекта создайте файл с именем
Dockerfileи добавьте в него следующий код:# Используем официальный Node.js образ в качестве базового FROM node:18-alpine # Устанавливаем рабочую директорию WORKDIR /app # Копируем package.json и package-lock.json в рабочую директорию COPY package.json package-lock.json ./ # Устанавливаем зависимости RUN npm install # Копируем остальные файлы проекта в рабочую директорию COPY . . # Сборка приложения Next.js RUN npm run build # Указываем команду запуска для контейнера CMD ["npm", "start"] # Экспонируем порт 3000 (стандартный для Next.js) EXPOSE 3000Не забудьте заменить команды сборки и сервера в Dockerfile, если у вас используются другие, например,
yarn buildиyarn start. -
Docker Compose (опционально):
Если у вас много компонентов или вам нужно управлять другими сервисами (например, базой данных), рассмотрите использование Docker Compose. Создайте файл
docker-compose.yml:version: '3.8' services: app: build: . ports: - '3000:3000' environment: NODE_ENV: production -
Создание скрипта для сборки и запуска Docker контейнера:
Создайте скрипт
run-docker.shилиrun-docker.batв зависимости от вашей операционной системы. Пример дляrun-docker.sh:#!/bin/bash # Строим Docker образ docker build -t my-nextjs-app . # Запускаем контейнер docker run -p 3000:3000 my-nextjs-appУбедитесь, что у файла есть права на выполнение:
chmod +x run-docker.sh -
Запуск приложения:
Теперь вы можете собрать и запустить ваше приложение в Docker с помощью команды:
./run-docker.shЕсли вы используете Docker Compose, команда будет:
docker-compose up --build
Этот процесс позволит вам запаковать ваше приложение в Docker контейнер и развернуть его с консистентными зависимостями и окружением, что облегчает развертывание на различных серверах. Не забудьте убедиться, что у вас установлены Docker и Docker Compose (если используете).
-
- User
Нужно запускать приложение в докере через гитхаб
- Assistant
Чтобы настроить автоматический деплой вашего приложения в Docker при пуше в репозиторий на GitHub, вы можете использовать GitHub Actions. Этот процесс будет построен так, чтобы каждый раз, когда вы запушите изменения в репозиторий, GitHub Actions будет автоматически собирать Docker-образ и разворачивать его на вашем сервере. Допустим, вы хотите делать это при пуше в ветку
master.Вот пример, как можно это настроить:
Шаги для настройки GitHub Actions с Docker
-
Создайте Dockerfile Убедитесь, что у вас есть рабочий
Dockerfileв корне вашего проекта, как описано в предыдущем ответе. -
Настройка GitHub Actions В корне вашего репозитория создайте директорию
.github/workflowsи создайте внутри файл, например,docker-deploy.yml. -
Конфигурация Workflow Добавьте следующий код в
docker-deploy.yml, адаптировав под ваши нужды:name: Build and Deploy Docker Image on: push: branches: - master jobs: build: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Log into Docker Hub uses: docker/login-action@v2 with: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} - name: Build and push Docker image uses: docker/build-push-action@v4 with: context: . tags: ${{ secrets.DOCKER_USERNAME }}/my-nextjs-app:latest push: true deploy: runs-on: ubuntu-latest needs: build steps: - name: SSH and Deploy uses: appleboy/ssh-action@master with: host: ${{ secrets.SERVER_HOST }} username: ${{ secrets.SERVER_USER }} key: ${{ secrets.SERVER_SSH_KEY }} script: | docker pull ${{ secrets.DOCKER_USERNAME }}/my-nextjs-app:latest docker stop my-nextjs-app || true docker rm my-nextjs-app || true docker run -d -p 3000:3000 --name my-nextjs-app ${{ secrets.DOCKER_USERNAME }}/my-nextjs-app:latest -
Создание секретов в GitHub
Перейдите в
Settingsвашего репозитория на GitHub и добавьте следующие секреты:DOCKER_USERNAME: ваш логин на Docker Hub.DOCKER_PASSWORD: ваш пароль Docker Hub (рекомендуется использовать токен доступа).SERVER_HOST: адрес вашего сервера.SERVER_USER: имя пользователя для SSH.SERVER_SSH_KEY: приватный SSH-ключ для подключения к серверу.
-
Настройка сервера
Убедитесь, что Docker установлен и работает на вашем сервере. Также убедитесь, что ваш SSH-ключ добавлен в
authorized_keysна сервере, чтобы GitHub Actions мог подключаться по SSH.
Теперь, когда вы запушите изменения в ветку
master, GitHub Actions автоматически соберет Docker-образ и развернет его на вашем сервере. -
- User
Могу ли я собирать докер контейнер на самом сервере, а не пушить в докерхаб?
- Assistant
Да, вы можете собирать Docker-контейнер непосредственно на сервере, не пуша его в Docker Hub. Это может быть удобнее и быстрее для некоторых сценариев развертывания. Для этого вам нужно будет изменить процесс, чтобы передавать файлы вашего приложения на сервер, а затем собирать и запускать контейнер там. Вот как вы можете это сделать с помощью GitHub Actions:
Настройка GitHub Actions для сборки на сервере
-
Создание Dockerfile
Убедитесь, что у вас есть Dockerfile в вашем проекте, как описано ранее.
-
Настройка GitHub Actions
В файле
.github/workflows/docker-deploy.ymlдобавьте следующий код. Этот workflow передаст файлы вашего приложения на сервер и там соберет и запустит Docker-контейнер.name: Deploy to Server on: push: branches: - master jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Copy files via SSH uses: appleboy/scp-action@v0.1.2 with: host: ${{ secrets.SERVER_HOST }} username: ${{ secrets.SERVER_USER }} key: ${{ secrets.SERVER_SSH_KEY }} source: "." target: "~/app" - name: SSH and Build Docker Image uses: appleboy/ssh-action@v0.1.2 with: host: ${{ secrets.SERVER_HOST }} username: ${{ secrets.SERVER_USER }} key: ${{ secrets.SERVER_SSH_KEY }} script: | cd ~/app docker build -t my-nextjs-app . docker stop my-nextjs-app || true docker rm my-nextjs-app || true docker run -d -p 3000:3000 --name my-nextjs-app my-nextjs-app -
Настройка секретов репозитория
Добавьте необходимые секреты в вашем репозитории на GitHub:
SERVER_HOST: адрес вашего сервера.SERVER_USER: имя пользователя для SSH.SERVER_SSH_KEY: приватный SSH-ключ для подключения к серверу.
-
Настройка сервера
- Убедитесь, что на сервере установлен Docker.
- Убедитесь, что SSH-ключ, который использует GitHub Actions, добавлен в
authorized_keysна сервере, чтобы GitHub Actions мог подключаться по SSH.
Теперь, когда вы запушите изменения в ветку
master, GitHub Actions передаст файлы вашего приложения на сервер, соберет Docker-образ и запустит контейнер, используя указанные команды. Это избавляет от необходимости использовать Docker Hub и позволяет управлять сборкой непосредственно на целевом сервере. -
- User
Как остановить контейнер по названию?
- Assistant
Чтобы остановить Docker-контейнер по его имени, вы можете использовать команду
docker stop. Вот как это сделать:-
Остановка контейнера по имени:
Если вы знаете точное имя контейнера, используйте следующую команду:
docker stop имя_контейнераНапример, если ваш контейнер называется
my-nextjs-app, команда будет выглядеть так:docker stop my-nextjs-app -
Удаление остановленного контейнера (если необходимо):
После остановки контейнера, если вы хотите его удалить, используйте команду
docker rm:docker rm имя_контейнераНапример:
docker rm my-nextjs-app
Эти команды полезны, если вы хотите перезапустить приложение или освободить ресурсы на вашем сервере. Остановка и удаление контейнера не влияет на Docker-образ, который вы создали ранее, поэтому вы всегда можете запустить новый контейнер из того же образа, когда это потребуется.
-
- User
Как удалить docker image по названию?
- Assistant
Чтобы удалить Docker-образ по его названию, вы можете использовать команду
docker rmi. Однако стоит отметить, что имя заимиджа (название) обычно состоит из имени репозитория и тега, например,my-nextjs-app:latest. Если у вас только имя и вы не указали тег, Docker предполагает тегlatest.Вот шаги, чтобы удалить образ по названию:
-
Найти точное имя и тег образа:
Вы можете использовать команду
docker images, чтобы просмотреть список всех локальных образов с их именами и тегами:docker imagesЭта команда покажет что-то вроде:
REPOSITORY TAG IMAGE ID CREATED SIZE my-nextjs-app latest abcdef123456 2 days ago 123MB -
Удалить образ:
Используйте команду
docker rmi, чтобы удалить образ, указав имя репозитория и тег (если есть).docker rmi имя_репозитория:тегНапример, если ваш образ называется
my-nextjs-appи у него тегlatest, команда будет:docker rmi my-nextjs-app:latestЕсли вы не укажете тег, Docker по умолчанию будет пытаться удалить образ с тегом
latest. -
Принудительное удаление образа:
Если образ все еще используется каким-либо контейнером (в том числе остановленным), вы можете использовать флаг
-f(или--force), чтобы принудительно удалить его:docker rmi -f имя_репозитория:тег
Убедитесь, что вы действительно хотите удалить образ, так как после удаления вам придется перестраивать его заново, если он снова понадобится.
-