Руководство по установке Docker Compose

В этом документе представлены подробные инструкции по развертыванию 88API с помощью Docker Compose.

Предварительные условия

• Установлены Docker и Docker Compose.
• Рекомендуемая система: Linux (Ubuntu/CentOS/Debian и т. д.)

Развертывание с помощью Docker Compose

Способ 1: используйте Git для клонирования проекта (рекомендуется)

Если у вас есть обычный доступ к GitHub, рекомендуется использовать этот метод. Полный файл конфигурации docker-compose.yml включен в проект:

# Скачать исходный код проекта
git clone https://github.com/QuantumNous/new-api.git

# Введите каталог проекта
cd new-api

# При необходимости отредактируйте файл docker-compose.yml.
# Использование редактора nano
nano docker-compose.yml
# Или используйте редактор vim
# vim docker-compose.yml

Способ 2. Создайте файл конфигурации вручную.

Если у вас нет доступа к GitHub или клонированному репозиторию, вы можете создать файл конфигурации вручную:

1. Создайте каталог для развертывания 88API:

mkdir new-api
cd new-api

1. Создайте в этом каталоге файл docker-compose.yml.

   Вы можете обратиться к примерам конфигурации в документе [Инструкции по настройке Docker Compose] (docker-compose-yml.md) и выбрать в соответствии с вашими потребностями:

   • Рекомендуется использовать полную конфигурацию (включая MySQL и Redis) для производственной среды.
   • Тестовая среда может использовать упрощенную конфигурацию.

2. Создайте файл с помощью текстового редактора:

# Использование редактора nano
nano docker-compose.yml

# Или используйте редактор vim
vim docker-compose.yml

Скопируйте выбранное содержимое конфигурации в этот файл и внесите необходимые изменения.

Запустить службу

Как только файл конфигурации будет готов, независимо от того, клонировали ли вы его через Git или создали вручную, вы можете запустить службу с помощью следующей команды:

# Запустите службу с помощью Docker Compose.
docker compose up -d

Эта команда автоматически извлечет необходимый образ и запустит службу в фоновом режиме.

Посмотреть журнал

• Журналы всех служб в реальном времени

docker compose logs -f

• Укажите журнал службы (пример: new-api, mysql, redis)

docker compose logs -f new-api
docker compose logs -f mysql
docker compose logs -f redis

• Просмотр только последних N строк

docker compose logs --tail=100 new-api

• Просмотр журналов за последний период

docker compose logs --since=10m new-api

• Показать временную метку

docker compose logs -f -t new-api

• Отладка в приоритетном режиме (вывод журнала в реальном времени при запуске)

docker compose up
# или просто начните и следуйте за услугой
docker compose up new-api

Нажмите Ctrl+C, чтобы выйти из режима переднего плана (соответствующая служба будет остановлена). Пожалуйста, используйте -d для фоновой работы.

• Просмотреть список/статус услуг

docker compose ps

• Просмотр журналов с использованием имени контейнера (если установлен container_name, например new-api в конфигурации).

docker logs -f new-api

Остановить службу

# Остановить службу
docker compose down

##Система доступа

После успешного запуска службы доступ к http://IP_сервера:3000 автоматически приведет к странице инициализации. Следуйте инструкциям на странице, чтобы вручную установить учетную запись и пароль администратора (требуется только при первой установке). После завершения инициализации вы можете войти в систему, используя установленную учетную запись администратора.