Blog

【初心者向け】やはりDockerが便利だ!開発環境にはDockerを使おう。

ローカルでの開発環境の構築ツールとしては、MAMP、XAMPP、vagrantなど、いろいろとありますが、最近は、Docker一択になりつつあるような気がしています。

初心者向けのローカル開発環境としては、Macの場合は、MAMP、Windowsの場合は、XAMPPが代表格だと思いますが、LAMP環境(Linux Apache MySQL PHP)の構築に置いてDockerは非常に優れていると思います。Macの場合は、特に簡単に導入できますので、ぜひ使ってみてください。

今回は、Dockerでローカル開発環境を用意する手順を実際に自分が使用している設定ファイルを使って紹介していこうと思います。ほぼ70%くらいの開発案件は、このDocker構成(ドキュメントルートの構造などは変更する場合はありますが)でやっています。 基本的にMacユーザー前提で進めていきますが、WindowsユーザーでもDocker環境さえ用意できていれば、おそらくそのまま行けるのではないかと思います。

Dockerを使うべき理由

筆者は、こんな理由でDockerを使っています。もっといろんな理由があるんですが、簡単に3つだけ上げておきます。

  1. 導入が簡単
  2. 起動が早い
  3. PHPなどのバージョンを気軽に変えられる

Dockerをインストールしよう

まずは、Dockerをインストールしましょう。他のツールだと、このステップから大変だったりしますが、簡単です。

以下のサイトからアプリケーションをダウンロードしてインストールするだけです!

最初にDocker Hubでユーザー登録をします。 ユーザー登録

ユーザー登録が完了したら、次のページからDocker for Desktopをダウンロードしてインストールします。 Docker ダウンロードページ

インストールできたら、Docker for Desktopを起動します。 Docker起動後、ターミナルで以下のコマンドを実行してバージョン情報が表示されれば、問題なく起動できています。

docker -v

これで、準備完了です!

docker-compose でLAMP環境を用意する

今回は、docker-composeを使用して、以下のサービスを立ち上げてLAMP環境を構築したいと思います。

  • Apache 2.4
  • PHP7.2 (php-fpm)
  • MariaDB 10.3
  • MailHog

MailHogは、直接LAMP環境とは関係ありませんが、そのままだとメール送信れないので、PHPから送信されるメールを確認できるツールを一緒に導入したいと思います。

MailHogに関しては、こちらの記事で詳しく書いているので、ご参照ください。 MailHog

docker-composeとは

Docker compose とは、複数のコンテナから成るサービスを構築・実行する手順を自動的にし、管理を容易にする機能です。
Docker compose では、compose ファイルを用意してコマンドを1 回実行することで、そのファイルから設定を読み込んですべてのコンテナサービスを起動することができます。
-- Docker compose ことはじめハンズオン - Qiitaより引用

簡潔に説明されているので、引用させていただきました。

docker-compose.ymlを用意する

まず、適当な作業用ディレクトリを作成します。ここでは、docker-sampleとします。作成したディレクトリの中に、次の内容のものをdocker-compose.ymlの名前で保存します。

version: ‘3’

services:
    apache:
        image: ‘bitnami/apache:2.4’
        container_name: apache_docker_sample
        working_dir: /application
        ports:
            - “80:8080”
            - “443:8443”
        volumes:
            - ./web_app/public_html:/app
            - ./apache_data:/vhosts
        depends_on:
            - mariadb
            - php-fpm

    #PHP
    php-fpm:
        build: ./php-fpm
        container_name: php-fpm_docker_sample
        working_dir: /application
        volumes:
            - ./web_app/public_html:/app
            - ./php-fpm/php-ini-overrides.ini:/etc/php.d/php-ini-overrides.ini

    #MARIADB
    mariadb:
        image: mariadb:10.3
        container_name: mariadb_docker_sample
        working_dir: /application
        hostname: 127.0.0.1
        ports:
            - “3307:3307”
        volumes:
            - .:/application
            - ./mysql-data:/var/lib/mysql
            - ./mariadb/my-overrider.cnf:/etc/mysql/my.cnf
        environment:
            - MYSQL_ROOT_PASSWORD=${DB_PASS}
            - MYSQL_DATABASE=${DB_DATABASE}
            - MYSQL_USER=${DB_USER}
            - MYSQL_PASSWORD=${DB_PASS}
        env_file:
            - .env
    #MailHog
    mailhog:
        image: mailhog/mailhog
        ports:
            - “8025:8025”
            - “1025:1025”

