既存のプロジェクトへ導入する場合
予め Clover CMS がセットアップされたパッケージ pickles2/pickles2 を使って使い始めることもできますが、これ以前から運用されていたプロジェクトにも、 Clover CMS を導入して利用することができます。
以下に、既存プロジェクトに Clover CMS を導入する手順をご紹介します。
Composerパッケージ pickles2/px2-clover を導入する
次のコマンドで、プロジェクトにパッケージをインストールします。
$ composer require pickles2/px2-clover;
メインコンフィグを設定する
px-files/config.php を開いて、 $conf->funcs->before_sitemap の先頭に、 tomk79\pickles2\px2clover\main::register() の設定を追加します。
// funcs: Before sitemap
$conf->funcs->before_sitemap = [
// px2-clover
tomk79\pickles2\px2clover\main::register( array(
/* any options... */
) ),
// ...other plugins
];
続いて、 $conf->allow_pxcommands を有効に設定します。
$conf->allow_pxcommands = 1;
この設定により、すべてのPXコマンドがブラウザから実行できるようになります。 通常、この設定は無効にすることが推奨されていますが、 Clover CMS が、他のすべてのPXコマンドの実行に認証を求め、保護するため、安全に使うことができます。
ただし、この保護が有効になるためには、他のプラグインよりも先に登録されている必要があることに注意してください。 $conf->funcs->before_sitemap の先頭が最も望ましい位置です。
プラグインオプション
必要に応じて、追加のオプションを設定できます。
// funcs: Before sitemap
$conf->funcs->before_sitemap = [
// px2-clover
tomk79\pickles2\px2clover\main::register( array(
"protect_preview" => true, // プレビューに認証を要求するか？; false (default) | true
) ),
];
管理画面から初期設定する
ここまでの設定ができたら、ブラウザでプレビュー http://127.0.0.1:8080/ にアクセスし、管理画面から初期設定を行います。
プレビュー http://127.0.0.1:8080/ の初期設定画面
お名前、ユーザーID、パスワード、メールアドレス、使用する言語 を入力して、最初の管理者ユーザーを作成します。
この初期設定画面は、ユーザーが定義されていない場合に表示されるものです。最初の管理者ユーザーが作成されたあとには表示されなくなります。
管理者ユーザーの作成に成功すると、続いてログイン画面が表示されます。先程作成した最初の管理者ユーザーのIDとパスワードを入力し、ログインしてください。
ログインに成功すると、ダッシュボード画面が表示されます。
Gitリポジトリは、編集履歴の管理に必要です。Gitリポジトリを初期化するボタンをクリックして、初期化してください。
コマンドのパスが通っていないメッセージが表示される場合
お使いの環境によっては、次のような「xxxコマンドがインストールされていないか、パスが通っていません。」というメッセージが表示される場合があります。
このメッセージが表示される場合は、可能な場合は、指摘されているコマンドのパスを通してください。または、 .env という名前のファイルを作成し、各コマンドの絶対パスを設定してみてください。
CMD_PHP="/path/to/php"
CMD_COMPOSER="/path/to/composer"
CMD_GIT="/path/to/git"
各コマンドの実際のパスは、お使いのシステムの設定によって異なります。 /path/to/xxx の部分を、正しいパスに置き換えて記述してください。 実際のパスがわからないときは、システムの管理者にお問い合わせください。
プレビューと管理画面
お疲れさまでした！ ここまでの操作で、Pickles 2 を使い始める準備は整いました。
プレビューと管理画面を交互に行き来しながら、ウェブサイトの制作を開始できます。
管理画面左下の「プレビューへ戻る」ボタンをクリックすると、管理画面を抜けてウェブサイトのフロントページのプレビューを開くことができます。
管理画面に戻るときは、プレビュー画面の右下にある「ダッシュボード」や「記事編集」ボタンをクリックします。
初めての Pickles 2 のセットアップ手順は以上です。