Getting-started.md

セットアップ

プロジェクトにRocketeerをインストールするのはとても簡単です。以下のいずれかの方法でインストールできます。

コンパイル済みのアーカイブを使う方法

最も簡単な方法は、以下のアドレスからアーカイブをダウンロードしてアプリケーションのフォルダに入れることです。

もしくは、以下のコマンドを実行して、グローバル環境にインストールすれば、グローバルなコマンドとしてどこのフォルダでもrocketeerコマンドを使うことができるようになります。

$ wget http://rocketeer.autopergamene.eu/versions/rocketeer.phar
$ chmod +x rocketeer.phar
$ mv rocketeer.phar /usr/local/bin/rocketeer

あとは、ただ、rocketeer igniteと打ち込むだけです。セットアップするために必要ないくつもの質問が聞かれます。あとはうまくいくはずです。

Composerを使う方法

ローカル環境へ

Rocketeerは、Composerで他のパッケージと同じようにインストールできます。

$ composer require anahkiasen/rocketeer
$ php vendor/bin/rocketeer ignite

これだけです。下で説明する設定ファイルが、yourapp/.rocketeer/ の下に作成されます。

Rocketeerのコマンドにアクセスするには、php vendor/bin/rocketeerを使うか、これをalias rocketeer=php vendor/bin/rocketeerとエイリアスしておきます。ローカルのバイナリにいつでもアクセスできるようにvendor/binを_PATH_に追加しておくのでもよいでしょう。

グローバル環境へ

すべての Composer パッケージと同じように、globalを付与することで、Rocketeerをグローバル環境へインストールすることもできます。

$ composer global require anahkiasen/rocketeer
$ rocketeer ignite

設定

Roketeerのほとんどの設定は、.rocketeerフォルダの中の設定ファイルで行います。 設定ファイルには多くのオプションがあります。各オプションには説明が記載されていますのでコメントを注意して読んでください。

Rocketeer を使う

もし、アーカイブを使っている場合には、コマンドにアクセスするために、php rocketeer.pharと打ち込む必要があります。例ごとにphp rocketeer.phar deployというようにです。グローバルにインストールしている場合には、rocketeer deployと打てます。

設定を終えたら、php rocketeer.phar checkコマンドを実行することをおすすめします。これはサーバー上でいくつものコマンドを実行し、設定がアプリケーションを収容する準備が整っているかどうかをチェックします。

続いて、php rocketeer.phar deployと打ち込むと、最初のリリースがリモートサーバーに作成されます。 その後、新しいリリースを作成したら、同じコマンドを実行することで、アップデートができます。または単純にリポジトリと依存パッケージがアップデートされるphp rocketeer.phar updateを実行することでもアップデート可能です。

フォルダ構成

Rocketeer は、現在いるフォルダにある固有の設定ファイルを認識します。tasks.phpと、event.phpについても同様です。したがって以下のように構成するとよいでしょう。

| .rocketeer
| -- config.php
| -- hooks.php
| -- paths.php
| -- remote.php
| -- scm.php
| -- stages.php
| -- events.php
| -- tasks.php
| rocketeer.phar
| index.php
| public
| etc.