Documentation

We have broken the documentation up in to a few logical sections, and there is a fourth section for more advanced topics.

What's in the box?

Capistrano's executable cap is self documenting, see here for more information.

Using an Edge-Release

If you want to try your hand with our latest development branch, follow the advice here please! Capistrano Edge

For Newcomers

• Getting Started
• From the Beginning

 What happens during a default deploy?

• Default Deploy Path

Common Problems with Source Control Software / Servers

• Source server using a non-standard port

 API Style Documentation

• Action Module
• Config Module
• Variables

Handbook

There is a WIP handbook on GitHub, please fork it, send issues and pull requests, we hope the handbook will become the de-facto place to go for help. This is FAR from finished, and needs your contributions, please please if you know about how Cap works, contribute something.

• Capistrano Handbook

SSH / Connection Advice

• Getting Started with SSH

• SSH Options

• How to use SSH Keys
• What is an SSH Agent
• How SSH Agent Forwarding Works

• $PATH Problems
• Pseudo Terminals

Extensions

• Multistage

Tutorial Style Documentation

We're trying to amass a good list of Capistrano tutorials, please see the following page:

• Tutorials

 Miscellaneous

• Overriding Task Commands - How to override a command (run,sudo,etc)