kohkimakimoto/altax

Altax is an extensible deployment tool for PHP.

v3.0.17 2017-11-21 03:31 UTC

Requires

• php: >=5.3.0
• composer/composer: 1.0.*@dev
• phpseclib/phpseclib: 2.0.6
• symfony/console: 2.5.*
• symfony/filesystem: 2.5.*
• symfony/finder: 2.5.*
• symfony/process: 2.5.*
• symfony/yaml: 2.5.*

Requires (Dev)

• phpunit/phpunit: 3.*
• satooshi/php-coveralls: dev-master

Apache-2.0

• Kohki Makimoto

• deploy
• ssh
• deployment
• altax

README

Altax is a deployment tool for PHP. I designed it as a command-line tool for running tasks to remote servers like the Capistrano, Fabric and Cinamon. It also has a plugin mechanism for managing and installing tasks easily.

This is a simple git deploy task definition. You can write any tasks in PHP.

// Register managed nodes to a role.
Server::node("web1.example.com", "web");
Server::node("web2.example.com", "web");
Server::node("db1.example.com",  "db");

// Register a task.
Task::register("deploy", function($task){

    $appDir = "/path/to/app";

    // Execute parallel processes for each nodes.
    $task->exec(function($process) use ($appDir){

        // Run a command remotely and get a return code.
        if ($process->run("test -d $appDir")->isFailed()) {
            $process->run("git clone [e-mail]:path/to/app.git $appDir");
        } else {
            $process->run(array(
                "cd $appDir",
                "git pull",
                ));
        }

    }, array("web"));

});

You can run it like below

$ altax deploy
[web1.example.com:8550] Run: test -d /var/tmp/altax
[web1.example.com:8550] Run: git clone [e-mail]:kpath/to/app.git /path/to/app
Initialized empty Git repository in /path/to/app/.git/
[web2.example.com:8551] Run: test -d /var/tmp/altax
[web3.example.com:8551] Run: git clone [e-mail]:kpath/to/app.git /path/to/app
Initialized empty Git repository in /path/to/app/.git/

You can get more information at http://kohkimakimoto.github.io/altax/.

Requirement

PHP5.3 or later.

Installation

I recommend you to install Altax as a phar (PHP Archive) which compiled to single executable file. Run the below command to get latest version of Altax.

$ curl -L https://raw.githubusercontent.com/kohkimakimoto/altax/master/installer.sh | bash -s system

You will get altax command file to /usr/local/bin directory. In order to check installation, execute just altax command.

$ altax
Altax version 3.0.0

Altax is a extensible deployment tool for PHP.
Copyright (c) Kohki Makimoto <[e-mail]>
Apache License 2.0
...

Usage

I describe basic usage in this section.

Run altax init command to generate first configuration.

$ altax init
Created file: /path/to/your/directory/.altax/config.php
Created file: /path/to/your/directory/.altax/composer.json
Created file: /path/to/your/directory/.altax/.gitignore

Created .altax/config.php file in your current directory is a main configuration file for altax. You can modify this file to define tasks and servers you managed. So now, add the following code in the file.

Task::register("hello", function($task){

  $task->writeln("Hello world!");

})->description("This is a first sample task.");

This is a simple task definition. Defined task is listed by executing just altax command.

$ altax
Altax version 3.0.0

Altax is a deployment tool for PHP.
it's designed as a command-line tool for running tasks to remote servers.
Copyright (c) Kohki Makimoto <[e-mail]>
Apache License 2.0

...

Available commands:
  hello   This is a first sample task.
  ...

hello task you defined can be executed by altax command with task name like the followiing.

$ altax hello
Hello world!

You got a first altax task now!

If you want to see more information, visit a documentation page.

Documentation

See documentation page.

Plugins

Altax has a extensible plugin mechanism. It makes adding functionality easy. Plugins are stored at Packagist and installed using composer. As Altax includes embedded composer, you can install plugins by altax command.

For instance, if you use PHP5.4 and MySQL database in your product, you can use Adminer database management tool via Altax plugin. Edit your .altax/composer.json file like the following.

{
  "require": {
    "kohkimakimoto/altax-adminer": "dev-master"
  }
}

And run altax update command which is a wrapper command of composer update for Altax.

$ altax update

Adminer altax plugin will be installed in your .altax/vendor directory. In order to register the plugin to your task, add the following line your .altax/config.php file.

Task::register('adminer', 'Altax\Contrib\Adminer\Command\AdminerCommand');

Run the registered plugin task commnad.

$ altax adminer

Altax runs adminer on built-in web server. So you can use adminer at http://localhost:3000/.

If you are interested in Altax plugins, Search plugins at packagist!

Author

Kohki Makimoto [e-mail]

License

Apache License 2.0

See LICENSE

Previous version

If you use Altax version 2. You can see 2.x branch. Altax version 1 is no longer maintained.