Ansible Роль: October CMS

Роль для установки и настройки October CMS.

Требования

Нет.

Переменные роли

Доступные переменные перечислены ниже вместе с их значениями по умолчанию.

octobercms_deploy: no
octobercms_deploy_repo: ''
octobercms_deploy_version: master
octobercms_deploy_depth: 0
octobercms_deploy_path: /var/www/octobercms
octobercms_deploy_deployment_key_path: ~/.ssh/id_octobercms_deployment

Развертывание существующего приложения October CMS из Git репозитория.

• octobercms_deploy:boolean - Установите на true и оба octobercms_build_from_installer и octobercms_build_from_composer на false, чтобы клонировать из Git репозитория.
• octobercms_deploy_repo:string - Указывает URL репозитория.
• octobercms_deploy_version:string - Указывает версию для установки. Может быть именем ветки или тегом.
• octobercms_deploy_depth:int - Указывает количество ревизий для обрезки клонированного репозитория. Значение 0 загрузит все ревизии.
• octobercms_deploy_path:string - Указывает, куда будет клонирован репозиторий.
• octobercms_deploy_deployment_key_path:string - Указывает путь к SSH ключу развертывания Git. Обязателен при работе с частными репозиториями.

octobercms_build_from_installer: yes
octobercms_installer_path: "{{ octobercms_deploy_path }}"

Установка October с помощью встроенного установщика.

• octobercms_build_from_installer:boolean - Установите на true и octobercms_build_from_composer на false для установки с использованием встроенного установщика.
• octobercms_installer_path:string - Указывает, куда будет установлена October.

octobercms_build_from_composer: no
octobercms_composer_project_path: "{{ octobercms_deploy_path }}"
octobercms_composer_install: no
octobercms_composer_no_dev: yes

Установка October с помощью Composer.

• octobercms_build_from_composer:boolean - Установите на true и octobercms_build_from_installer на false для установки с помощью Composer.
• octobercms_composer_project_path:string - Указывает, куда будет установлена October.
• octobercms_composer_install:boolean - Указывает, нужно ли запускать composer install после установки October.
• octobercms_composer_no_dev:boolean - Указывает, нужно ли отключить установку необходимых пакетов для разработки.

octobercms_root_path: "{{ octobercms_deploy_path }}"
octobercms_owner: "{{ ansible_ssh_user }}"

Настройки конфигурации.

• octobercms_root_path:string - Указывает, куда будет установлена October.
• octobercms_owner:string - Указывает пользователя, который будет владельцем установки October.

octobercms_app_debug: yes
octobercms_app_environment: production
octobercms_app_name: October CMS
octobercms_app_url: http://localhost
octobercms_app_key: ''
octobercms_app_timezone: UTC

Дополнительные настройки для конфигурации приложения.

• octobercms_app_debug:boolean - Указывает, включен ли режим отладки.
• octobercms_app_environment:string - Указывает окружение приложения.
• octobercms_app_name:string - Указывает имя приложения.
• octobercms_app_url:string - Указывает базовый URL, используемый приложением.
• octobercms_app_key:string - Указывает ключ шифрования, который должно использовать приложение.
• octobercms_app_timezone:string - Указывает часовой пояс приложения. Рекомендовано оставить установленным на UTC (ваш сервер и БД также должны быть на этом часовом поясе) и вместо этого использовать octobercms_cms_backend_timezone для установки часового пояса по умолчанию в бэкенде для отображения дат и времени.

octobercms_cms_edge_updates: no
octobercms_cms_disable_core_updates: "{{ octobercms_build_from_composer | default(no) }}"
octobercms_cms_enable_routes_cache: no
octobercms_cms_enable_assets_cache: no
octobercms_cms_database_templates: no
octobercms_cms_enable_csrf: yes
octobercms_cms_active_theme: demo
octobercms_cms_backend_uri: backend
octobercms_cms_backend_timezone: UTC

Дополнительные настройки для конфигурации October.

• octobercms_cms_edge_updates:boolean - Установите на true, чтобы скачать и использовать разработческие копии основных файлов и плагинов.
• octobercms_cms_disable_core_updates:boolean - Установите на true, чтобы отключить обновления ядра, поступающие от October.
• octobercms_cms_enable_routes_cache:boolean - Указывает, включено ли кэширование маршрутов. Рекомендуется отключить во время разработки и включить в продуктивном режиме.
• octobercms_cms_enable_assets_cache:boolean - Указывает, включено ли кэширование ресурсов. Рекомендуется отключить во время разработки и включить в продуктивном режиме.
• octobercms_cms_database_templates:boolean - Указывает, должны ли шаблоны тем храниться в базе данных вместо файловой системы.
• octobercms_cms_enable_csrf:boolean - Указывает, включена ли защита от CSRF.
• octobercms_cms_active_theme:string - Указывает тему CMS по умолчанию.
• octobercms_cms_backend_uri:string - Указывает URL, используемый для доступа к страницам бэкенда.
• octobercms_cms_backend_timezone:string - Указывает настройку часового пояса пользователя бэкенда по умолчанию.

