Permalink
Browse files

Merge pull request #938 from richardkmichael/master

Staging template cleanup.
  • Loading branch information...
2 parents 4ba07a0 + 1f62af8 commit 4c6299809c3956d8ca48edc4ff13c9474a603be5 @leehambley leehambley committed Feb 21, 2014
Showing with 20 additions and 14 deletions.
  1. +20 −14 lib/capistrano/templates/stage.rb.erb
@@ -1,31 +1,38 @@
# Simple Role Syntax
# ==================
-# Supports bulk-adding hosts to roles, the primary
-# server in each group is considered to be the first
-# unless any hosts have the primary property set.
-# Don't declare `role :all`, it's a meta role
+# Supports bulk-adding hosts to roles, the primary server in each group
+# is considered to be the first unless any hosts have the primary
+# property set. Don't declare `role :all`, it's a meta role.
+
role :app, %w{deploy@example.com}
role :web, %w{deploy@example.com}
role :db, %w{deploy@example.com}
+
# Extended Server Syntax
# ======================
-# This can be used to drop a more detailed server
-# definition into the server list. The second argument
-# something that quacks like a hash can be used to set
-# extended properties on the server.
+# This can be used to drop a more detailed server definition into the
+# server list. The second argument is a, or duck-types, Hash and is
+# used to set extended properties on the server.
+
server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
-# you can set custom ssh options
-# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
-# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
-# set it globally
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a
+# limited set of options, consult[net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start).
+#
+# Global options
+# --------------
# set :ssh_options, {
# keys: %w(/home/rlisowski/.ssh/id_rsa),
# forward_agent: false,
# auth_methods: %w(password)
# }
-# and/or per server
+#
+# And/or per server (overrides global)
+# ------------------------------------
# server 'example.com',
# user: 'user_name',
# roles: %w{web app},
@@ -36,4 +43,3 @@ server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
# auth_methods: %w(publickey password)
# # password: 'please use keys'
# }
-# setting per server overrides global ssh_options

0 comments on commit 4c62998

Please sign in to comment.