westarete-capistrano-helpers 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.rdoc +28 -6
  2. data/VERSION +1 -1
  3. data/capistrano-helpers.gemspec +1 -1
  4. metadata +1 -1
@@ -105,18 +105,40 @@ You can override the location of the configuration file by setting the
105
105
 
106
106
  set :preflight_config, 'somewhere/else.yml'
107
107
 
108
- === privates
108
+ === shared
109
109
 
110
110
  During deployment, this helper replaces each of the given paths with a
111
- symbolic link that points to the same path under shared/private on the server.
112
- This is useful for setting up sensitive files (e.g. that contain passwords or
113
- secret keys) that exist only on the server and not in the source code
114
- repository.
111
+ symbolic link that points to the same path under the "shared" directory on the
112
+ server. This is useful for setting up files and directories that contain
113
+ data that should persist across deployments (uploads, for example).
114
+
115
+ After requiring this helper, set the paths to be symlinked using the
116
+ :shared variable:
117
+
118
+ set :shared, %w{
119
+ public/uploads
120
+ public/downloads/huge_files
121
+ }
122
+
123
+ This will create two symbolic links on the production server:
124
+
125
+ #{release_path}/public/uploads -> #{shared_path}/public/uploads
126
+ #{release_path}/public/downloads/huge_files -> #{shared_path}/public/downloads/huge_files
127
+
128
+ === privates
129
+
130
+ This works much like the shared helper above, except the symbolic link will
131
+ point to the same path under "shared/private" on the server. This allows you
132
+ to set special permissions on that directory for keeping particularly
133
+ sensitive files safe, such as those that contain passwords or encryption keys.
115
134
 
116
135
  After requiring this helper, set the paths to be symlinked using the
117
136
  :privates variable:
118
137
 
119
- set :privates, ['config/database.yml', 'config/session_secret.txt']
138
+ set :privates, %w{
139
+ config/database.yml
140
+ config/session_secret.txt
141
+ }
120
142
 
121
143
  This will create two symbolic links on the production server:
122
144
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.0
1
+ 0.1.1
@@ -2,7 +2,7 @@
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = %q{capistrano-helpers}
5
- s.version = "0.1.0"
5
+ s.version = "0.1.1"
6
6
 
7
7
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
8
  s.authors = ["Scott Woods"]
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: westarete-capistrano-helpers
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Scott Woods