-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdeploy.php
264 lines (229 loc) · 6.11 KB
/
deploy.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<?php
/**
* Simple PHP GIT deploy script
*
* Automatically deploy the code using php and git.
*
* @version 1.0.8
* @link https://github.com/markomarkovic/simple-php-git-deploy/
*/
// =========================================[ Configuration start ]===
/**
* Protect the script from unauthorized access by using a secret string.
* If it's not present in the access URL as a GET variable named `sat`
* e.g. deploy.php?sat=Bett...s the script is going to fail.
*
* @var string
*/
define('SECRET_ACCESS_TOKEN', 'asdf1234');
/**
* The address of the remote GIT repository that contains the code we're
* updating.
*
* @var string
*/
define('REMOTE_REPOSITORY', 'git@gitdinf.cll.qc.ca:rv204/web.git');
/**
* Which branch are we going to use for deployment.
*
* @var string
*/
define('BRANCH', 'master');
/**
* This is where the code resides on the local machine.
* Don't forget the trailing slash!
*
* @var string Full path including the trailing slash
*/
define('TARGET_DIR', '/usr/share/nginx/html/');
/**
* Weather to delete the files that are not in the repository but are on the
* local machine.
*
* !!! WARNING !!! This can lead to a serious loss of data if you're not
* careful. All files that are not in the repository are going to be deleted,
* except the ones defined in EXCLUDE section! BE CAREFUL!
*
* @var boolean
*/
define('DELETE_FILES', false);
/**
* The directories and files that are to be excluded when updating the code.
* Normally, these are the directories containing files that are not part of
* code base, for example user uploads or server-specific configuration files.
* Use rsync exclude pattern syntax for each element.
*
* @var serialized array of strings
*/
define('EXCLUDE', serialize(array(
'.git',
'webroot/uploads',
'app/config/database.php',
)));
/**
* Temporary directory we'll use to stage the code before the update.
*
* @var string Full path including the trailing slash
*/
define('TMP_DIR', '/tmp/spgd-'.md5(REMOTE_REPOSITORY).'-'.time().'/');
/**
* Output the version of the deployed code.
*
* @var string Full path to the file name
*/
define('VERSION_FILE', TMP_DIR.'DEPLOYED_VERSION.txt');
/**
* Time limit for each command.
*
* @var int Time in seconds
*/
define('TIME_LIMIT', 30);
/**
* OPTIONAL
* Backup the TARGET_DIR into BACKUP_DIR before deployment
*
* @var string Full backup directory path e.g. '/tmp/'
*/
define('BACKUP_DIR', false);
// ===========================================[ Configuration end ]===
?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Simple PHP GIT deploy script</title>
<style>
body { padding: 0 1em; background: #222; color: #fff; }
h2, .error { color: #c33; }
.prompt { color: #6be234; }
.command { color: #729fcf; }
.output { color: #999; }
</style>
</head>
<body>
<?php
if (!isset($_GET['sat']) || $_GET['sat'] !== SECRET_ACCESS_TOKEN) {
die('<h2>ACCESS DENIED!</h2>');
}
if (SECRET_ACCESS_TOKEN === 'BetterChangeMeNowOrSufferTheConsequences') {
die("<h2>You're suffering the consequences!<br>Change the SECRET_ACCESS_TOKEN from it's default value!</h2>");
}
?>
<pre>
Checking the environment ...
Running as <b><?php echo trim(shell_exec('whoami')); ?></b>.
<?php
// Check if the needed programs are available
$binaries = array();
$binaries['git'] = "/usr/bin/git";
$binaries['tar'] = "/bin/tar";
$binaries['rsync'] = "/usr/bin/rsync";
?>
Environment OK.
Deploying <?php echo REMOTE_REPOSITORY; ?> <?php echo BRANCH."\n"; ?>
to <?php echo TARGET_DIR; ?> ...
<?php
// The commands
$commands = array();
// ========================================[ Pre-Deployment steps ]===
// Clone the repository into the TMP_DIR
$commands[] = sprintf(
'%s clone --depth=1 --branch %s %s %s'
, $binaries['git']
, BRANCH
, REMOTE_REPOSITORY
, TMP_DIR
);
// Update the submodules
$commands[] = sprintf(
'%s submodule update --init --recursive'
, $binaries['git']
);
// Describe the deployed version
if (defined('VERSION_FILE') && VERSION_FILE !== '') {
$commands[] = sprintf(
'%s --git-dir="%s.git" --work-tree="%s" describe --always > %s'
, $binaries['git']
, TMP_DIR
, TMP_DIR
, VERSION_FILE
);
}
// Backup the TARGET_DIR
if (defined('BACKUP_DIR') && BACKUP_DIR !== false && is_dir(BACKUP_DIR)) {
$commands[] = sprintf(
'%s czf %s/%s-%s-%s.tar.gz %s*'
, $binaries['tar']
, BACKUP_DIR
, basename(TARGET_DIR)
, md5(TARGET_DIR)
, date('YmdHis')
, TARGET_DIR // We're backing up this directory into BACKUP_DIR
);
}
// ==================================================[ Deployment ]===
// Compile exclude parameters
$exclude = '';
foreach (unserialize(EXCLUDE) as $exc) {
$exclude .= ' --exclude='.$exc;
}
// Deployment command
$commands[] = sprintf(
'%s -rltgoDzv %s %s %s %s'
, $binaries['rsync']
, TMP_DIR
, TARGET_DIR
, (DELETE_FILES) ? '--delete-after' : ''
, $exclude
);
// =======================================[ Post-Deployment steps ]===
// Remove the TMP_DIR
$commands['cleanup'] = sprintf(
'rm -rf %s'
, TMP_DIR
);
// =======================================[ Run the command steps ]===
foreach ($commands as $command) {
set_time_limit(TIME_LIMIT); // Reset the time limit for each command
if (file_exists(TMP_DIR) && is_dir(TMP_DIR)) {
chdir(TMP_DIR); // Ensure that we're in the right directory
}
$tmp = array();
exec($command.' 2>&1', $tmp, $return_code); // Execute the command
// Output the result
printf('
<span class="prompt">$</span> <span class="command">%s</span>
<div class="output">%s</div>
'
, htmlentities(trim($command))
, htmlentities(trim(implode("\n", $tmp)))
);
flush(); // Try to output everything as it happens
// Error handling and cleanup
if ($return_code !== 0) {
$tmp = shell_exec($commands['cleanup']);
printf('
<div class="error">
Error encountered!
Stopping the script to prevent possible data loss.
CHECK THE DATA IN YOUR TARGET DIR!
</div>
Cleaning up temporary files ...
<span class="prompt">$</span> <span class="command">%s</span>
<div class="output">%s</div>
'
, htmlentities(trim($commands['cleanup']))
, htmlentities(trim($tmp))
);
error_log(sprintf(
'Deployment error! %s'
, __FILE__
));
break;
}
}
?>
Done.
</pre>
</body>
</html>