Skip to content
This repository
Newer
Older
100644 94 lines (67 sloc) 3.673 kb
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
1 ## Capistrano
2
cf869ebb »
2011-09-24 Add Travis-CI build badge.
3 [![Build
4 Status](https://secure.travis-ci.org/capistrano/capistrano.png)](http://travis-ci.org/capistrano/capistrano)
5
6
dd21c0f8 »
2011-08-03 Release 2.7.0
7 Capistrano is a utility and framework for executing commands in parallel on
8 multiple remote machines, via SSH. It uses a simple DSL (borrowed in part from
9 [Rake](http://rake.rubyforge.org/)) that allows you to define _tasks_, which may
10 be applied to machines in certain roles. It also supports tunneling connections
11 via some gateway machine to allow operations to be performed behind VPN's and
12 firewalls.
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
13
dd21c0f8 »
2011-08-03 Release 2.7.0
14 Capistrano was originally designed to simplify and automate deployment of web
15 applications to distributed environments, and originally came bundled with a set
16 of tasks designed for deploying Rails applications.
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
17
18 ## Documentation
19
1fc50080 »
2011-04-27 Corrected minor markdown meltdown
20 * [http://github.com/capistrano/capistrano/wiki/Documentation-v2.x](http://github.com/capistrano/capistrano/wiki/Documentation-v2.x)
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
21
22 ## DEPENDENCIES
23
1fc50080 »
2011-04-27 Corrected minor markdown meltdown
24 * [Net::SSH](http://net-ssh.rubyforge.org)
25 * [Net::SFTP](http://net-ssh.rubyforge.org)
26 * [Net::SCP](http://net-ssh.rubyforge.org)
27 * [Net::SSH::Gateway](http://net-ssh.rubyforge.org)
28 * [HighLine](http://highline.rubyforge.org)
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
29
dd21c0f8 »
2011-08-03 Release 2.7.0
30 If you want to run the tests, you'll also need to install the dependencies with
31 Bundler, see the `Gemfile` within .
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
32
33 ## ASSUMPTIONS
34
dd21c0f8 »
2011-08-03 Release 2.7.0
35 Capistrano is "opinionated software", which means it has very firm ideas about
36 how things ought to be done, and tries to force those ideas on you. Some of the
37 assumptions behind these opinions are:
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
38
39 * You are using SSH to access the remote servers.
dd21c0f8 »
2011-08-03 Release 2.7.0
40 * You either have the same password to all target machines, or you have public
41 keys in place to allow passwordless access to them.
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
42
43 Do not expect these assumptions to change.
44
45 ## USAGE
46
47 In general, you'll use Capistrano as follows:
48
49 * Create a recipe file ("capfile" or "Capfile").
50 * Use the `cap` script to execute your recipe.
51
52 Use the `cap` script as follows:
53
dd21c0f8 »
2011-08-03 Release 2.7.0
54 cap sometask
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
55
dd21c0f8 »
2011-08-03 Release 2.7.0
56 By default, the script will look for a file called one of `capfile` or
57 `Capfile`. The `someaction` text indicates which task to execute. You can do
58 "cap -h" to see all the available options and "cap -T" to see all the available
59 tasks.
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
60
bec746ef »
2011-09-24 Add instructions on preparing pull requests correctly.
61 ## CONTRIBUTING:
62
63 * Fork Capistrano
64 * Create a topic branch - `git checkout -b my_branch`
65 * Rebase your branch so that all your changes are reflected in one
66 commit
67 * Push to your branch - `git push origin my_branch`
68 * Create a Pull Request from your branch, include as much documentation
69 as you can in the commit message/pull request, following these
443a50f9 »
2011-10-17 Update README.mdown
70 [guidelines on writing a good commit message](http://spheredev.org/wiki/Git_for_the_lazy#Writing_good_commit_messages)
bec746ef »
2011-09-24 Add instructions on preparing pull requests correctly.
71 * That's it!
72
73
5824e8e0 »
2010-10-04 Updating the readme to be formatted correctly and link the documenati…
74 ## LICENSE:
75
76 Permission is hereby granted, free of charge, to any person obtaining
77 a copy of this software and associated documentation files (the
78 'Software'), to deal in the Software without restriction, including
79 without limitation the rights to use, copy, modify, merge, publish,
80 distribute, sublicense, and/or sell copies of the Software, and to
81 permit persons to whom the Software is furnished to do so, subject to
82 the following conditions:
83
84 The above copyright notice and this permission notice shall be
85 included in all copies or substantial portions of the Software.
86
87 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
88 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
89 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
90 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
91 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
92 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
93 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.