導入が簡単と言っておきながら、ややこしいように思えますが、最初は「こんな感じ」だというくらいに思っておくだけで大丈夫です。

設定ファイルのオプションなどを詳しく知りたい方は、以下のページに分かりやすく解説されていますので、参照してみてください。

複数のDockerコンテナを自動で立ち上げる構成管理ツール「Docker Compose」(Dockerの最新機能を使ってみよう:第7回) | さくらのナレッジ

各サービス用のディレクトリと設定ファイルを用意する

docker-compose.ymlを先ほど用意しましたが、その中で指定されている各サービスのデータ保存や設定ファイルを共有などに使用されるディレクトリを作成していきます。

apache_data

Apache用にapache_dataディレクトリを作成します。その中にhttps.confという名前で以下の内容のファイルを作成し、保存しておきます。

<VirtualHost _default_:8080>
  DocumentRoot “/app”
  <Directory “/app”>
    Options -Indexes +FollowSymLinks
    DirectoryIndex index.php
    AllowOverride All
    Require all granted
  </Directory>

  <FilesMatch \.php$>
    # 2.4.10+ can proxy to unix socket
    # SetHandler “proxy:unix:/var/run/php5-fpm.sock|fcgi://localhost/“

    # Else we can just use a tcp socket:
    SetHandler “proxy:fcgi://php-fpm:9000”
  </FilesMatch>

  # Error Documents
  ErrorDocument 503 /503.html

</VirtualHost>

mariadb

MariaDBの設定ファイルを保存しておくディレクトリを作成します。その中に、my-overrider.cnfという名前で以下の内容のファイルを作成し、保存しておきます。

※ ポートは、標準的な3306ではなく、3307に変更しています。

# MariaDB database server configuration file.
#
# You can copy this file to one of:
# - “/etc/mysql/my.cnf” to set global options,
# - “~/.my.cnf” to set user-specific options.
#
# One can use all long options that the program supports.
# Run program with —help to get a list of available options and with
# —print-defaults to see which it would actually understand and use.
#
# For explanations see
# http://dev.mysql.com/doc/mysql/en/server-system-variables.html

# This will be passed to all mysql clients
# It has been reported that passwords should be enclosed with ticks/quotes
# escpecially if they contain “#” chars…
# Remember to edit /etc/mysql/debian.cnf when changing the socket location.
[client]
port            = 3307
socket          = /var/run/mysqld/mysqld.sock

# Here is entries for some specific programs
# The following values assume you have at least 32M ram

# This was formally known as [safe_mysqld]. Both versions are currently parsed.
[mysqld_safe]
socket          = /var/run/mysqld/mysqld.sock
nice            = 0

