Ansible Role: October CMS

Role to install and set up October CMS.

Requirements

None.

Role Variables

Here are the available settings with their default values.

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

To deploy an existing October CMS app from a Git repo:

• octobercms_deploy:boolean - Set to true and make both octobercms_build_from_installer and octobercms_build_from_composer false to clone from a Git repo.
• octobercms_deploy_repo:string - URL of the Git repo.
• octobercms_deploy_version:string - Version to install. Can be a branch or a tag.
• octobercms_deploy_depth:int - Number of revisions to download. A value of 0 means download all.
• octobercms_deploy_path:string - Directory where the repo will be cloned.
• octobercms_deploy_deployment_key_path:string - Path to the SSH key for Git. Required for private repositories.

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

To install October using the built-in installer:

• octobercms_build_from_installer:boolean - Set to true and octobercms_build_from_composer to false to use the built-in installer.
• octobercms_installer_path:string - Location where October will be installed.

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

To install October using Composer:

• octobercms_build_from_composer:boolean - Set to true and octobercms_build_from_installer to false to use Composer.
• octobercms_composer_project_path:string - Location where October will be installed.
• octobercms_composer_install:boolean - Whether to run composer install after October installation.
• octobercms_composer_no_dev:boolean - Whether to skip installing development packages.

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

Configuration settings:

• octobercms_root_path:string - Location where October will be installed.
• octobercms_owner:string - User with ownership of the October installation.

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

Optional app configuration settings:

• octobercms_app_debug:boolean - Enables debug mode.
• octobercms_app_environment:string - Sets the app environment.
• octobercms_app_name:string - Name of the app.
• octobercms_app_url:string - Base URL for the app.
• octobercms_app_key:string - Encryption key for the app.
• octobercms_app_timezone:string - Sets the timezone for the app. It is best to use UTC.

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

Optional settings to configure October:

• octobercms_cms_edge_updates:boolean - Set to true to use development versions of core files and plugins.
• octobercms_cms_disable_core_updates:boolean - Set to true to prevent core updates from the October service.
• octobercms_cms_enable_routes_cache:boolean - Enable route caching. Recommended to disable in development and enable in production.
• octobercms_cms_enable_assets_cache:boolean - Enable asset caching. Recommended to disable in development and enable in production.
• octobercms_cms_database_templates:boolean - Store theme templates in the database rather than on disk.
• octobercms_cms_enable_csrf:boolean - Whether CSRF protection is active.
• octobercms_cms_active_theme:string - Default theme for the CMS.
• octobercms_cms_backend_uri:string - URL for backend access.
• octobercms_cms_backend_timezone:string - Default timezone setting for backend users.

octobercms_database_connection: mysql
octobercms_database_name: 'database' or MySQL, PostgreSQL and SQL Server / 'storage/database.sqlite' for SQLite
octobercms_database_prefix: ''

Database configuration for October:

• octobercms_database_connection:string - Database connection type (options: sqlite, mysql, pgsql, sqlsrv).
• octobercms_database_name:string - Name of the database.
• octobercms_database_prefix:string - Prefix for database table names.

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

Additional database settings (MySQL, PostgreSQL, SQL Server):

• octobercms_database_host:string - Host for the database.
• octobercms_database_port:int - Port for database access.
• octobercms_database_user:string - Database username.
• octobercms_database_password:string - Password for the database user.

octobercms_database_charset: 'utf8mb4' for MySQL / 'utf8' for PostgreSQL

More database settings (MySQL, PostgreSQL):

• octobercms_database_charset:string - Character set for the database.

octobercms_database_collation: utf8mb4_unicode_ci

More database settings (MySQL):

• octobercms_database_collation:string - Collation for the database.

octobercms_database_schema: public

More database settings (PostgreSQL):

• octobercms_database_schema:string - Schema for the database.

octobercms_use_dotenv_config: no
octobercms_use_config_for_testing: no
octobercms_create_public_directory: no

Additional settings for October:

• octobercms_use_dotenv_config:boolean - Set to true to use a DotEnv file for config.
• octobercms_use_config_for_testing:boolean - Set to true to use a separate database for testing.
• octobercms_create_public_directory:boolean - Set to true to create a copy of public files needed for the app.

octobercms_artisan_plugins: []
octobercms_artisan_plugins_extra: []

Install plugins from the Marketplace using Artisan:

• octobercms_artisan_plugins:list - List of plugins to install (format: AuthorName.PluginName).
• octobercms_artisan_plugins_extra:list - Additional plugins to install using the same format.

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

Install plugins from Git:

• octobercms_plugins_path:string - Directory for October plugins.
• octobercms_git_plugins:list - List of plugins to install via Git.
• octobercms_git_plugins_extra:list - Additional plugins list for Git.

Required parameters:

• repo:string - URL of the repository.
• path:string - Location to clone the repository.

Optional parameters:

• version:string - Version to install (branch or tag). Defaults to master.
• depth:int - Number of revisions to download. Defaults to 1.

Dependencies

None.

Example Playbook

- 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

License

MIT

Author

Damian Lewis