環境構築

はじめに

baserCMS公式レシピによる仮想環境構築

baserCMSの開発はDocker on Vagrant における仮想環境での開発を推奨しています。これにより各開発者の環境は画一的に揃えられ、不具合の再現性を高めることができます。インストーラで一発導入できるMAMPやXAMPPも手軽でいいのですが、LAMPで構成される仮想環境は本番環境に近いため安心です。

このドキュメントの対象

HTMLの読み書きやFTPの操作ができる人、一般的なオープンソースCMSのインストールや運用ができる人。プログラミングやサーバ操作などのスキルがなくても理解できるようにまとめました。ターミナル操作に慣れない人でも大丈夫です。

所要時間１〜２時間。ほとんど待ち時間です。以下より手順を說明します。

注意事項

Macをお使いの場合はOSを最新(Catalina)にアップデートしておかないと、Gitを使う時にxcode関係のエラーが出る可能性があります。「システム環境設定」の「ソフトウェアアップデート」を確認してください。

環境構築前の準備

VirtualboxとVagrantをインストールする

VirtualBox と Vagrant をインストールしてください。
※Macの場合はHomebrewを、Windowsの場合はscoopを使うと簡単です。Homebrew(scoop)をインストールする手間(文字列をコピペしてエンターするだけ)を含めても簡単です。

https://www.google.com/search?q=%E3%83%AD%E3%83%83%E3%82%AF+brew+virtualbox
「エラーによってインストールできませんでした」などと表示された場合は上記を確認してみてください。

以下、全てターミナル操作になります。

Vagrantにプラグインを追加する

Vagrantにプラグインを追加します。

$ vagrant plugin install vagrant-vbguest
$ vagrant plugin install vagrant-docker-compose

※先頭の $ は入力しません。これはプロンプトと呼ばれるもので、当ページではこれがCLIであることを示しています。

仮想マシンを作成する

ホームフォルダに移動する

ターミナルでホームフォルダに移動します。

$ cd ~

▲Macの場合

$ cd %homepath%

▲Windowsの場合
※PowerShellやbashを利用している場合はMacと同様に ~ で移動できます。

次セクションで説明する操作により、ここにフォルダが自動的に作成され、baserCMSの構成ファイル一式が展開されます。

※ホームフォルダでなくても問題ありません。自分が分かりやすい場所で作業をしましょう。

GitHub から baserCMS のリポジトリをクローンする

baserCMSのシステムファイル一式と、仮想マシン作成に必要な設定ファイルなどを取得します。

$ git clone https://github.com/baserproject/basercms.git

※ basercms というフォルダが生成され、その中にファイル一式が展開されます。このフォルダ名は変更しても問題ありません。
※ クローンというのはGit用語で、リポジトリの複製を行なうことを意味します。ファイルの取得のみを行なうダウンロードと違い、ファイル変更履歴などGitの機能まるごと複製します。

Vagrantfile を basercmsプロジェクトのフォルダ直下に作成する

$ cd basercms

生成された basercms フォルダに移動します。

そのまま使える雛形がvagrantフォルダにあるので、これをbasercmsプロジェクトのフォルダにそのままコピーします。

$ cp vagrant/Vagrantfile Vagrantfile

docker-compose.ymlをdockerフォルダ内に作成する

dockerフォルダ内の docker-compose.yml.default を docker-compose.yml にリネームします。

$ cp docker/docker-compose.yml.default docker/docker-compose.yml

vagrant up を実行する

vagrant up を実行すると、CentOS をインストールし、その上に、Docker や、docker-compose のインストールが始まります。
docker-compose も自動実行しますので、他に何もする必要がありません。

$ vagrant up

※ここで休憩。OSをインストールする処理が始まるため、数分程度では終わりません。画面が止まっているように見えても待ちましょう。
※作成される仮想環境のイメージは、プロジェクトフォルダ内ではなくVirtualBox規定のデータフォルダ内に作成されます。
※vagrant up は本来は仮想マシンを起動するだけのコマンドですが、初回の vagrant up は vagrant init による初期化処理を兼ねます。プリセットされたインストール処理がこの時に実行されます。

vagrant up が完了すると仮想マシンが完成です。

Vagrantがうまく起動しない場合は、 Vagrantの問題 を参考にしてください。

開発を補佐するライブラリを仮想マシンにインストールする

作成されたばかりの仮想マシンにログインします。

$ vagrant ssh

※普通にsshコマンドでログインしてもよいですが、vagrantを使うと覚えることが少なくすみます。

docker フォルダに移動します。

$ cd /vagrant/docker

composer を実行します。

$ docker exec bc-php composer install --no-plugins

以上でbaserCMSをインストールする準備ができました。

baserCMSをインストールする

baserCMSのインストーラをブラウザで開く

https://localhost/ にアクセスすると、baserCMSのインストーラーが起動します。あとはインストーラのガイドに従ってインストールを進めてください。

データベース情報

name	value
host	MySQL:bc-db / PostgreSQL:bc-pg
user	root
password	root
database	basercms

無事に管理画面が表示されればインストール完了です。おつかれさまでした！

仮想マシンの操作

Vagrantfileが存在するフォルダ(baserCMSのプロジェクトフォルダ)で、コマンドを次のように入力します。

$ vagrant up

仮想マシンを起動します。電源オンと同じです。初回の vagrant up はプロビジョニング処理(インストール・セットアップのこと)を伴いますが、2回目以降は仮想マシンを起動するだけです。

$ vagrant reload

仮想マシンを再起動します。

$ vagrant halt

仮想マシンをシャットダウンします。電源オフと同じです。

環境を作り直したい場合は

$ vagrant destroy

destroyオプションで仮想環境を削除します。

vagrantの残骸が .vagrant フォルダに残っているので、.vagrant フォルダごと削除してください。あとは vagrant up をやり直せば仮想環境の新規作成が始まります。

Vagrantのスナップショット機能

https://www.google.com/search?q=vagrant+save+restore

ゲームのセーブ機能のような感じで、仮想マシンの状態を保存しておくことができます。たとえばインストーラの改修を行ないたい場合などは、baserCMSをインストールする前の状態でスナップショットをとっておくとよいでしょう。

各種ツール

データベース（MySQL）を確認する

データベースの内容は、phpMyAdminで確認できます。
http://localhost:8080/

データベース（PostgreSQL）を確認する

データベースの内容は、pgAdminで確認できます。
http://localhost:10080/

送信メールを確認する

baserCMSが送信したメールは、MailCatcher で確認できます。
http://localhost:1080/

SSL通信でサイトを確認する

自己証明書によってSSL通信で確認できます。
https://localhost/