[mysqld]
#
# * Basic Settings
#
#user           = mysql
pid-file        = /var/run/mysqld/mysqld.pid
socket          = /var/run/mysqld/mysqld.sock
port            = 3307
basedir         = /usr
datadir         = /var/lib/mysql
tmpdir          = /tmp
lc_messages_dir = /usr/share/mysql
lc_messages     = en_US
skip-external-locking
#
# Instead of skip-networking the default is now to listen only on
# localhost which is more compatible and is not less secure.
#bind-address           = 127.0.0.1
#
# * Fine Tuning
#
max_connections         = 100
connect_timeout         = 5
wait_timeout            = 600
max_allowed_packet      = 16M
thread_cache_size       = 128
sort_buffer_size        = 4M
bulk_insert_buffer_size = 16M
tmp_table_size          = 32M
max_heap_table_size     = 32M
#
# * MyISAM
#
# This replaces the startup script and checks MyISAM tables if needed
# the first time they are touched. On error, make copy and try a repair.
myisam_recover_options = BACKUP
key_buffer_size         = 128M
#open-files-limit       = 2000
table_open_cache        = 400
myisam_sort_buffer_size = 512M
concurrent_insert       = 2
read_buffer_size        = 2M
read_rnd_buffer_size    = 1M
#
# * Query Cache Configuration
#
# Cache only tiny result sets, so we can fit more in the query cache.
query_cache_limit               = 128K
query_cache_size                = 64M
# for more write intensive setups, set to DEMAND or OFF
#query_cache_type               = DEMAND
#
# * Logging and Replication
#
# Both location gets rotated by the cronjob.
# Be aware that this log type is a performance killer.
# As of 5.1 you can enable the log at runtime!
#general_log_file        = /var/log/mysql/mysql.log
#general_log             = 1
#
# Error logging goes to syslog due to /etc/mysql/conf.d/mysqld_safe_syslog.cnf.
#
# we do want to know about network errors and such
#log_warnings           = 2
#
# Enable the slow query log to see queries with especially long duration
#slow_query_log[={0|1}]
slow_query_log_file     = /var/log/mysql/mariadb-slow.log
long_query_time = 10
#log_slow_rate_limit    = 1000
#log_slow_verbosity     = query_plan

#log-queries-not-using-indexes
#log_slow_admin_statements
#
# The following can be used as easy to replay backup logs or for replication.
# note: if you are setting up a replication slave, see README.Debian about
#       other settings you may need to change.
#server-id              = 1
#report_host            = master1
#auto_increment_increment = 2
#auto_increment_offset  = 1
#log_bin                        = /var/log/mysql/mariadb-bin
#log_bin_index          = /var/log/mysql/mariadb-bin.index
# not fab for performance, but safer
#sync_binlog            = 1
expire_logs_days        = 10
max_binlog_size         = 100M
# slaves
#relay_log              = /var/log/mysql/relay-bin
#relay_log_index        = /var/log/mysql/relay-bin.index
#relay_log_info_file    = /var/log/mysql/relay-bin.info
#log_slave_updates
#read_only
#
# If applications support it, this stricter sql_mode prevents some
# mistakes like inserting invalid dates etc.
#sql_mode               = NO_ENGINE_SUBSTITUTION,TRADITIONAL
#
# * InnoDB
#
# InnoDB is enabled by default with a 10MB datafile in /var/lib/mysql/.
# Read the manual for more InnoDB related options. There are many!
default_storage_engine  = InnoDB
# you can't just change log file size, requires special procedure
#innodb_log_file_size   = 50M
innodb_buffer_pool_size = 256M
innodb_log_buffer_size  = 8M
innodb_file_per_table   = 1
innodb_open_files       = 400
innodb_io_capacity      = 400
innodb_flush_method     = O_DIRECT
#
# * Security Features
#
# Read the manual, too, if you want chroot!
# chroot = /var/lib/mysql/
#
# For generating SSL certificates I recommend the OpenSSL GUI “tinyca”.
#
# ssl-ca=/etc/mysql/cacert.pem
# ssl-cert=/etc/mysql/server-cert.pem
# ssl-key=/etc/mysql/server-key.pem

#
# * Galera-related settings
#
[galera]
# Mandatory settings
#wsrep_on=ON
#wsrep_provider=
#wsrep_cluster_address=
#binlog_format=row
#default_storage_engine=InnoDB
#innodb_autoinc_lock_mode=2
#
# Allow server to accept connections on all interfaces.
#
#bind-address=0.0.0.0
#
# Optional setting
#wsrep_slave_threads=1
#innodb_flush_log_at_trx_commit=0

