Перейти к основному содержанию

Запустите Twenty локально

Установите и запустите Docker, затем выполните:
local start запускает веб-интерфейс, API, воркер и базы данных. Она работает вне папки приложения, ожидает готовности среды и выводит её URL-адрес. Вход — это отдельный шаг. Чтобы затем установить приложение, выполните twenty app apply --create --remote local из его каталога. Для нового экземпляра явно укажите версию или позвольте CLI выбрать самую высокую опубликованную версию, соответствующую engines.twenty вашего приложения. Вне приложения с этой настройкой используется latest. Существующие экземпляры сохраняют свою версию и данные. Для существующего экземпляра совместимость с engines.twenty проверяется с помощью APP_VERSION образа, в том числе если его тег — latest. Отсутствующая, недопустимая или несовместимая версия вызывает предупреждение, а запуск продолжается.
Новые экземпляры принимают подключения только через loopback, на порту 2020. При создании экземпляра используйте --port \<port>, чтобы выбрать другой порт. Используйте контекст локального сокета Docker; удалённые движки Docker не поддерживаются этими командами.

Обновить или сбросить

При обновлении запрашиваемый образ загружается перед заменой экземпляра. При этом сохраняются его порты, база данных и файловые тома, а также переопределения окружения. Новые значения CLI по умолчанию применяются к вновь созданным экземплярам; обновляет сохранение существующих значений среды. Без версии она следует тому же выбору версий, что и новый старт. Пользовательские конфигурации хранилища отклоняются. Понижения отвергаются перед заменой контейнера, в том числе при использовании тега, такого как latest. Оба изображения должны объявить действительными APP_VERSION, чтобы CLI мог сравнить их фактические версии. Передайте 2.53 для запуска или обновления с помощью тега с плавающей плавающей v2.53 или 2.53.1 для выбора конкретной версии патча. Если создание не выполнено или отменено, CLI восстанавливает предыдущий контейнер и настройки. Как только начнется новая версия, неудачные обновления сохраняют объемы данных, но не откатывают обратно базы данных. stop сохраняет все данные. Чтобы навсегда удалить экземпляр и его данные, запустите:
Сброс запросов для подтверждения. Скрипты должны пройти --yes. Сохраненные удаленные репозитории и учетные данные не удаляются.

Интеграционные тесты

Используйте отдельный тестовый экземпляр с портом по умолчанию 2021:
Установите для TWENTY_API_KEY ключ этого экземпляра. Интеграционные тесты устанавливают и удаляют приложение, поэтому не используйте их в одной среде разработки. Передайте --test в журналы, остановить, обновить или сбросить при управлении этим экземпляром. Созданный рабочий процесс CI подготавливает изолированный экземпляр через twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main и отдельно устанавливает автономный CLI.

Другие локальные конфигурации

Для исходной копии Twenty также подходит существующая среда разработки:
Используйте фактический URL-адрес и порт вашего сервера. Для рабочих пространств с поддоменами используйте имя хоста рабочего пространства. Для развёртывания в производственной среде следуйте руководству по самостоятельному хостингу.

Зависимости проекта

Установите twenty-sdk и twenty-client-sdk в качестве зависимостей проекта. Установите CLI twenty глобально, затем выполните twenty app typecheck, twenty app build и twenty app apply из каталога приложения.