Browse Source

Doc Format.

1.0
Andrs Montaez 13 years ago
parent
commit
db7234314d
  1. 9
      README.md

9
README.md

@ -4,10 +4,12 @@
Magallanes is a deployment tool for PHP applications; it's quite simple to use and manage. Magallanes is a deployment tool for PHP applications; it's quite simple to use and manage.
It will get your application to a safe harbor. It will get your application to a safe harbor.
### So, What can it do? ### ### So, What can it do? ###
You can instruct Magallanes to deploy your code to all the servers you want (via rsync over ssh, dah), You can instruct Magallanes to deploy your code to all the servers you want (via rsync over ssh, dah),
and run tasks for that freshly deployed code. and run tasks for that freshly deployed code.
### Can you give me some examples/ideas? ### ### Can you give me some examples/ideas? ###
**Sure!** **Sure!**
@ -20,19 +22,22 @@ Like this:
$ mage deploy to:production $ mage deploy to:production
``` ```
### What's this sorcery?! ### ### What's this sorcery?! ###
Easy boy. It's not sorcery, just some *technomagick*! Easy boy. It's not sorcery, just some *technomagick*!
In Magallanes you define environments like *testing*, *staging*, or *production* like on the example above. In Magallanes you define environments like *testing*, *staging*, or *production* like on the example above.
Then, on that environment you can configure a set up specifing to which hosts you want to deploy and what tasks to run (*after*, *on*, and *before* deploying). Then, on that environment you can configure a set up specifing to which hosts you want to deploy and what tasks to run (*after*, *on*, and *before* deploying).
### And what spells... TASKS! What tasks has it built in? ### ### And what spells... TASKS! What tasks has it built in? ###
Just a few, for now... Just a few, for now...
* **deployment/rsync** - This task is for deploying your code to the remote servers. * **deployment/rsync** This task is for deploying your code to the remote servers.
* **scm/update** - This task is for updating (git/svn) your base wokring copy. * **scm/update** This task is for updating (git/svn) your base wokring copy.
But! You can create your own taks, and execute commands on your working copy and in your deployed code! But! You can create your own taks, and execute commands on your working copy and in your deployed code!
### This is awesome! Where can I learn more? ### ### This is awesome! Where can I learn more? ###
You can read the whole source code (naaah!); or checkout the wiki at: http://magallanes.zenreworks.com/wiki You can read the whole source code (naaah!); or checkout the wiki at: http://magallanes.zenreworks.com/wiki

Loading…
Cancel
Save