Управление локальным сервером
Используйте yarn twenty docker:* для управления локальным контейнером Twenty:
| Команда | Что делает |
|---|
yarn twenty docker:start | Запустить сервер (при необходимости скачивает образ) |
yarn twenty docker:start 2.2.0 | Запустить конкретную версию сервера |
yarn twenty docker:start --port 3030 | Запустить на пользовательском порту |
yarn twenty docker:stop | Остановить сервер (данные сохраняются) |
yarn twenty docker:status | Показать URL, версию и учётные данные для входа |
yarn twenty docker:logs | Потоковый вывод журналов сервера |
yarn twenty docker:reset | Стереть данные и начать заново |
yarn twenty docker:upgrade | Скачать последний образ twenty-app-dev |
yarn twenty docker:upgrade 2.2.0 | Обновить до конкретной версии |
twenty-app-dev-data для PostgreSQL, twenty-app-dev-storage для файлов). Используйте reset, чтобы стереть всё.
Фиксация версии сервера
Когда версия не передана, docker:start определяет версию из диапазона engines.twenty вашего приложения в package.json — того же диапазона, по которому сервер выполняет проверку при установке вашего приложения. Он запускает самый новый опубликованный образ twenty-app-dev, который удовлетворяет диапазону, и использует latest, если поле отсутствует или ни одна опубликованная версия не совпадает:
{
"engines": {
"twenty": ">=2.2.0"
}
}
yarn twenty docker:start 2.3.0. Если контейнер уже существует с другой версией, docker:start обновляет его на месте (пересоздаёт контейнер с сохранением томов данных).
Обновление образа сервера
yarn twenty docker:upgrade скачивает последний образ, сравнивает дайджесты и пересоздаёт контейнер только если действительно что-то изменилось. Тома сохраняются — заменяется только контейнер. Если был скачан новый образ и контейнер работал, при обновлении автоматически запускается новый контейнер; затем выполните yarn twenty docker:start, чтобы дождаться его готовности.
yarn twenty docker:upgrade # Latest
yarn twenty docker:upgrade 2.2.0 # Specific version
yarn twenty docker:status (эта команда показывает APP_VERSION, встроенную в контейнер).
Запуск параллельного тестового экземпляра
Передайте --test любой команде docker:*, чтобы управлять вторым, полностью изолированным экземпляром — это полезно для запуска интеграционных тестов или экспериментов, не затрагивая ваши основные данные разработки:
| Команда | Что делает |
|---|
yarn twenty docker:start --test | Запустить тестовый экземпляр (по умолчанию — порт 2021) |
yarn twenty docker:stop --test | Остановить его |
yarn twenty docker:status --test | Показать его статус |
yarn twenty docker:logs --test | Транслировать его журналы |
yarn twenty docker:reset --test | Стереть его данные |
yarn twenty docker:upgrade --test | Обновить его образ |
twenty-app-dev-test) с выделенными томами (twenty-app-dev-test-data, twenty-app-dev-test-storage) и собственной конфигурацией, поэтому он может работать параллельно с вашим основным экземпляром без конфликтов. Совместите --test с --port, чтобы переопределить значение по умолчанию (2021).
Ручная настройка (без генератора каркаса)
Пропустите генератор каркаса, если вы добавляете SDK в существующий проект:
yarn add twenty-sdk twenty-client-sdk
package.json:
{
"scripts": {
"twenty": "twenty"
}
}
yarn twenty dev, yarn twenty docker:start и остальные команды.
Не устанавливайте twenty-sdk глобально — фиксируйте версию в каждом проекте, чтобы каждое приложение использовало свою собственную версию.
