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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
|
<!DOCTYPE html>
<html dir="ltr" lang="en">
<head>
<meta charset='utf-8'>
<title>Gitolite</title>
</head>
<body>
<a href="index.html">Tools Index</a>
<h1>Gitolite</h1>
<h2 id="install">1. Install Gitolite</h2>
<p>Install <a href="../ports/gitolite/">Gitolite port</a> first;</p>
<pre>
$ prt-get depinst gitolite
</pre>
<h2 id="config">2. Configure Gitolite</h2>
<p>Create user and home directory;</p>
<pre>
# useradd -r -s /bin/bash -U -m -d /srv/gitolite gitolite
# chown gitolite:gitolite /srv/gitolite
</pre>
<p>Password is necessary so the user is not
locked and can login via ssh. This password
will not be used.</p>
<pre>
# passwd gitolite
</pre>
<p>Copy public key that will be used for
authenticating gitolite administrator, read
<a href="openssh.html#ssh">ssh</a> how to
create one, key don't need to have password.
If the server is on remote a remote
machine you can use scp to copy the public key;</p>
<pre>
$ scp /home/bob/.ssh/gitolite.pub admin@core.privat-network.net:/home/admin/
bob@core.privat-network.net's password:
gitolite.pub 100% 390 0.4KB/s 00:00
</pre>
<p>Then on remote machine;</p>
<pre>
# cp /home/admin/gitolite.pub /srv/gitolite.pub
</pre>
<pre>
# su - gitolite
$ gitolite setup -pk gitolite.pub
Initialized empty Git repository in /srv/gitolite/repositories/gitolite-admin.git/
Initialized empty Git repository in /srv/gitolite/repositories/testing.git/
WARNING: /srv/gitolite/.ssh missing; creating a new one
(this is normal on a brand new install)
WARNING: /srv/gitolite/.ssh/authorized_keys missing; creating a new one
(this is normal on a brand new install)
$
</pre>
<pre>
$ rm gitolite.pub
$ exit
</pre>
<pre>
$ ssh -v -i ~/.ssh/gitolite gitolite@localhost -p 2222
</pre>
<h2 id="admin">3. Gitolite Administration</h2>
<p>Read how to setup <a href="openssh.html#sshid">ssh identities</a>,
<a href="http://gitolite.com/gitolite/gitolite.html#basic-admin">gitolite documentation</a>.
Start by cloning gitolite-adimin;</p>
<pre>
$ git clone git-admin:gitolite-admin
</pre>
<h3>3.1. Recover Admin Account</h3>
<p>First copy the key to remote server, in this example key is on
same server;</p>
<pre>
# install -o gitolite -g gitolite /home/bob/.ssh/gitolite.pub /srv/gitolite/gitolite.pub
</pre>
<p>Update gitolite key with new key;</p>
<pre>
# su - gitolite
$ gitolite setup -pk gitolite.pub
</pre>
<pre>
$ rm gitolite.pub
$ exit
</pre>
<h3 id="adminusers">3.2. Users</h3>
<p>Gitolite helps add and remove users from authorized_keys
by allowing add or remove keys from keydir directory in
clone.</p>
<h4>3.2.1. Add User</h4>
<pre>
$ mv bob.pub keydir/
$ git add keydir
$ git commit -m "Added bob public key"
$ git push
</pre>
<h4>3.2.2. Remove User</h4>
<pre>
$ git rm keydir/bob.pub
$ git commit -m "Removed bob public key"
$ git push
</pre>
<h3 id="adminrep">3.3. Repositories</h3>
<h4>3.3.1. Add Repository</h4>
<p>Add repository atom and user bob to devteam group,
edit conf/gitolite.conf;</p>
<pre>
@guests = gitweb
@interns = bob alice
@dev = fred mary joe
@teamleads = mary
@staff = @interns @dev @teamleads
repo @secret
- = @guests
option deny-rules = 1
repo @floss
RW+ = @dev @staff
R = @all
repo @project
RW+ = @teamleads
- master = @dev
- refs/tags/v[0-9] = @dev
RW+ develop/ = @dev
RW+ feature/ = @dev
RW+ hot-fix/ = @dev
RW = @dev
R = @interns
repo gitolite-admin
RW+ = gitolite
repo c9-doc c9-ports c9-pmwiki
config gitweb.owner = "c9 team"
config gitweb.category = "c9"
repo c9-doc
config gitweb.description = "c9 documentation"
option hook.post-receive = deploy-web-doc
repo c9-ports
config gitweb.description = "c9 ports"
repo c9-pmwiki
config gitweb.description = "c9 wiki"
option hook.post-receive = deploy-web-doc
repo c9-assistant
config gitweb.owner = "c9 team"
config gitweb.category = "c9"
config gitweb.description = "c9 open assistant"
@secret = gitolite-admin
@project = c9-doc c9-ports c9-pmwiki c9-assistant
</pre>
<p>Commit and push;</p>
<pre>
$ git add -u
$ git push
</pre>
<h4>3.3.2 Rename Repository</h4>
<p>Rename rep void to sysdoc, on remote host;</p>
<pre>
# cd /srv/gitolite/repositories/
# mv void.git c9-doc.git
</pre>
<p>On workstation edit conf/gitolite.conf;</p>
<pre>
repo c9-doc
RW+ = bob
</pre>
<p>Commit and push;</p>
<pre>
$ git add -u
$ git push
</pre>
<h4>3.3.3 Delete Repository</h4>
<pre>
# cd /srv/gitolite/repositories/
# rm -rf c9-doc.git
</pre>
<p>On workstation edit conf/gitolite.conf and remove c9-doc.</p>
<h2 id="hooks">4. Gitolite Hooks</h2>
<p>This document creates three scripts, one is run when gitolite receives
push to a project with hook active, second script is run under root
user to allow operations where gitolite user have no rights, third one
is project specific.</p>
<p>This example try to have a separate creation of a package and its deployment,
in case deploy script is not on the same machine other method can be used to send
the package.</p>
<p>A normal package will have a files.tar with all or new files to extract,
if necessary a deleted file with the list of files to be removed and a
project file with data about the package like new hash commit, or witch
script to call to deploy.</p>
<p>Package is created under gitolite
<a href="conf/srv/gitolite/hook.sh">/srv/gitolite/deploy/hook.sh</a>
script and
<a href="conf/srv/gitolite/deploy.sh">/srv/gitolite/deploy/deploy.sh</a>,
deploy in this example is called called by cron.</p>
<h3 id="gtl-activate">4.1. Activate Hooks</h3>
<p>Example from
<a href="http://gitolite.com/gitolite/cookbook.html#v3.6-variation-repo-specific-hooks">Cookbook</a>
how to apply hooks only to certain repos. Uncomment or add
this line on <a href="conf/srv/gitolite/.gitolite.rc">/srv/gitolite/.gitolite.rc</a>,
within the %RC block;</p>
<pre>
LOCAL_CODE => "$rc{GL_ADMIN_BASE}/local",
</pre>
<p>Uncomment the 'repo-specific-hooks' line in the rc file
or add it to the ENABLE list if it doesn't exist.</p>
<pre>
# allow repo-specific hooks to be added
'repo-specific-hooks',
</pre>
<p>Create directory on gitolite-admin clone;</p>
<pre>
$ cd ~/gitolite-admin
$ mkdir -p local/hooks/repo-specific
</pre>
<p>Now add your hooks to that directory, but instead of using the
git "standard" names (pre-receive, post-receive, post-update),
you use descriptive names (e.g. "deploy", "RSS-post", etc).</p>
<p>On remote run;</p>
<pre>
# su - gitolite
$ mkdir .gitolite/local/hooks/repo-specific
$ gitolite setup
</pre>
<h3 id="gtl-deploy">4.2. Deploy and Hook script</h3>
<p>Create deploy directory on remote, /srv/gitolite/deploy
was chosen to have less impact on the package system;</p>
<pre>
$ sudo -u gitolite mkdir /srv/gitolite/deploy
</pre>
<p>Script
<a href="conf/srv/gitolite/hook.sh">/srv/gitolite/deploy/hook.sh</a>
receives call create_package "project-name" "git-dir"
"valid oldrev/invalid" "newrev" "script/to/call.sh" from gitolite hook
and creates a package.</p>
<pre>
$ sudo -u gitolite cp conf/srv/gitolite/hook.sh /srv/gitolite/deploy/
</pre>
<p>Script
<a href="conf/srv/gitolite/deploy.sh">/srv/gitolite/deploy/deploy.sh</a>
loops for each package, extracts, order commit hashes to create final
snapshot of files and call script to handle deploy.</p>
<pre>
$ sudo -u gitolite cp conf/srv/gitolite/deploy.sh /srv/gitolite/deploy/
</pre>
<h3 id="gtl-setup">4.3. Setup project hook</h3>
<p>Project hooks create a package by calling hook.sh script and
deploy a package being called by deploy.sh. Deploy script is a
simple example that handle multiple web projects.</p>
<h4>4.3.1. Hook Script</h4>
<p>Create
<a href="conf/srv/gitolite/deploy-web-doc">gitolite-admin/local/hooks/repo-specific/deploy-web-doc</a>;</p>
<pre>
#!/bin/bash
######################################################################
#
# Put this file in your gitolite-admin;
# ~/gitolite-admin/local/hooks/repo-specific/deploy-web-doc
#
# set host to empty to create package for each push
# or set remote host to create package based on last deployed push
# host="https://doc.localhost"
host=""
# set name of witch branch should be deployed
branch_to_deploy="deploy_branch"
######################################################################
url="$host/.last_deploy"
source /srv/gitolite/deploy/hook.sh
read oldrev newrev refname
push_branch=$(git rev-parse --symbolic --abbrev-ref $refname)
#SCRIPT_VARS=$(set)
#echo "project: $PROJECT"
#echo "local dir: $PWD" > /srv/gitolite/deploy/${GL_REPO}
#echo "${SCRIPT_VARS}" >> /srv/gitolite/deploy/${GL_REPO}
if [[ $push_branch = $branch_to_deploy ]]; then
# if host empty we make local tracking
if [[ $host = "" ]]; then
if [[ $(is_initial ${GL_REPO}) = "true" ]]; then
oldrev="initial"
fi
else
if [[ ! $(valid_url $url) = "true" ]]; then
echo "Deploy: set $url on remote to start creating packages"
exit 1
fi
oldrev=$(get_remote_rev $url)
fi
create_package ${GL_REPO} ${PWD} ${oldrev} ${newrev} "deploy-web.sh"
fi
</pre>
<p>Activate this hook, the idea is to start with this one as a template working
and then implement the final one. Edit gitolite admin configuration file and
activate:</p>
<pre>
repo c9-doc
config gitweb.description = "c9 documentation"
option hook.post-receive = deploy-web-doc
</pre>
<p>Add, commit, and push the admin repo;</p>
<pre>
$ git add local/hooks/repo-specific/hook-deployweb
$ git add -u && git commit -m "added deploy c9 hook"
</pre>
<p>Now we can test if our script is functioning by creating a branch on c9-doc
making a random change and push;<p>
<pre>
$ cd c9-doc
$ git checkout -b deploy_branch
</pre>
<h4>4.3.2. Deploy Script</h4>
<p>Create
<a href="conf/srv/gitolite/deploy-web.sh">/srv/gitolite/deploy/scripts/deploy-web.sh</a>;</p>
<pre>
#!/bin/bash
pkg_path=$1
www_root="/srv/www"
www_user="nginx"
www_group="www"
pkg_file="${pkg_path}/project"
pkg_rm="${pkg_path}/deleted"
pkg_files="${pkg_path}/files"
if [ ! -f ${pkg_file} ]; then
echo "Deploy web: invalid pkg_file ${pkg_file}"
exit 1
fi
pkg_name=$(head -1 ${pkg_file})
pkg_new=$(head -3 ${pkg_file} | tail -1)
pkg_new7=$(echo ${pkg_new} | cut -c1-7)
pkg_www="${www_root}/${pkg_name}"
pkg_back="${pkg_www}/backup_deploy"
pkg_last="${pkg_www}/.last_deploy"
if [ ! -d ${pkg_www} ]; then
echo "Deploy web: invalid pkg_www ${pkg_www}"
exit 1
fi
# first backup all data
if [[ ! $(ls ${pkg_www} | grep -v "backup_deploy") = "" ]]; then
if [ ! -d ${pkg_back} ]; then
sudo -u ${www_user} mkdir -p ${pkg_back}
fi
backup_file="${pkg_back}/${pkg_name}-$(date '+%Y-%j-%H-%M-%S').tar.gz"
echo "Deploy web: making backup ${backup_file}"
sudo -u ${www_user} tar --exclude ${pkg_back} --xattrs -zcpf ${backup_file} ${pkg_www}
fi
# remove files and directories that have been deleted
if [ -f ${pkg_rm} ]; then
echo "Deploy web: files to delete:"
# first we delete files
while read deleted_file; do
deleted_file="${pkg_www}/${deleted_file}"
if [ -f ${deleted_file} ]; then
echo "file rm ${deleted_file}"
rm ${deleted_file}
fi
done <${pkg_rm}
# delete directories
while read deleted_file; do
deleted_file="${pkg_www}/${deleted_file}"
if [ -d ${deleted_file} ]; then
echo "file rm ${deleted_file}"
rm ${deleted_file}
fi
done <${pkg_rm}
fi
# copy new files to destination
if [ -d ${pkg_files} ]; then
echo "Deploy web: cp from ${pkg_files} to ${pkg_www}"
sudo -u ${www_user} cp -r ${pkg_files}/* ${pkg_www}
fi
echo ${pkg_new} > ${pkg_last}
echo "Deploy: scripts/deployweb.sh ${pkg_name} ${pkg_new7} deployed."
#remove temporary package
rm -r ${pkg_path}
</pre>
<h4>4.3.3. Debuging hooks</h4>
<p>Comment gitolite admin repo script "if" and uncomment debug sections, this allow to
source the file with environment of hook.</p>
<p>Later you can delete this branch locally and remote and start fresh. To test
if hook is called each time you push run;</p>
<pre>
$ echo $(( ( RANDOM % 10 ) +1 )) >> index.html && git add -u && git commit -m "test deploy" && git push git
</pre>
<p>See if a file was created in /srv/gitolite/deploy with name of project and
with environmental variables of gitolite script.</p>
<p>From now on you can test changes directly on
/srv/gitolite/.gitolite/local/hooks/repo-specific/hook-deployweb
and repeat above command to see the results or create a separate script with
all variables generated by above script set so you don't have to push at all.</p>
<h4 id="gtl-deploy">4.4. Deploy with Cron</h4>
<p>Add cron job to call deploy script every minute;</p>
<pre>
# crontab -e
</pre>
<pre>
#
# /etc/crontab: crond(8) configuration
#
# this way it will log
# * * * * * /srv/gitolite/deploy/deploy.sh
# without log
* * * * * /srv/gitolite/deploy/deploy.sh > /dev/null 2>&1
@hourly ID=sys.hourly /usr/sbin/runjobs /etc/cron/hourly
@daily ID=sys.daily /usr/sbin/runjobs /etc/cron/daily
@weekly ID=sys.weekly /usr/sbin/runjobs /etc/cron/weekly
@monthly ID=sys.monthly /usr/sbin/runjobs /etc/cron/monthly
# End of file
</pre>
<h2 id="gitweb">5. Gitweb</h2>
<pre>
$ prt-get depinst p5-cgi p5-cgi-session libcgi \
fcgiwrap spawn-fcgi highlight
</pre>
<h3>5.1. Configure gitweb</h3>
<p>Edit /etc/gitweb.conf</p>
<pre>
our $git_temp = "/srv/www/gitweb_tmp";
our $projects_list = "/srv/gitolite/projects.list";
# The directories where your projects are. Must not end with a slash.
our $projectroot = "/srv/gitolite/repositories";
# Base URLs for links displayed in the web interface.
our @git_base_url_list = qw(git://core.privat-network.com http://git@core.private-network.com);
our $projects_list_group_categories = 1;
</pre>
<h3>5.2. Configure nginx</h3>
<p>Edit /etc/rc.d/fcgiwrap to run as www user member of www group;</p>
<pre>
USER=www
GROUP=www
</pre>
<p>Permissions for /srv/gitolite/repositories directories should be
0750/drwxr-x---.</p>
<pre>
$ chown gitolite:www /srv/gitolite
$ chown -R gitolite:www /srv/gitolite/projects.list
$ chown -R gitolite:www /srv/gitolite/repositories
</pre>
<p>A link from gitweb don't work under grsecurity since user www can't
follow simlink to root. Make a copy, later deploy via gitolite hook.</p>
<p>Link;</p>
<pre>
# ln -s /usr/share/gitweb /srv/www
</pre>
<p>Copy;</p>
<pre>
# cp -r /usr/share/gitweb /srv/www
</pre>
<p>Add this to default or main
<a href="nginx.html#virtual-host">nginx virtual host</a>;</p>
<pre>
location /gitweb/gitweb.cgi {
alias /srv/www/gitweb;
include fastcgi_params;
gzip off;
fastcgi_param SCRIPT_FILENAME /srv/www/gitweb/gitweb.cgi;
fastcgi_param GITWEB_CONFIG /etc/gitweb.conf;
fastcgi_pass unix:/var/run/fcgiwrap.sock;
}
location /gitweb {
alias /srv/www/gitweb;
index gitweb.cgi;
}
</pre>
<h3>5.3. Configure gitolite</h3>
<p>Edit
<a href="conf/srv/gitolite/.gitolite.rc">/srv/gitolite/.gitolite.rc</a>,
change UMASK and GIT_CONFIG_KEYS to;</p>
<pre>
# default umask gives you perms of '0700'; see the rc file docs for
# how/why you might change this
UMASK => 027,
# look for "git-config" in the documentation
GIT_CONFIG_KEYS => '.*',
</pre>
<p>Fix permissions;</p>
<pre>
$ sudo chown -R gitolite:gitolite /srv/gitolite
$ sudo chmod g+rx /srv/gitolite/projects.list
$ sudo chmod -R 755 /srv/gitolite/repositories/
</pre>
<p>Edit gitolite-admin/conf/gitolite.conf;</p>
<pre>
repo c9-doc
config gitweb.owner = c9 team
config gitweb.description = c9 documentation
config gitweb.category = c9
repo c9-ports
config gitweb.owner = c9 team
config gitweb.description = c9 ports
config gitweb.category = c9
</pre>
<a href="index.html">Tools Index</a>
<p>This is part of the c9-doc Manual.
Copyright (C) 2016
c9 team.
See the file <a href="../fdl-1.3-standalone.html">Gnu Free Documentation License</a>
for copying conditions.</p>
</body>
</html>
|