You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 lines
2.3 KiB

# Magallanes #
### What's Magallanes? ###
13 years ago
Magallanes is a deployment tool for PHP applications; it's quite simple to use and manage.
13 years ago
It will get your application to a safe harbor.
13 years ago
13 years ago
### So, What can it do? ###
13 years ago
You can instruct Magallanes to deploy your code to all the servers you want (via rsync over ssh),
13 years ago
and run tasks for that freshly deployed code.
### How can I install it via composer? ###
Simply add the following dependency to your project’s composer.json file:
```js
"require-dev": {
// ...
"andres-montanez/magallanes": "~1.0.3"
// ...
}
```
Now tell we update the vendors:
```bash
$ php composer update andres-montanez/magallanes
```
And finally we can use Magallanes from the vendor's bin:
```bash
$ bin/mage version
```
13 years ago
### System-wide installation with composer ###
```bash
$ composer global require "andres-montanez/magallanes=~1.0.3"
```
Make sure you have ~/.composer/vendor/bin/ in your path.
You can now use Magallanes by using the ````mage```` command.
### Can you give me some examples/ideas? ###
13 years ago
**Sure!**
Suppose you have a checkout of your app and you have to deploy it to four servers;
and after each deploy you have to run some boring tasks, like fixing file permissions, creating symlinks, etc.
You can define all this on Magallanes and with *just one command* you can do all this at once!
13 years ago
Like this:
```
13 years ago
$ mage deploy to:production
```
### What's this sorcery?! ###
13 years ago
Easy boy. It's not sorcery, just some *technomagick*!
13 years ago
13 years ago
In Magallanes you define environments like *testing*, *staging*, or *production* like on the example above.
11 years ago
Then, on that environment, you can configure a setup specifying to which hosts you want to deploy and what tasks to run (*after*, *on*, and *before* deploying).
13 years ago
And you are done!
13 years ago
### This is awesome! Where can I learn more? ###
11 years ago
You can read the whole source code (naaah!); or checkout the documentation at: http://magephp.com
13 years ago
Enjoy your magic trip with **Magallanes** to the land of the easily deployable apps!!
10 years ago
### "develop" branch ###
Please, all pull request now must be on the develop branch. Thanks!
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/ed0de53a-a12e-459b-9464-34def5907b56/mini.png)](https://insight.sensiolabs.com/projects/ed0de53a-a12e-459b-9464-34def5907b56)