Rôle Ansible : October CMS

Rôle pour installer et configurer October CMS.

Prérequis

Aucun.

Variables du rôle

Les variables disponibles sont listées ci-dessous, avec leurs valeurs par défaut.

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

Déploiement d'une application October CMS existante depuis un dépôt Git.

• octobercms_deploy:boolean - Mettez ceci à true et les deux octobercms_build_from_installer et octobercms_build_from_composer à false pour cloner depuis un dépôt Git.
• octobercms_deploy_repo:string - Spécifie l'URL du dépôt.
• octobercms_deploy_version:string - Spécifie la version à installer. Peut être le nom d'une branche ou d'une étiquette.
• octobercms_deploy_depth:int - Spécifie le nombre de révisions à tronquer dans le dépôt cloné. Une valeur de 0 téléchargera toutes les révisions.
• octobercms_deploy_path:string - Spécifie où le dépôt sera cloné.
• octobercms_deploy_deployment_key_path:string - Spécifie le chemin vers la clé de déploiement SSH Git. Nécessaire lors du travail avec des dépôts privés.

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

Installation d'October à l'aide de l'installateur natif.

• octobercms_build_from_installer:boolean - Mettez ceci à true et octobercms_build_from_composer à false pour installer à l'aide de l'installateur natif.
• octobercms_installer_path:string - Spécifie où October sera installé.

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

Installation d'October à l'aide de Composer.

• octobercms_build_from_composer:boolean - Mettez ceci à true et octobercms_build_from_installer à false pour installer à l'aide de Composer.
• octobercms_composer_project_path:string - Spécifie où October sera installé.
• octobercms_composer_install:boolean - Spécifie si composer install doit être exécuté après l'installation d'October.
• octobercms_composer_no_dev:boolean - Spécifie si l'installation des paquets de développement requis doit être désactivée.

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

Paramètres de configuration.

• octobercms_root_path:string - Spécifie où October sera installé.
• octobercms_owner:string - Spécifie l'utilisateur qui sera propriétaire de l'installation d'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

Paramètres facultatifs pour configurer l'application.

• octobercms_app_debug:boolean - Spécifie si le mode de débogage est activé.
• octobercms_app_environment:string - Spécifie l'environnement de l'application.
• octobercms_app_name:string - Spécifie le nom de l'application.
• octobercms_app_url:string - Spécifie l'URL de base utilisée par l'application.
• octobercms_app_key:string - Spécifie la clé de chiffrement que l'application doit utiliser.
• octobercms_app_timezone:string - Spécifie le fuseau horaire de l'application. Il est FORTEMENT recommandé de le laisser sur UTC (car le fuseau horaire de votre serveur et de votre base de données devrait également être en UTC) et d'utiliser octobercms_cms_backend_timezone pour définir le fuseau horaire par défaut utilisé dans le backend pour afficher les dates et heures.

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

Paramètres facultatifs pour configurer October.

• octobercms_cms_edge_updates:boolean - Mettez ceci à true pour télécharger et utiliser des copies de développement des fichiers principaux et des plugins.
• octobercms_cms_disable_core_updates:boolean - Mettez ceci à true pour désactiver les mises à jour du noyau délivrées par la passerelle October.
• octobercms_cms_enable_routes_cache:boolean - Spécifie si la mise en cache des routes est activée. Il est recommandé de désactiver pendant le développement et d'activer en mode production.
• octobercms_cms_enable_assets_cache:boolean - Spécifie si la mise en cache des assets est activée. Il est recommandé de désactiver pendant le développement et d'activer en mode production.
• octobercms_cms_database_templates:boolean - Spécifie si les modèles de thème sont stockés dans la base de données au lieu du système de fichiers.
• octobercms_cms_enable_csrf:boolean - Spécifie si la protection CSRF est activée.
• octobercms_cms_active_theme:string - Spécifie le thème CMS par défaut.
• octobercms_cms_backend_uri:string - Spécifie le nom d'URL utilisé pour accéder aux pages de backend.
• octobercms_cms_backend_timezone:string - Spécifie le paramètre par défaut pour le fuseau horaire de l'utilisateur du backend.

octobercms_database_connection: mysql
octobercms_database_name: 'database' ou MySQL, PostgreSQL et SQL Server / 'storage/database.sqlite' pour SQLite
octobercms_database_prefix: ''

Paramètres pour configurer une base de données à utiliser avec October.

• octobercms_database_connection:string - Spécifie quelle connexion à la base de données utiliser. Les options possibles sont sqlite, mysql, pgsql et sqlsrv.
• octobercms_database_name:string - Spécifie le nom de la base de données.
• octobercms_database_prefix:string - Spécifie un préfixe qui est ajouté aux noms de tables de la base de données.

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

Paramètres supplémentaires pour configurer la base de données. (MySQL, PostgreSQL et SQL Server)

• octobercms_database_host:string - Spécifie l'hôte où se trouve la base de données.
• octobercms_database_port:int - Spécifie le port d'accès à la base de données.
• octobercms_database_user:string - Spécifie l'utilisateur de la base de données.
• octobercms_database_password:string - Spécifie le mot de passe de l'utilisateur de la base de données.

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

Paramètres supplémentaires pour configurer la base de données. (MySQL, PostgreSQL)

• octobercms_database_charset:string - Spécifie l'encodage des caractères pour la base de données.

octobercms_database_collation: utf8mb4_unicode_ci

Paramètres supplémentaires pour configurer la base de données. (MySQL)

• octobercms_database_collation:string - Spécifie le tri utilisé pour la base de données.

octobercms_database_schema: public

Paramètres supplémentaires pour configurer la base de données. (PostgreSQL)

• octobercms_database_schema:string - Spécifie le schéma utilisé pour la base de données.

octobercms_use_dotenv_config: no
octobercms_use_config_for_testing: no
octobercms_create_public_directory: no

Paramètres supplémentaires pour October.

• octobercms_use_dotenv_config:boolean - Mettez ceci à true pour convertir la configuration de base en fichier DotEnv.
• octobercms_use_config_for_testing:boolean - Mettez ceci à true pour utiliser une base de données séparée pour les tests. Voir configuration de l'environnement pour la configuration d'un environnement de test.
• octobercms_create_public_directory:boolean - Mettez ceci à true pour créer une copie miroir des fichiers publics nécessaires pour servir l'application. Voir Utilisation d'un dossier public.

octobercms_artisan_plugins: []
octobercms_artisan_plugins_extra: []

Installer les plugins Marketplace à l'aide d'Artisan.

• octobercms_artisan_plugins:list - Spécifie la liste des plugins au format AuthorName.PluginName à installer.
• octobercms_artisan_plugins_extra:list - Spécifie la liste des plugins supplémentaires au format AuthorName.PluginName à installer.

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

Installer des plugins à l'aide de Git.

• octobercms_plugins_path:string - Spécifie le dossier des plugins October.
• octobercms_git_plugins:list - Spécifie la liste des plugins à installer à l'aide de Git.
• octobercms_git_plugins_extra:list - Spécifie la liste des plugins supplémentaires à installer à l'aide de Git.

Les paramètres suivants sont requis :

• repo:string - Spécifie l'URL du dépôt.
• path:string - Spécifie où le dépôt sera cloné.

Les paramètres suivants sont facultatifs :

• version:string - Spécifie la version à installer. Peut être le nom d'une branche ou d'une étiquette. Par défaut, utilise la branche master.
• depth:int - Spécifie le nombre de révisions à tronquer dans le dépôt cloné. Par défaut, 1.

Dépendances

Aucune.

Exemple de 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

Licence

MIT

Auteur

Damian Lewis