[mysqldump]
quick
quote-names
max_allowed_packet      = 16M

[mysql]
#no-auto-rehash # faster start of mysql but no tab completion

[isamchk]
key_buffer              = 16M

#
# * IMPORTANT: Additional settings that can override those from this file!
#   The files must end with ‘.cnf’, otherwise they’ll be ignored.
#
!include /etc/mysql/mariadb.cnf
!includedir /etc/mysql/conf.d/

mysql-data

mysql-dataディレクトリは、MariaDBのデータが保存されるディレクトリです。空で良いので、ディレクトリだけ作成しておきます。

php-fpm

PHP用にphp-fpmの名前でディレクトリを作成します。その中に2つのファイルを作成します。

Dockerfile

配布されているイメージをそのまま使用すれば、良いのですが、MailHogと連携するために若干手を加えるため、以下の内容でDockerfileという名前のファイルを作成します。

FROM miveo/centos-php-fpm:7.2
WORKDIR “/application”

RUN curl -sSLO https://github.com/mailhog/mhsendmail/releases/download/v0.2.0/mhsendmail_linux_amd64 \
    && chmod +x mhsendmail_linux_amd64 \
    && mv mhsendmail_linux_amd64 /usr/local/bin/mhsendmail

CMD [“php-fpm”, “-F”]

EXPOSE 9000

設定ファイル

次にPHPの設定ファイルを作成します。以下の内容でphp-ini-overrides.iniの名前で保存しておきます。

upload_max_filesize = 100M
post_max_size = 108M
listen = 127.0.0.1:9000
listen.allowed_clients = 127.0.0.1
sendmail_path = “/usr/local/bin/mhsendmail —smtp-addr=mailhog:1025”

web_app

Apacheのドキュメントルートとしてweb_app/public_htmlを指定していますので、web_appを作成し、その中にpublic_htmlを作成します。 ここが、ドキュメントルートになるので、開発対象ファイルなどを設置する場所になるかと思います。フレームワークなどによりドキュメントルートの名称が、htmlpublicだったりする場合は、docker-compose.ymlの該当箇所を変更することで、柔軟に対応できます。

.env

最後に.envファイルです。これは、環境設定などを書くためのもので、今回の構成では、特に必要もないのですが、「こんな使い方ができる」というサンプル的な意味合いも含めて使うようにしています。

ここでは、MariaDBのデータベース名、ユーザー名、パスワードなどを記載します。.envの名前で以下の内容のファルを保存しておきます。

DB_DATABASE=docker_sample
DB_PASS=pass1234
DB_USER=docker

開発環境をコマンド一つで立ち上げる

諸々の準備ができたら、先ほど作成した作業ディレクトリであるdocker-sampleにターミナルを起動して移動します。

その後、以下のコマンドを実行すれば、各サービスが立ち上がりブラウザから localhost でアクセスすることができるようになるかと思います。 また、localhost:8025 にアクセスするとMailHogの画面が立ち上がり、PHPで送信されたメールを確認することができます。

docker-compose up -d

-dオプションを付与して実行すると、バックグラウンドで実行してくれます。 これを付与しないと、ターミナル上にログが表示されるようになります。

以下のような感じになれば、問題なく実行できているかと思います。

最後に・・・

今回のサンプルは、githubにアップしていますので、ダウンロードしてもらえれば、そのまま使用できるかと思います。

また、もしこの設定でWordPressを実行する場合は、データベースのホスト名は、127.0.0.1 ではなく、mariadb にします。

今回作成したサンプルは、以下のレポジトリーにアップしていますので、ご自由にご利用ください。

GitHub - docker-composeを使用したサンプル

For Every type of your business

開発やコンサルティングのご相談は、
お問い合わせフォームからお気軽に。