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

Composerを利用してOctoberをインストールします。

• octobercms_build_from_composer:boolean - これをtrueに設定し、octobercms_build_from_installerをfalseにすると、Composerを使用してインストールします。
• octobercms_composer_project_path:string - Octoberがインストールされる場所を指定します。
• octobercms_composer_install:boolean - Octoberがインストールされた後にcomposer installを実行するかどうかを指定します。
• 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のままにすることが強く推奨されます（サーバーとDBのタイムゾーンも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

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: []

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

著者

Damian Lewis