@@ -11,7 +11,7 @@ task('deploy', function () {
11
11
~~~
12
12
13
13
Each parameter can be overridden for each host:
14
-
14
+
15
15
~~~ php
16
16
host(...)
17
17
->set('param', 'new value');
@@ -61,7 +61,7 @@ dep config:hosts
61
61
62
62
Below is a list of common variables.
63
63
64
- ### deploy_path
64
+ ### deploy \_ path
65
65
66
66
Where to deploy application on remote host. You should define this variable for all of your hosts.
67
67
For example, if you want to deploy your app to home directory:
@@ -86,7 +86,7 @@ set('user', function () {
86
86
~~~
87
87
88
88
You can override it in _ deploy.php_ for example to use env var:
89
-
89
+
90
90
~~~ php
91
91
set('user', function () {
92
92
return getenv('DEP_USER');
@@ -99,7 +99,7 @@ set('user', function () {
99
99
set('slack_text', '{{user}} deploying {{branch}} to {{hostname}}');
100
100
~~~
101
101
102
- ### release_path
102
+ ### release \_ path
103
103
104
104
Full path to the current release directory. Current dir path in non-deploy contexts.
105
105
Use it as working path for your build:
@@ -116,7 +116,7 @@ task('build', function () {
116
116
> task('build', 'webpack -p');
117
117
> ~~~
118
118
119
- ### previous_release
119
+ ### previous\_release
120
120
121
121
Points to previous release if it exists. Otherwise variable doesn't exist.
122
122
@@ -130,15 +130,15 @@ task('npm', function () {
130
130
});
131
131
~~~
132
132
133
- ### ssh_multiplexing
133
+ ### ssh \_ multiplexing
134
134
135
135
Use [ ssh multiplexing] ( https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing ) to speedup the native ssh client.
136
136
137
137
~~~ php
138
138
set('ssh_multiplexing', true);
139
139
~~~
140
140
141
- ### default_stage
141
+ ### default \_ stage
142
142
143
143
If the hosts declaration has stages, this option allows you to select the default stage to deploy with ` dep deploy ` .
144
144
@@ -189,7 +189,7 @@ set('default_stage', function() {
189
189
190
190
The result is that only \MyVendor\getDefaultStage() is run.
191
191
192
- ### keep_releases
192
+ ### keep \_ releases
193
193
194
194
Number of releases to keep. ` -1 ` for unlimited releases. Default to ` 5 ` .
195
195
@@ -203,15 +203,15 @@ as a Deploy Key (a.k.a. Access Key). This key allows your host to pull out the c
203
203
Note that the first time a host connects, it can ask to add host in ` known_hosts ` file. The easiest way to do this is
204
204
by running ` git clone <repo> ` on your host and saying ` yes ` when prompted.
205
205
206
- ### git_tty
206
+ ### git \_ tty
207
207
208
208
Allocate TTY for ` git clone ` command. ` false ` by default. This allow you to enter a passphrase for keys or add host to ` known_hosts ` .
209
209
210
210
~~~ php
211
211
set('git_tty', true);
212
212
~~~
213
213
214
- ### git_recursive
214
+ ### git \_ recursive
215
215
216
216
Set the ` --recursive ` flag for git clone. ` true ` by default. Setting this to ` false ` will prevent submodules from being cloned as well.
217
217
@@ -232,7 +232,7 @@ dep deploy --revision="5daefb59edbaa75"
232
232
233
233
Note that ` tag ` has higher priority than ` branch ` and lower than ` revision ` .
234
234
235
- ### shared_dirs
235
+ ### shared \_ dirs
236
236
237
237
List of shared dirs.
238
238
@@ -244,19 +244,19 @@ set('shared_dirs', [
244
244
]);
245
245
~~~
246
246
247
- ### shared_files
247
+ ### shared \_ files
248
248
249
249
List of shared files.
250
250
251
- ### copy_dirs
251
+ ### copy \_ dirs
252
252
253
253
List of files to copy between release.
254
254
255
- ### writable_dirs
255
+ ### writable \_ dirs
256
256
257
257
List of dirs which must be writable for web server.
258
258
259
- ### writable_mode
259
+ ### writable \_ mode
260
260
261
261
Writable mode
262
262
@@ -265,51 +265,51 @@ Writable mode
265
265
* ` chown ` use unix ` chown ` command,
266
266
* ` chgrp ` use unix ` chgrp ` command,
267
267
268
- ### writable_use_sudo
268
+ ### writable \_ use \_ sudo
269
269
270
270
Whether to use ` sudo ` with writable command. Default to ` false ` .
271
271
272
- ### writable_chmod_mode
272
+ ### writable \_ chmod \_ mode
273
273
274
274
Mode for setting ` writable_mode ` in ` chmod ` . Default: ` 0755 ` .
275
275
276
- ### writable_chmod_recursive
276
+ ### writable \_ chmod \_ recursive
277
277
278
278
Whether to set ` chmod ` on dirs recursively or not. Default: ` true ` .
279
279
280
- ### http_user
280
+ ### http \_ user
281
281
282
282
User the web server runs as. If this parameter is not configured, deployer try to detect it from the process list.
283
283
284
- ### clear_paths
284
+ ### clear \_ paths
285
285
286
286
List of paths which need to be deleted in release after updating code.
287
287
288
- ### clear_use_sudo
288
+ ### clear \_ use \_ sudo
289
289
290
- Use or not ` sudo ` with clear_paths . Default to ` false ` .
290
+ Use or not ` sudo ` with clear \_ paths . Default to ` false ` .
291
291
292
- ### cleanup_use_sudo
292
+ ### cleanup \_ use \_ sudo
293
293
294
294
Whether to use ` sudo ` with ` cleanup ` task. Default to ` false ` .
295
295
296
- ### use_relative_symlink
296
+ ### use \_ relative \_ symlink
297
297
298
298
Whether to use relative symlinks. By default deployer will detect if the system supports relative symlinks and use them.
299
299
300
300
> Relative symlink used by default, if your system supports it.
301
301
302
- ### use_atomic_symlink
302
+ ### use \_ atomic \_ symlink
303
303
304
304
Whether to use atomic symlinks. By default deployer will detect if system supports atomic symlinks and use them.
305
305
306
306
> Atomic symlinking is used by default, if your system supports it.
307
307
308
- ### composer_action
308
+ ### composer \_ action
309
309
310
310
Composer action. Default is ` install ` .
311
311
312
- ### composer_options
312
+ ### composer \_ options
313
313
314
314
Options for Composer.
315
315
0 commit comments