about summary refs log tree commit diff stats
path: root/tools/gitolite.html
blob: 2beae971a5f21ad06bb1e5dc4507767c8b6669c0 (plain) (blame)
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
<!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>
        # mkdir -p /srv/gitolite
        # useradd -r -s /bin/bash -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        =   clair bob
        @dev            =   alice david
        @teamleads      =   mike
        @staff          =   @interns @dev @teamleads


        repo gitolite-admin
            RW+     =   gitolite

        repo @floss
                R                       =   @all

        repo @proto
                RW+                     =   @staff

        repo @project
                RW+                     =   @teamleads
                -   master              =   @dev
                -   refs/tags/v[0-9]    =   @dev
                RW+ develop/            =   @dev
                RW+ feature/            =   @dev @interns
                RW+ hot-fix/            =   @dev @interns
                RW                      =   @dev
                R                       =   @interns @guests

        @project     =   c9-doc c9-ports

        repo c9-doc c9-ports
            option hook.post-receive     =  hook-deployweb

        repo testing
            RW+     =   @staff
        </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>

        <h2 id="hooks">4. Gitolite Hooks</h2>

        <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.1. Deploy Hook</h3>

        <p>This manual create two users; one gitolite that handle git
        central server and system www for web servers. To avoid permission
        problems this example use gitolite hooks and cron. By using cron
        we have permission to use chown, this way files end up with right
        www user ownership and permissions.</p>

        <p>This hook allows to select wich branch is deployed and if exists,
        calls a script inside project folder with user www. This allows to
        do post deploy (checkout) tasks such as composer update.</p>

        <p>Create
        <a href="conf/srv/gitolite/hook-deployweb">gitolite-admin/local/hooks/repo-specific/hook-deployweb</a>;</p>

        <pre>
        #!/bin/bash

        ######################################################################
        #
        # Put this file in your gitolite-admin;
        # ~/gitolite-admin/local/hooks/repo-specific/hook-deployweb
        #
        while read oldrev newrev refname
        do
                BRANCH=$(git rev-parse --symbolic --abbrev-ref $refname)
                echo "Commit was for branch $BRANCH"

                if [[ "$BRANCH" == "master" ]];then

                        # Get project name from current directory (without .git)
                        PROJECT=$(basename "$PWD")
                        PROJECT=${PROJECT%.git}

                        echo "Project $PROJECT added to deploy list."
                        echo $PWD &gt; /srv/gitolite/deploy/$PROJECT
                fi

        done
        </pre>

        <p>Add scripts to the repos you want them to be active in
        your conf file. For example:</p>

        <pre>
        repo c9-doc
            option hook.post-receive     =  hook-deployweb
        </pre>

        <p>Add, commit, and push the admin repo;</p>

        <pre>
        $ git add -u && git commit -m "deploy hook"
        </pre>

        <p>Create deploy directory on remote;</p>

        <pre>
        # su - gitolite
        $ mkdir deploy
        </pre>

        <p>On remote run;</p>

        <pre>
        # su - gitolite
        $ gitolite setup
        </pre>

        <p>Create deploy script that cron will call
        every minute, this script will check inside
        /srv/gitolite/deploy folder for projects that have
        been updated.</p>

        <p>Create <a href="conf/srv/gitolite/deployweb">/usr/share/gitolite/hooks/deployweb</a>;</p>

        <pre>
        #!/bin/sh

        ######################################################################
        #
        # Put this file in;
        # /usr/share/gitolite/hooks/deployweb
        #
        DIR_WWW=/srv/www/
        DEPLOY_BRANCH=master
        TARGET_USER=www

        for DP_FILE in /srv/gitolite/deploy/*
        do

            if [ ! -f "$DP_FILE" ]; then
                # Nothing to do ;)
                #echo "Deploy: invalid DP_FILE"
                exit 1;
            fi

            # Get project name
            PROJECT=$(basename "$DP_FILE")
            echo "Deploy: PROJECT=${PROJECT}"

            # Get git repository path and verify if exists
            DIR_GIT=$(head -n 1 $DP_FILE)
            if [ ! -d "$DIR_GIT" ]; then
                echo "Deploy: invalid DIR_GIT: ${DIR_GIT}"
                exit 2;
            fi
            echo "Deploy: DIR_GIT=${DIR_GIT}"

            # Get directory to deploy and verify if exists
            GIT_WORK_TREE=${DIR_WWW}${PROJECT}/
            if [ ! -d "$GIT_WORK_TREE" ]; then
                echo "Deploy: invalid GIT_WORK_TREE: ${GIT_WORK_TREE}"
                echo "Deploy: creating directory: $GIT_WORK_TREE}"
                mkdir -p $GIT_WORK_TREE
            fi
            echo "Deploy: GIT_WORK_TREE={$GIT_WORK_TREE}"

            # Deploy (checkout)
            echo "Deploy: starting git checkout"

            git --git-dir=$DIR_GIT \
                --work-tree=$GIT_WORK_TREE \
                checkout -f $DEPLOY_BRANCH


            # Fix ownership and permissions
            echo "Deploy: fixing permissions"

            echo "Deploy: setting owner: chown -R ${TARGET_USER}"
            chown -R ${TARGET_USER}:${TARGET_USER} $GIT_WORK_TREE

            echo "Deploy: setting directory permissions: chmod 755"
            find $GIT_WORK_TREE -type d -print0 | xargs -0 chmod 755

            echo "Deploy: setting file permissions: chmod 644"
            find $GIT_WORK_TREE -type f -print0 | xargs -0 chmod 644

            # Call project script
            if [ -f "${GIT_WORK_TREE}/deploy.sh" ]; then
                echo "Deploy: calling ${GIT_WORK_TREE}deploy.sh"
                cd ${GIT_WORK_TREE}
                sudo -u ${TARGET_USER} sh ${GIT_WORK_TREE}deploy.sh
            fi

            # Done with project
            echo "Deploy: removing deploy file="$DP_FILE
            rm $DP_FILE

            exit 0;
        done
        </pre>

        <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
        # * * * * * /usr/share/gitolite/hooks/deployweb
        # without log
        * * * * * /usr/share/gitolite/hooks/deployweb > /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
        </pre>

        <h3>5.1. Configure gitweb</h3>

        <p>Edit /etc/gitweb.conf</p>

        <pre>
        our $git_temp = "/tmp";

        # 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);
        </pre>

        <h3>5.2. Configure nginx</h3>

        <p>Edit /etc/rc.d/fcgiwrap to run as www user;</p>

        <pre>
        USER=nginx
        GROUP=nginx
        </pre>

        <pre>
        # usermod -G www,gitolite nginx
        </pre>

        <p>Create link from gitweb to web server folder;</p>

        <pre>
        # ln -s /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 g+rx /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>