Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 95 lines (68 sloc) 3.691 kB
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
1 ## Capistrano
2
cf869eb @leehambley Add Travis-CI build badge.
leehambley authored
3 [![Build
4 Status](https://secure.travis-ci.org/capistrano/capistrano.png)](http://travis-ci.org/capistrano/capistrano)
5
6
dd21c0f @leehambley Release 2.7.0
leehambley authored
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.
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
13
dd21c0f @leehambley Release 2.7.0
leehambley authored
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.
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
17
18 ## Documentation
19
27603dd @carsomyr Change the README to point to the new Capistrano wiki location
carsomyr authored
20 * [https://github.com/capistrano/capistrano/wiki](https://github.com/capistrano/capistrano/wiki)
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
21
22 ## DEPENDENCIES
23
1fc5008 @leereilly Corrected minor markdown meltdown
leereilly authored
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)
bc577df @carsomyr Update the README
carsomyr authored
29 * [Ruby](http://www.ruby-lang.org/en/) ≥ 1.8.7
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
30
dd21c0f @leehambley Release 2.7.0
leehambley authored
31 If you want to run the tests, you'll also need to install the dependencies with
32 Bundler, see the `Gemfile` within .
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
33
34 ## ASSUMPTIONS
35
dd21c0f @leehambley Release 2.7.0
leehambley authored
36 Capistrano is "opinionated software", which means it has very firm ideas about
37 how things ought to be done, and tries to force those ideas on you. Some of the
38 assumptions behind these opinions are:
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
39
40 * You are using SSH to access the remote servers.
dd21c0f @leehambley Release 2.7.0
leehambley authored
41 * You either have the same password to all target machines, or you have public
42 keys in place to allow passwordless access to them.
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
43
44 Do not expect these assumptions to change.
45
46 ## USAGE
47
48 In general, you'll use Capistrano as follows:
49
50 * Create a recipe file ("capfile" or "Capfile").
51 * Use the `cap` script to execute your recipe.
52
53 Use the `cap` script as follows:
54
dd21c0f @leehambley Release 2.7.0
leehambley authored
55 cap sometask
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
56
dd21c0f @leehambley Release 2.7.0
leehambley authored
57 By default, the script will look for a file called one of `capfile` or
58 `Capfile`. The `someaction` text indicates which task to execute. You can do
59 "cap -h" to see all the available options and "cap -T" to see all the available
60 tasks.
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
61
bec746e @leehambley Add instructions on preparing pull requests correctly.
leehambley authored
62 ## CONTRIBUTING:
63
64 * Fork Capistrano
65 * Create a topic branch - `git checkout -b my_branch`
66 * Rebase your branch so that all your changes are reflected in one
67 commit
68 * Push to your branch - `git push origin my_branch`
69 * Create a Pull Request from your branch, include as much documentation
70 as you can in the commit message/pull request, following these
443a50f @et Update README.mdown
et authored
71 [guidelines on writing a good commit message](http://spheredev.org/wiki/Git_for_the_lazy#Writing_good_commit_messages)
bec746e @leehambley Add instructions on preparing pull requests correctly.
leehambley authored
72 * That's it!
73
74
5824e8e @leehambley Updating the readme to be formatted correctly and link the documenati…
leehambley authored
75 ## LICENSE:
76
77 Permission is hereby granted, free of charge, to any person obtaining
78 a copy of this software and associated documentation files (the
79 'Software'), to deal in the Software without restriction, including
80 without limitation the rights to use, copy, modify, merge, publish,
81 distribute, sublicense, and/or sell copies of the Software, and to
82 permit persons to whom the Software is furnished to do so, subject to
83 the following conditions:
84
85 The above copyright notice and this permission notice shall be
86 included in all copies or substantial portions of the Software.
87
88 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
89 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
90 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
91 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
92 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
93 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
94 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.