octobercms_database_connection: mysql
octobercms_database_name: 'database' или MySQL, PostgreSQL и SQL Server / 'storage/database.sqlite' для SQLite
octobercms_database_prefix: ''

Настройки для конфигурации базы данных для использования с October.

• octobercms_database_connection:string - Указывает, какое подключение к базе данных использовать. Возможные варианты: sqlite, mysql, pgsql и sqlsrv.
• octobercms_database_name:string - Указывает имя базы данных.
• octobercms_database_prefix:string - Указывает префикс, который добавляется к именам таблиц базы данных.

octobercms_database_host: localhost
octobercms_database_port: 3306 для MySQL / 5432 для PostgreSQL / 1433 для SQL Server
octobercms_database_user: root
octobercms_database_password: ''

Дополнительные настройки для конфигурации базы данных. (MySQL, PostgreSQL и SQL Server)

• octobercms_database_host:string - Указывает хост, где находится база данных.
• octobercms_database_port:int - Указывает порт для доступа к базе данных.
• octobercms_database_user:string - Указывает пользователя базы данных.
• octobercms_database_password:string - Указывает пароль пользователя базы данных.

octobercms_database_charset: 'utf8mb4' для MySQL / 'utf8' для PostgreSQL

Дополнительные настройки для конфигурации базы данных. (MySQL, PostgreSQL)

• octobercms_database_charset:string - Указывает кодировку символов для базы данных.

octobercms_database_collation: utf8mb4_unicode_ci

Дополнительные настройки для конфигурации базы данных. (MySQL)

• octobercms_database_collation:string - Указывает сортировку, используемую для базы данных.

octobercms_database_schema: public

Дополнительные настройки для конфигурации базы данных. (PostgreSQL)

• octobercms_database_schema:string - Указывает схему, используемую для базы данных.

octobercms_use_dotenv_config: no
octobercms_use_config_for_testing: no
octobercms_create_public_directory: no

Дополнительные настройки October.

• octobercms_use_dotenv_config:boolean - Установите на true, чтобы преобразовать базовую конфигурацию в файл DotEnv.
• octobercms_use_config_for_testing:boolean - Установите на true, чтобы использовать отдельную базу данных для тестирования. Смотрите конфигурацию окружения о конфигурировании тестового окружения.
• octobercms_create_public_directory:boolean - Установите на true, чтобы создать зеркальную копию общедоступных файлов, необходимых для работы приложения. Смотрите Использование публичной папки.

octobercms_artisan_plugins: []
octobercms_artisan_plugins_extra: []

Установить плагины из Marketplace с помощью Artisan.

• octobercms_artisan_plugins:list - Указывает список плагинов в формате AuthorName.PluginName для установки.
• octobercms_artisan_plugins_extra:list - Указывает список дополнительных плагинов в формате AuthorName.PluginName для установки.

octobercms_plugins_path: "{{ octobercms_deploy_path }}/plugins"
octobercms_git_plugins: []
octobercms_git_plugins_extra: []

Установить плагины с помощью Git.

• octobercms_plugins_path:string - Указывает папку плагинов October.
• octobercms_git_plugins:list - Указывает список плагинов для установки с помощью Git.
• octobercms_git_plugins_extra:list - Указывает список дополнительных плагинов для установки с помощью Git.

Следующие параметры обязательны:

• repo:string - Указывает URL репозитория.
• path:string - Указывает, куда будет клонирован репозиторий.

Следующие параметры являются необязательными:

• version:string - Указывает версию для установки. Может быть именем ветки или тегом. По умолчанию используется ветка master.
• depth:int - Указывает количество ревизий для обрезки клонированного репозитория. По умолчанию 1.

Зависимости

Нет.

Пример плейбука

- hosts: server
  become: yes

  vars:
    octobercms_owner: www-data
    octobercms_app_debug: no
    octobercms_app_url: https://example.com
    octobercms_database_name: octobercms
    octobercms_database_user: octobercms_user
    octobercms_database_password: secret

  tasks:
  - import_role:
      name: damianlewis.octobercms

Лицензия

MIT

Автор

Дэмиан Льюис