Laravel 5.6 Laravel Homestead

イントロダクションIntroduction

ローカル開発環境を含め、PHP開発全体を愉快なものにしようとLaravelは努力しています。Vagrantは、仮想マシンの管理と事前設定を行う、簡単でエレガントな手段を提供しています。Laravel strives to make the entire PHP development experience delightful, including your local development environment. Vagrant[https://www.vagrantup.com] provides a simple, elegant way to manage and provision Virtual Machines.

Laravel Homestead（入植農地、「ホームステード」）はパッケージを事前に済ませた、Laravel公式の"box"で、PHPやWebサーバ、その他のサーバソフトウェアをローカルマシンにインストールする必要なく、素晴らしい開発環境を準備できます。オペレーティングシステムでごちゃごちゃになる心配はもうありません！　Vagrant boxは完全に使い捨てできます。何かの調子が悪くなれば壊して、数分のうちにそのboxを再生成できます！Laravel Homestead is an official, pre-packaged Vagrant box that provides you a wonderful development environment without requiring you to install PHP, a web server, and any other server software on your local machine. No more worrying about messing up your operating system! Vagrant boxes are completely disposable. If something goes wrong, you can destroy and re-create the box in minutes!

HomesteadはWindowsやMac、Linuxシステム上で実行でき、Nginx WebサーバとPHP7.2、PHP7.1、PHP7.0、PHP5.6、MySQL、PostgreSQL、Redis、Memcached、Node、他にも素晴らしいLaravelアプリケーションを開発するために必要となるものすべてを含んでいます。Homestead runs on any Windows, Mac, or Linux system, and includes the Nginx web server, PHP 7.2, PHP 7.1, PHP 7.0, PHP 5.6, MySQL, PostgreSQL, Redis, Memcached, Node, and all of the other goodies you need to develop amazing Laravel applications.

Note: note Windowsを使用している場合は、ハードウェア仮想化(VT-x)を有効にする必要があります。通常、BIOSにより有効にできます。UEFI system上のHyper-Vを使用している場合は、VT-xへアクセスするため、さらにHyper-Vを無効にする必要があります。{note} If you are using Windows, you may need to enable hardware virtualization (VT-x). It can usually be enabled via your BIOS. If you are using Hyper-V on a UEFI system you may additionally need to disable Hyper-V in order to access VT-x.

含まれるソフトウェアIncluded Software

インストールと設定Installation & Setup

最初の段階First Steps

Homestead環境を起動する前にVagrantと共に、VirtualBox 5.2か、VMWare、Parallels、Hyper-Vをインストールする必要があります。全ソフトウェア共に簡単に使用できるビジュアルインストーラが、人気のあるオペレーティングシステム全てに用意されています。Before launching your Homestead environment, you must install VirtualBox 5.2[https://www.virtualbox.org/wiki/Downloads], VMWare[https://www.vmware.com], Parallels[https://www.parallels.com/products/desktop/] or Hyper-V[https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v] as well as Vagrant[https://www.vagrantup.com/downloads.html]. All of these software packages provide easy-to-use visual installers for all popular operating systems.

VMwareプロバイダを使用するには、VMware Fusion/WorkstationとVMware Vagrantプラグインを購入する必要があります。無料ではありませんが、VMwareが提供する共有フォルダは最初からよりスピーディーです。To use the VMware provider, you will need to purchase both VMware Fusion / Workstation and the VMware Vagrant plug-in[https://www.vagrantup.com/vmware]. Though it is not free, VMware can provide faster shared folder performance out of the box.

Parallelsプロバイダを使用するには、Parallels Vagrantプラグインをインストールする必要があります。これは無料です。To use the Parallels provider, you will need to install Parallels Vagrant plug-in[https://github.com/Parallels/vagrant-parallels]. It is free of charge.

Vagrantの制限のため、Hyper-Vプロバイダはすべてのネットワーク設定を無視します。Because of Vagrant limitations[https://www.vagrantup.com/docs/hyperv/limitations.html], The Hyper-V provider ignores all networking settings.

Homestead Vagrant BoxのインストールInstalling The Homestead Vagrant Box

VirtualBox/VMwareとVagrantをインストールし終えたら、laravel/homestead boxをVagrantへ追加するため次のコマンドを端末で実行する必要があります。boxをダウンロードし終えるまで、接続速度にもよりますが数分かかるでしょう。Once VirtualBox / VMware and Vagrant have been installed, you should add the laravel/homestead box to your Vagrant installation using the following command in your terminal. It will take a few minutes to download the box, depending on your Internet connection speed:

vagrant box add laravel/homestead

このコマンドが失敗する場合、Vagrantを更新する必要があります。If this command fails, make sure your Vagrant installation is up to date.

HomesteadのインストールInstalling Homestead

リポジトリをクローンし、Homesteadをインストールできます。自分の「ホーム」ディレクトリの中のHomesteadフォルダへリポジトリをクローンするのことは、自分のLaravel（とPHP）の全プロジェクトをホストしておくHomestead Boxを用意するのだと考えてください。You may install Homestead by cloning the repository. Consider cloning the repository into a Homestead folder within your "home" directory, as the Homestead box will serve as the host to all of your Laravel projects:

git clone https://github.com/laravel/homestead.git ~/Homestead

masterブランチは常に安定しているわけではないため、バージョンタグがついたHomesteadをチェックアウトすべきでしょう。最新の安定バージョンは、GitHubのリリースページで見つかります。You should check out a tagged version of Homestead since the master branch may not always be stable. You can find the latest stable version on the GitHub Release Page[https://github.com/laravel/homestead/releases]:

cd ~/Homestead

// クローンしたいリリースバージョン
git checkout v7.14.2

Homesteadリポジトリをクローンしたら、Homestead.yaml設定ファイルを生成するために、bash init.shコマンドをHomesteadディレクトリで実行します。Once you have cloned the Homestead repository, run the bash init.sh command from the Homestead directory to create the Homestead.yaml configuration file. The Homestead.yaml file will be placed in the Homestead directory:

// Mac / Linux...
bash init.sh

// Windows...
init.bat

Homestead設定Configuring Homestead

プロバイダの設定Setting Your Provider

Homestead.yamlファイル中のproviderキーは、Vagrantのプロバイダとして、virtualbox、vmware_fusion、vmware_workstation、parallels、hypervのどれを使用するかを指定します。使用するプロバイダの値を指定してください。The provider key in your Homestead.yaml file indicates which Vagrant provider should be used: virtualbox, vmware_fusion, vmware_workstation, parallels or hyperv. You may set this to the provider you prefer:

provider: virtualbox

共有フォルダの設定Configuring Shared Folders

Homestead.yamlファイルのfoldersプロパティには、Homestead環境と共有したい全フォルダがリストされています。これらのフォルダの中のファイルが変更されると、ローカルマシンとHomestead環境との間で同期されます。必要なだけ共有フォルダを設定してください！The folders property of the Homestead.yaml file lists all of the folders you wish to share with your Homestead environment. As files within these folders are changed, they will be kept in sync between your local machine and the Homestead environment. You may configure as many shared folders as necessary:

folders:
    - map: ~/code
      to: /home/vagrant/code

少数のサイトを作るだけなら、この包括的なマッピングは上手く動作します。しかし、多くのサイトが継続的に成長していくに連れ、パフォーマンスの問題が発生してきます。この問題はとても大きいファイルを含むローエンドのマシンやプロジェクトで、悲痛なほど顕著に現れます。この問題が起きたら、全プロジェクトを自身のVagrantフォルダにマップしてください。If you are only creating a few sites, this generic mapping will work just fine. However, as the number of sites continue to grow, you may begin to experience performance problems. This problem can be painfully apparent on low-end machines or projects that contain a very large number of files. If you are experiencing this issue, try mapping every project to its own Vagrant folder:

folders:
    - map: ~/code/project1
      to: /home/vagrant/code/project1

    - map: ~/code/project2
      to: /home/vagrant/code/project2

NFSを有効にするには、同期するフォルダにフラグを指定するだけです。To enable NFS[https://www.vagrantup.com/docs/synced-folders/nfs.html], you only need to add a simple flag to your synced folder configuration:

folders:
    - map: ~/code
      to: /home/vagrant/code
      type: "nfs"

Note: note NFSを使用する場合は、vagrant-bindfsプラグインのインストールを考慮してください。このプラグインは、Homestead下のファイルとディレクトリのユーザー／グループパーミッションを正しく維持します。{note} When using NFS, you should consider installing the vagrant-bindfs[https://github.com/gael-ian/vagrant-bindfs] plug-in. This plug-in will maintain the correct user / group permissions for files and directories within the Homestead box.

さらに、Vagrantの同期フォルダでサポートされている任意のオプションを、optionsキーの下に列挙して渡すことができます。You may also pass any options supported by Vagrant's Synced Folders[https://www.vagrantup.com/docs/synced-folders/basic_usage.html] by listing them under the options key:

folders:
    - map: ~/code
      to: /home/vagrant/code
      type: "rsync"
      options:
          rsync__args: ["--verbose", "--archive", "--delete", "-zz"]
          rsync__exclude: ["node_modules"]

Nginxサイトの設定Configuring Nginx Sites

Nginxには詳しくない？　問題ありません。sitesプロパティでHomestead環境上のフォルダと「ドメイン」を簡単にマップできます。サイト設定のサンプルは、Homestead.yamlファイルに含まれています。これも必要に応じ、Homestead環境へサイトを好きなだけ追加してください。便利に使えるように、Homesteadは皆さんが作業する全てのLaravelプロジェクトの仮想環境を提供します。Not familiar with Nginx? No problem. The sites property allows you to easily map a "domain" to a folder on your Homestead environment. A sample site configuration is included in the Homestead.yaml file. Again, you may add as many sites to your Homestead environment as necessary. Homestead can serve as a convenient, virtualized environment for every Laravel project you are working on:

sites:
    - map: homestead.test
      to: /home/vagrant/code/Laravel/public

sitesプロパティをHomestead boxのプロビジョニング後に変更した場合、仮想マシンのNginx設定を更新するため、vagrant reload --provisionを再実行する必要があります。If you change the sites property after provisioning the Homestead box, you should re-run vagrant reload --provision to update the Nginx configuration on the virtual machine.

hostsファイルThe Hosts File

Nginxサイトの"domains"に追加したサイトをあなたのコンピューターのhostsファイルにも追加してください。hostsファイルはローカルドメインへのリクエストをHomestead環境へ転送してくれます。MacとLinuxでは、/etc/hostsにこのファイルがあります。Windows環境では、C:\Windows\System32\drivers\etc\hostsです。次の行のように追加してください。You must add the "domains" for your Nginx sites to the hosts file on your machine. The hosts file will redirect requests for your Homestead sites into your Homestead machine. On Mac and Linux, this file is located at /etc/hosts. On Windows, it is located at C:\Windows\System32\drivers\etc\hosts. The lines you add to this file will look like the following:

192.168.10.10  homestead.test

設定するIPアドレスにはHomestead.yamlファイルの中の値を確実に指定してください。ドメインをhostsファイルへ追加したら、Webブラウザーでサイトにアクセスできます。Make sure the IP address listed is the one set in your Homestead.yaml file. Once you have added the domain to your hosts file and launched the Vagrant box you will be able to access the site via your web browser:

http://homestead.test

Vagrant Boxの実行Launching The Vagrant Box

Homestead.yamlのリンクを編集終えたら、Homesteadディレクトリでvagrant upコマンドを実行してください。Vagrantは仮想マシンを起動し、共有フォルダとNginxサイトを自動的に設定します。Once you have edited the Homestead.yaml to your liking, run the vagrant up command from your Homestead directory. Vagrant will boot the virtual machine and automatically configure your shared folders and Nginx sites.

仮想マシンを破壊するには、vagrant destroy --forceコマンドを使用します。To destroy the machine, you may use the vagrant destroy --force command.

プロジェクトごとにインストールPer Project Installation

Homesteadをグローバルにインストールし、全プロジェクトで同じHomestead Boxを共有する代わりに、Homesteadインスタンスを管理下のプロジェクトごとに設定することもできます。プロジェクトごとにHomesteadをインストールする利点は、Vagrantfileをプロジェクトに用意すれば、プロジェクトに参加している他の人達も、vagrant upで仕事にとりかかれることです。Instead of installing Homestead globally and sharing the same Homestead box across all of your projects, you may instead configure a Homestead instance for each project you manage. Installing Homestead per project may be beneficial if you wish to ship a Vagrantfile with your project, allowing others working on the project to vagrant up.

Homesteadをプロジェクトに直接インストールするには、Composerを使います。To install Homestead directly into your project, require it using Composer:

composer require laravel/homestead --dev

Homesteadがインストールできたら、VagrantfileとHomestead.yamlファイルをプロジェクトルートへ生成するためにmakeコマンドを使ってください。makeコマンドはHomestead.yamlファイルのsitesとfoldersディレクティブを自動的に設定します。Once Homestead has been installed, use the make command to generate the Vagrantfile and Homestead.yaml file in your project root. The make command will automatically configure the sites and folders directives in the Homestead.yaml file.

Mac / Linux:Mac / Linux:

php vendor/bin/homestead make

Windows:Windows:

vendor\bin\homestead make

次にvagrant upコマンドを端末で実行し、ブラウザでhttp://homestead.testのプロジェクトへアクセスしてください。/etc/hostsファイルにhomestead.testか、自分で選んだドメインのエントリーを追加する必要があることを忘れないでください。Next, run the vagrant up command in your terminal and access your project at http://homestead.test in your browser. Remember, you will still need to add an /etc/hosts file entry for homestead.test or the domain of your choice.

MariaDBのインストールInstalling MariaDB

MySQLの代わりにMariaDBを使用したい場合は、mariadbオプションをHomestead.yamlファイルへ追加してください。このオプションはMySQLを削除し、MariaDBをインストールします。MariaDBはMySQLとそのまま置き換えられる代用ソフトウェアですので、mysqlデータベースドライバをそのままアプリケーションで使用できます。If you prefer to use MariaDB instead of MySQL, you may add the mariadb option to your Homestead.yaml file. This option will remove MySQL and install MariaDB. MariaDB serves as a drop-in replacement for MySQL so you should still use the mysql database driver in your application's database configuration:

box: laravel/homestead
ip: "192.168.10.10"
memory: 2048
cpus: 4
provider: virtualbox
mariadb: true

Installing MongoDBInstalling MongoDB

MongoDBのコミュニティエディションをインストールするには、以下のようにHomestead.yamlファイルを変更してください。To install MongoDB Community Edition, update your Homestead.yaml file with the following configuration option:

mongodb: true

デフォルト状態のMongoDBでは、データベースのユーザー名をhomestead、パスワードをsecretに設定します。The default MongoDB installation will set the database username to homestead and the corresponding password to secret.

ElasticsearchのインストールInstalling Elasticsearch

Elasticsearchをインストールするには、Homestead.yamlファイルへelasticsearchオプションを追加し、メジャーバージョンか、major.minor.patch形式で厳密なバージョンを指定してください。デフォルトのインストールでは、homesteadという名前のクラスタが作成されます。Elasticsearchにオペレーティングシステムのメモリの半分以上を割り当ててはいけません。つまり、Elasticsearchに割り当てる量の最低でも２倍以上のメモリをHomesteadマシンに割り当てます。To install Elasticsearch, add the elasticsearch option to your Homestead.yaml file and specify a supported version, which may be a major version or an exact version number (major.minor.patch). The default installation will create a cluster named 'homestead'. You should never give Elasticsearch more than half of the operating system's memory, so make sure your Homestead machine has at least twice the Elasticsearch allocation:

box: laravel/homestead
ip: "192.168.10.10"
memory: 4096
cpus: 4
provider: virtualbox
elasticsearch: 6

lightbulb">Tip!! 設定のカスタマイズについては、Elasticsearchのドキュメントを確認してください。{tip} Check out the Elasticsearch documentation[https://www.elastic.co/guide/en/elasticsearch/reference/current] to learn how to customize your configuration.

Neo4jのインストールInstalling Neo4j

Neo4jはグラフデータベース管理システムです。Neo4jコミュニティエディションをインストールするには、Homestead.yamlで以下の設定オプションを指定してください。Neo4j[https://neo4j.com/] is a graph database management system. To install Neo4j Community Edition, update your Homestead.yaml file with the following configuration option:

neo4j: true

デフォルト状態のNeo4jでは、データベースのユーザー名をhomestead、パスワードをsecretとして設定します。Neo4jブラウザにアクセスするには、Webブラウザでhttp://homestead.test:7474にアクセスしてください。Neo4jクライアントのために、7687 (Bolt)、7474 (HTTP)、7473 (HTTPS)ポートが用意されています。The default Neo4j installation will set the database username to homestead and corresponding password to secret. To access the Neo4j browser, visit http://homestead.test:7474 via your web browser. The ports 7687 (Bolt), 7474 (HTTP), and 7473 (HTTPS) are ready to serve requests from the Neo4j client.

エイリアスAliases

HomesteadでBashのエイリアスを指定するには、Homesteadディレクトリにある aliases ファイルを編集します。You may add Bash aliases to your Homestead machine by modifying the aliases file within your Homestead directory:

alias c='clear'
alias ..='cd ..'

aliasesファイルを更新した後に、vagrant reload --provisionコマンドを使い、Homesteadを再度プロヴィジョニングする必要があります。これにより新しいエイリアスを使うことができます。After you have updated the aliases file, you should re-provision the Homestead machine using the vagrant reload --provision command. This will ensure that your new aliases are available on the machine.

使用方法Daily Usage

HomesteadへグローバルにアクセスするAccessing Homestead Globally

MacとLinuxシステムでは、Bashプロファイルへ簡単なBash関数を追加すれば実現できます。Windowsでは、PATHに「バッチ」ファイルを追加すれば、行えます。以下のスクリプトはシステムのどこからでも、どんなVagrantコマンドでも実行できるようにし、自動的にHomesteadをインストール済みのディレクトリで実行します。Sometimes you may want to vagrant up your Homestead machine from anywhere on your filesystem. You can do this on Mac / Linux systems by adding a Bash function to your Bash profile. On Windows, you may accomplish this by adding a "batch" file to your PATH. These scripts will allow you to run any Vagrant command from anywhere on your system and will automatically point that command to your Homestead installation:

Mac / LinuxMac / Linux

function homestead() {
    ( cd ~/Homestead && vagrant $* )
}

エイリアス中の~/Homesteadパスを実際のHomesteadインストール場所を示すように調整してください。関数がインストールできたら、システムのどこからでもhomestead upやhomestead sshのように実行できます。Make sure to tweak the ~/Homestead path in the function to the location of your actual Homestead installation. Once the function is installed, you may run commands like homestead up or homestead ssh from anywhere on your system.

WindowsWindows

以下の内容のhomestead.batバッチファイルを、マシン上に作成してください。Create a homestead.bat batch file anywhere on your machine with the following contents:

@echo off

set cwd=%cd%
set homesteadVagrant=C:\Homestead

cd /d %homesteadVagrant% && vagrant %*
cd /d %cwd%

set cwd=
set homesteadVagrant=

スクリプト例中のC:\Homesteadパスは、実際にHomesteadをインストールした場所を指すように調整してください。ファイルを作成したら、PATHへファイルの場所を追加します。これでhomestead upやhomestead sshのようなコマンドをシステムのどこからでも実行できます。Make sure to tweak the example C:\Homestead path in the script to the actual location of your Homestead installation. After creating the file, add the file location to your PATH. You may then run commands like homestead up or homestead ssh from anywhere on your system.

SSH接続Connecting Via SSH

Homesteadディレクトリでvagrant ssh端末コマンドを実行すれば、仮想マシンにSSHで接続できます。You can SSH into your virtual machine by issuing the vagrant ssh terminal command from your Homestead directory.

しかし、Homesteadマシンには頻繁にSSHでアクセスする必要があると思いますから、ホストマシンから素早くHomestead boxへSSH接続できるように、上記の「関数」を追加することを検討してください。But, since you will probably need to SSH into your Homestead machine frequently, consider adding the "function" described above to your host machine to quickly SSH into the Homestead box.

データベースへの接続Connecting To Databases

homesteadのデータベースは、初めからMySQLとPostgreSQLの両方を設定できます。更に便利なように、Laravelの.envファイルは、Laravelでこれらのデータベースが最初から利用できるように設定されています。A homestead database is configured for both MySQL and PostgreSQL out of the box. For even more convenience, Laravel's .env file configures the framework to use this database out of the box.

ホストマシンのデータベースクライアントから、MySQLかPostgreSQLデータベースへ接続するには、127.0.0.1のポート33060(MySQL)か、ポート54320(PostgreSQL)へ接続する必要があります。ユーザー名はhomestead、パスワードはsecretです。To connect to your MySQL or PostgreSQL database from your host machine's database client, you should connect to 127.0.0.1 and port 33060 (MySQL) or 54320 (PostgreSQL). The username and password for both databases is homestead / secret.

Note: note ホストマシンからデータベースへ接続するには、標準的ではないポートだけを使用してください。Laravelのデータベース設定ファイル中では、デフォルトの3306と5432ポートを使用することができます。Laravelは仮想マシンの内部で動作しているからです。{note} You should only use these non-standard ports when connecting to the databases from your host machine. You will use the default 3306 and 5432 ports in your Laravel database configuration file since Laravel is running within the virtual machine.

データベースのバックアップDatabase Backups

Homesteadでは、Vagrant boxを壊した時点で、自動的にデータベースをバックアップできます。この機能を利用するには、Vagrant2.1.0以上を使用しなくてはなりません。もしくは、古いバージョンのVagrantを使用している場合は、vagrant-triggersプラグインをインストールしてください。自動データベースバックアップを有効にするには、Homestead.yamlファイルに以下の行を追加してください。Homestead can automatically backup your database when your Vagrant box is destroyed. To utilize this feature, you must be using Vagrant 2.1.0 or greater. Or, if you are using an older version of Vagrant, you must install the vagrant-triggers plug-in. To enable automatic database backups, add the following line to your Homestead.yaml file:

backup: true

一度設定すれば、Homesteadはvagrant destroyコマンドが実行されると、データベースをmysql_backup、postgres_backupディレクトリへエクスポートします。これらのディレクトリは、Homesteadをクローンしたフォルダ中、もしくはプロジェクトごとのインストールを利用している場合は、プロジェクトルートの中で見つけられます。Once configured, Homestead will export your databases to mysql_backup and postgres_backup directories when the vagrant destroy command is executed. These directories can be found in the folder where you cloned Homestead or in the root of your project if you are using the per project installation[#per-project-installation] method.

サイトの追加Adding Additional Sites

Homestead環境をプロビジョニングし、実働した後に、LaravelアプリケーションをNginxサイトへ追加したいこともあるでしょう。希望するだけのLaravelアプリケーションを一つのHomestead環境上で実行することができます。新しいサイトを追加するには、Homestead.yamlファイルへ追加します。Once your Homestead environment is provisioned and running, you may want to add additional Nginx sites for your Laravel applications. You can run as many Laravel installations as you wish on a single Homestead environment. To add an additional site, add the site to your Homestead.yaml file:

sites:
    - map: homestead.test
      to: /home/vagrant/code/Laravel/public
    - map: another.test
      to: /home/vagrant/code/another/public

Vagrantが"hosts"ファイルを自動的に管理しない場合は、新しいサイトを追加する必要があります。If Vagrant is not automatically managing your "hosts" file, you may need to add the new site to that file as well:

192.168.10.10  homestead.test
192.168.10.10  another.test

サイトを追加したら、vagrant reload --provisionコマンドをHomesteadディレクトリで実行します。Once the site has been added, run the vagrant reload --provision command from your Homestead directory.

サイトタイプSite Types

Laravelベースではないプロジェクトも簡単に実行できるようにするため、Homesteadは様々なタイプのサイトをサポートしています。たとえば、symfony2サイトタイプを使えば、HomesteadにSymfonyアプリケーションを簡単に追加できます。Homestead supports several types of sites which allow you to easily run projects that are not based on Laravel. For example, we may easily add a Symfony application to Homestead using the symfony2 site type:

sites:
    - map: symfony2.test
      to: /home/vagrant/code/Symfony/web
      type: "symfony2"

指定できるサイトタイプはapache、apigility、expressive、laravel（デフォルト）、proxy、silverstripe、statamic、symfony2、symfony4、zfです。The available site types are: apache, apigility, expressive, laravel (the default), proxy, silverstripe, statamic, symfony2, symfony4, and zf.

サイトパラメータSite Parameters

paramsサイトディレクティブを使用し、Nginxのfastcgi_param値を追加できます。例として、値にBARを持つFOOパラメータを追加してみましょう。You may add additional Nginx fastcgi_param values to your site via the params site directive. For example, we'll add a FOO parameter with a value of BAR:

sites:
    - map: homestead.test
      to: /home/vagrant/code/Laravel/public
      params:
          - key: FOO
            value: BAR

環境変数Environment Variables

グローバルな環境変数は、Homestead.yamlファイルで追加指定できます。You can set global environment variables by adding them to your Homestead.yaml file:

variables:
    - key: APP_ENV
      value: local
    - key: FOO
      value: bar

Homestead.yamlを変更したら、vagrant reload --provisionを実行し、再プロビジョンするのを忘れないでください。これにより全インストール済みPHPバージョンに対するPHP-FPM設定と、vagrantユーザーの環境も更新されます。After updating the Homestead.yaml, be sure to re-provision the machine by running vagrant reload --provision. This will update the PHP-FPM configuration for all of the installed PHP versions and also update the environment for the vagrant user.

Cronスケジュール設定Configuring Cron Schedules

schedule:run Artisanコマンドだけを毎分実行することにより、Cronジョブのスケジュールを簡単に行う方法をLaravelは提供しています。schedule:runコマンドはApp\Console\Kernelクラスの定義を調べ、どのジョブを実行すべきかを決定します。Laravel provides a convenient way to schedule Cron jobs[/docs/{{version}}/scheduling] by scheduling a single schedule:run Artisan command to be run every minute. The schedule:run command will examine the job schedule defined in your App\Console\Kernel class to determine which jobs should be run.

Homesteadサイトでschedule:runコマンドを実行したい場合は、サイトを定義するときにscheduleオプションをtrueに設定してください。If you would like the schedule:run command to be run for a Homestead site, you may set the schedule option to true when defining the site:

sites:
    - map: homestead.test
      to: /home/vagrant/code/Laravel/public
      schedule: true

こうしたサイト用のCronジョブは、仮想マシンの/etc/cron.dフォルダの中に定義されます。The Cron job for the site will be defined in the /etc/cron.d folder of the virtual machine.

Mailhogの設定Configuring Mailhog

Mailhogを使用すると、簡単に送信するメールを捉えることができ、受信者に実際に届けなくとも内容を調べることができます。これを使用するには、.envファイルのメール設定を以下のように更新します。Mailhog allows you to easily catch your outgoing email and examine it without actually sending the mail to its recipients. To get started, update your .env file to use the following mail settings:

MAIL_DRIVER=smtp
MAIL_HOST=localhost
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

Minioの設定Configuring Minio

MinioはAmazon S3と互換性のあるAPIを持つ、オープンソースなオブジェクトストレージサーバです。Minioをインストールするには、Homestead.yamlに以下の設定オプションを加えてください。Minio is an open source object storage server with an Amazon S3 compatible API. To install Minio, update your Homestead.yaml file with the following configuration option:

minio: true

デフォルトのMinioは、9600ポートで使用します。http://homestead:9600/を閲覧すると、Minioのコントロールパネルへアクセスできます。デフォルトアクセスキーはhomestead、デフォルトのシークレットキーはsecretkeyです。Minioへアクセスする場合、常にリージョンus-east-1を使用する必要があります。By default, Minio is available on port 9600. You may access the Minio control panel by visiting http://homestead:9600/. The default access key is homestead, while the default secret key is secretkey. When accessing Minio, you should always use region us-east-1.

Minioを使用するために、config/filesystems.php設定ファイルの中の、S3ディスク設定を調整する必要があります。ディスク設定へ、use_path_style_endpointオプションを追加し、同時にurlキーをendpointへ変更する必要があります。In order to use Minio you will need to adjust the S3 disk configuration in your config/filesystems.php configuration file. You will need to add the use_path_style_endpoint option to the disk configuration, as well as change the url key to endpoint:

's3' => [
    'driver' => 's3',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION'),
    'bucket' => env('AWS_BUCKET'),
    'endpoint' => env('AWS_URL'),
    'use_path_style_endpoint' => true
]

最後に、.envファイルへ以下のオプションを確実に用意してください。Finally, ensure your .env file has the following options:

AWS_ACCESS_KEY_ID=homestead
AWS_SECRET_ACCESS_KEY=secretkey
AWS_DEFAULT_REGION=us-east-1
AWS_URL=http://homestead:9600

ポートPorts

以下のポートが、Homestead環境へポートフォワードされています。By default, the following ports are forwarded to your Homestead environment:

追加のフォワードポートForwarding Additional Ports

ご希望ならば追加のポートをVagrant Boxへフォワードすることもできます。プロトコルを指定することもできます。If you wish, you may forward additional ports to the Vagrant box, as well as specify their protocol:

ports:
    - send: 50000
      to: 5000
    - send: 7777
      to: 777
      protocol: udp

環境の共有Sharing Your Environment

共同作業者やクライアントと、現在作業中の内容を共有したい場合もあるでしょう。Vagrantには、vagrant shareにより、これをサポートする方法が組み込み済みです。しかし、この方法はHomestead.yamlファイルに複数サイトを設定している場合には動作しません。Sometimes you may wish to share what you're currently working on with coworkers or a client. Vagrant has a built-in way to support this via vagrant share; however, this will not work if you have multiple sites configured in your Homestead.yaml file.

この問題を解決するため、Homesteadは独自のshareコマンドを持っています。使用を開始するには、vagrant sshによりHomesteadマシンとSSH接続し、share homestead.testを実行してください。これにより、Homestead.yaml設定ファイルのhomestead.testサイトが共有されます。もちろん、homestead.testの代わりに他の設定済みサイトを指定できます。To solve this problem, Homestead includes its own share command. To get started, SSH into your Homestead machine via vagrant ssh and run share homestead.test. This will share the homestead.test site from your Homestead.yaml configuration file. Of course, you may substitute any of your other configured sites for homestead.test:

share homestead.test

コマンド実行後、ログと共有サイトへアクセスするURLを含んだ、Ngrokスクリーンが現れます。カスタムリージョン、サブドメイン、その他のNgrok実行オプションをカスタマイズしたい場合は、shareコマンドへ追加してください。After running the command, you will see an Ngrok screen appear which contains the activity log and the publicly accessible URLs for the shared site. If you would like to specify a custom region, subdomain, or other Ngrok runtime option, you may add them to your share command:

share homestead.test -region=eu -subdomain=laravel

Note: note Vagrantは本質的に安全なものではなく、shareコマンドによりインターネット上に自分の仮想マシンを晒すことになることを覚えておいてください。{note} Remember, Vagrant is inherently insecure and you are exposing your virtual machine to the Internet when running the share command.

複数のPHPバージョンMultiple PHP Versions

Note: note この機能は、Nginx使用時のみ利用できます。{note} This feature is only compatible with Nginx.

Homestead6から、同一仮想マシン上での複数PHPバージョンをサポートを開始しました。Homestead.yamlファイルで、特定のサイトでどのバージョンのPHPを使用するのかを指定できます。利用できるPHPバージョンは、"5.6"、"7.0"、"7.1"、"7.2（デフォルト）"です。Homestead 6 introduced support for multiple versions of PHP on the same virtual machine. You may specify which version of PHP to use for a given site within your Homestead.yaml file. The available PHP versions are: "5.6", "7.0", "7.1" and "7.2" (the default):

sites:
    - map: homestead.test
      to: /home/vagrant/code/Laravel/public
      php: "5.6"

さらに、コマンドラインではサポート済みPHPバージョンをすべて利用できます。In addition, you may use any of the supported PHP versions via the CLI:

php5.6 artisan list
php7.0 artisan list
php7.1 artisan list
php7.2 artisan list

WebサービスWeb Servers

HomesteadはNginxをデフォルトのWebサーバとして利用しています。しかし、サイトタイプとしてapacheが指定されると、Apacheをインストールします。両方のWebサーバを一度にインストールすることもできますが、同時に両方を実行することはできません。flipシェルコマンドがWebサーバを切り替えるために用意されています。flipコマンドはどちらのWebサーバが実行中かを自動的に判断し、シャットダウンし、もう一方のWebサーバを起動します。このコマンドを実行するには、HomesteadへSSH接続し、コマンドをターミナルで実行してください。Homestead uses the Nginx web server by default. However, it can install Apache if apache is specified as a site type. While both web servers can be installed at the same time, they cannot both be running at the same time. The flip shell command is available to ease the process of switching between web servers. The flip command automatically determines which web server is running, shuts it off, and then starts the other server. To use this command, SSH into your Homestead machine and run the command in your terminal:

flip

MailMail

Homesteadは、デフォルトで1025ポートをリッスンする、Postfixメールトランスファーエージェントを用意しています。そのため、localhostの1025ポートに対して、smtpメールドライバーを使用するように、アプリケーションへ指示できます。その結果、すべての送信メールはPostfixにより処理され、Mailhogにより補足されます。送信済みメールを確認するには、Webブラウザでhttp://localhost:8025を開いてください。Homestead includes the Postfix mail transfer agent, which is listening on port 1025 by default. So, you may instruct your application to use the smtp mail driver on localhost port 1025. Then, all sent mail will be handled by Postfix and caught by Mailhog. To view your sent emails, open http://localhost:8025[http://localhost:8025] in your web browser.

ネットワークインターフェイスNetwork Interfaces

Homestead.yamlファイルのnetworkプロパティは、Homestead環境のネットワークインターフェイスを設定します。多くのインターフェイスを必要に応じ設定可能です。The networks property of the Homestead.yaml configures network interfaces for your Homestead environment. You may configure as many interfaces as necessary:

networks:
    - type: "private_network"
      ip: "192.168.10.20"

ブリッジインターフェイスを有効にするには、bridge項目を設定し、ネットワークタイプをpublic_networkへ変更します。To enable a bridged[https://www.vagrantup.com/docs/networking/public_network.html] interface, configure a bridge setting and change the network type to public_network:

networks:
    - type: "public_network"
      ip: "192.168.10.20"
      bridge: "en1: Wi-Fi (AirPort)"

DHCPを有効にするには、設定からipオプションを取り除いてください。To enable DHCP[https://www.vagrantup.com/docs/networking/public_network.html], just remove the ip option from your configuration:

networks:
    - type: "public_network"
      bridge: "en1: Wi-Fi (AirPort)"

Homesteadの更新Updating Homestead

２つの簡単な手順で、Homesteadをアップデートできます。最初にvagrant box updateコマンドを使い、Vagrant boxを更新してください。You can update Homestead in two simple steps. First, you should update the Vagrant box using the vagrant box update command:

vagrant box update

次に、Homesteadのソースコードを更新する必要があります。リポジトリをクローンしている場合は、リポジトリをクローンした元の場所で、git pull origin masterを実行するだけです。Next, you need to update the Homestead source code. If you cloned the repository you can git pull origin master at the location you originally cloned the repository.

プロジェクトのcomposer.jsonファイルによりHomesteadをインストールしている場合は、composer.jsonファイルに"laravel/homestead": "^7"が含まれていることを確認し、依存コンポーネントをアップデートしてください。If you have installed Homestead via your project's composer.json file, you should ensure your composer.json file contains "laravel/homestead": "^7" and update your dependencies:

composer update

プロパイダ固有の設定Provider Specific Settings

VirtualBoxVirtualBox

natdnshostresolvernatdnshostresolver

デフォルトのHomestead設定は、natdnshostresolver設定をonにしています。これにより、HomesteadはホストのオペレーティングシステムのDNS設定を利用します。この動作をオーバーライドしたい場合は、Homestead.yamlへ以下の行を追加してください。By default, Homestead configures the natdnshostresolver setting to on. This allows Homestead to use your host operating system's DNS settings. If you would like to override this behavior, add the following lines to your Homestead.yaml file:

provider: virtualbox
natdnshostresolver: off

WindowsでのシンボリックリンクSymbolic Links On Windows

Windowsマシンでシンボリックリンクが正しく動かない場合は、Vagrantfileに以下のコードブロックを追加する必要があります。If symbolic links are not working properly on your Windows machine, you may need to add the following block to your Vagrantfile:

config.vm.provider "virtualbox" do |v|
    v.customize ["setextradata", :id, "VBoxInternal2/SharedFoldersEnableSymlinksCreate/v-root", "1"]
end