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

Поля файла user_settings.json

Файл описывает как работать с уже заданным стеком (odpm.json): какой проект разрабатывать, какие модули ставить, как создавать базу. Если файла нет, odpm создаёт его из шаблона.

Поле Назначение
developing_project Ссылка на разрабатываемый репозиторий или каталог (форматы ссылок); поддерживает ${VAR} — см. ниже
init_modules Модули для установки при голом -i (через запятую, без пробелов); явный -i sale,crm перекрывает для этого запуска
update_modules Модули для обновления при голом -u; явный -u my_module перекрывает для этого запуска
db_creation_data Параметры новой базы при первом -d
db_creation_data.db_lang Язык базы, напр. ru_RU (не язык сообщений odpm)
db_creation_data.db_country_code Код страны или false
db_creation_data.create_demo Создавать ли демо-данные (по умолчанию false в новом user_settings.json)
db_creation_data.db_default_admin_login Логин администратора
db_creation_data.db_default_admin_password Пароль администратора
update_git_repos Обновлять ли git при перезапуске
clean_git_repos Сбрасывать ли локальные изменения в platform и зависимостях
check_system Проверки Docker и git для новичков (по умолчанию true)
dev_mode Режим разработки Odoo; только сценарий developer
db_manager_password Пароль менеджера баз Odoo (на hardened — обычно ${@secret:odpm.db_manager_password}; см. безопасность)
sql_queries Список SQL для --sql-execute
pre_commit_map_files Файлы для pre-commit при работе не на Linux
use_oca_dependencies Расширенный разбор OCA и вложенных odpm.json (по умолчанию false)
create_module_links Символические ссылки для редактора (по умолчанию false)
sidecars Локальные переключатели compose-sidecar: имя → true/false. false исключает сервис из plan, fragments и docker-compose.yml; отсутствие ключа или true — оставить. Нельзя указывать db/odoo. После смены — odpm --skip-start. См. ниже

Подстановка ${VAR} в developing_project

Поле developing_project — единственное в user_settings.json, где odpm раскрывает ${ИМЯ} / ${ИМЯ:-default} при чтении файла. Источник значений: export / CI → project .env → default в строке.

{
  "developing_project": "file://${DEVELOPING_PROJECT_DIR}"
}

DEVELOPING_PROJECT_DIR=/home/dev/my_addons

Остальные поля user_settings.json подстановку не получают.

Режим разработки Odoo (dev_mode)

Строка с флагами Odoo: reload, qweb, werkzeug, xml, access, all (см. документацию Odoo). В сценариях server и ci игнорируется. После изменения — odpm --skip-start.

Проверка системы (check_system)

При true выполняются базовые проверки git и Docker. Не отключает валидацию compose. Освобождение занятых портов в режиме разработчика — отдельная логика.

Упрощают навигацию и отладку в VS Code — отдельная статья.

Локальные sidecars (sidecars)

Карта логических имён compose-сервисов из manifest/plugins (не service_sources и не db/odoo):

{
  "sidecars": {
    "mailpit": false,
    "redis": true
  }
}
  • false — сервис не попадает в odpm plan fragment steps, .odpm/compose/fragments/ и docker-compose.yml.
  • отсутствие ключа или true — сервис остаётся.
  • Только JSON boolean; строки вроде "false" — ошибка.
  • Личные false в закоммиченном user_settings.json могут удивить команду/CI — согласовывайте или держите override локально.
  • После изменения: odpm --skip-start (как после смены dev_mode). Подробнее: ADR-025.