Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

Commit

Permalink
Update readme with additional notice
Browse files Browse the repository at this point in the history
  • Loading branch information
j15e committed Jun 3, 2012
1 parent 08edeb3 commit fc94381
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
@@ -1,5 +1,7 @@
# HS Standard Capistrano Recipes

Mostly intented for internal use at HS, but we publish it as some parts might be usefull to the community and we use stuff from the community.

## Typical Usage

1 - Add this repository as as submodule
Expand All @@ -18,14 +20,22 @@

Theses recipes configure and/or overwrite Capistrano default behaviour events as required by those kind of apps or deployments.

### Util Recipes
### Utils Recipes

Theses recipes do not configure any event, you must specify it in your deploy.rb.

Ex. `after "deploy:update_code", "assets:sass_compile"`.

Plug them in your recipe as needed.

### Tips for Easy Deployments

* Deploy via remote-cache, much faster/better `set :deploy_via, :remote_cache`.
* Use SSH forwarding instead of custom deployments keys with `ssh_options[:forward_agent] = true`. It will uses your local SSH key to access the repository from the remote server.
* Multistage is much easier with `require 'capistrano/ext/multistage'` and `set :capistrano_extensions, [:multistage]`.
see https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension.
* Use bundler extension for rails app, with `require "bundler/capistrano"` and `after 'deploy', 'bundle:install'`.

## What's in this?

You'll find tasks and informations to manage various tasks with capistrano such as :
Expand All @@ -47,14 +57,6 @@ You'll find tasks and informations to manage various tasks with capistrano such

More details on some of the recipes below.

## Guidelines for Easy Deployments

* Deploy via remote-cache, much faster/better `set :deploy_via, :remote_cache`.
* Use SSH forwarding instead of custom deployments keys with `ssh_options[:forward_agent] = true`. It will uses your local SSH key to access the repository from the remote server.
* Multistage is much easier with `require 'capistrano/ext/multistage'` and `set :capistrano_extensions, [:multistage]`.
see https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension.
* Use bundler extension for rails app, with `require "bundler/capistrano"` and `after 'deploy', 'bundle:install'`.

## Ruby Recipes

### Unicorn Zero-Downtime Deployments
Expand Down

0 comments on commit fc94381

Please sign in to comment.