File: README.md

package info (click to toggle)
puppet-module-cirrax-gitolite 1.3.3-2
  • links: PTS
  • area: main
  • in suites: bullseye, sid
  • size: 192 kB
  • sloc: ruby: 69; sh: 10; makefile: 2
file content (101 lines) | stat: -rw-r--r-- 3,009 bytes parent folder | download
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
# gitolite puppet module

[![Build Status](https://travis-ci.org/cirrax/puppet-gitolite.svg?branch=master)](https://travis-ci.org/cirrax/puppet-gitolite)
[![Puppet Forge](https://img.shields.io/puppetforge/v/cirrax/gitolite.svg?style=flat-square)](https://forge.puppetlabs.com/cirrax/gitolite)
[![Puppet Forge](https://img.shields.io/puppetforge/dt/cirrax/gitolite.svg?style=flat-square)](https://forge.puppet.com/cirrax/gitolite)
[![Puppet Forge](https://img.shields.io/puppetforge/e/cirrax/gitolite.svg?style=flat-square)](https://forge.puppet.com/cirrax/gitolite)
[![Puppet Forge](https://img.shields.io/puppetforge/f/cirrax/gitolite.svg?style=flat-square)](https://forge.puppet.com/cirrax/gitolite)

#### Table of Contents

1. [Overview](#overview)
1. [Usage](#usage)
1. [Reference](#reference)
1. [Contribuiting](#contributing)


## Overview

This module is used to configure gitolite and to configure git repositories and permissions.


## Usage

To start using gitolite you need to include the gitolite main class.

A minimal example might be:

~~~
class{'gitolite':
  user     => 'gitolite',
  userhome => '/srv/gitolite',
}
~~~

The gitolite::admin class is only used if you like to do all admin work through
puppet (like create new repos, users and permissions).
If gitolite::admin is not included, you can use the admin git repo to do these tasks (feature of gitolite).

## Reference

Find documentation about possible parameters on top of each manifest.
Also see [REFERENCE.md](REFERENCE.md)

### classes

#### gitolite
The main class to install and configure gitolite.

#### gitolite::admin
This class manages the gitolite.conf file
and prepares to manage the ssh keys with puppet.

Use this class if you want to do all admin work through puppet
(add users, repositories and permissions)

do not use this class if you want to use the
gitolite-admin.git repositoy for these tasks.
(you have been warned ! if you use it once,
there is no puppet way back, only manual work
will get you back)

#### gitolite::client
Install the git package.

#### gitolite::ssh_key
Generate an SSH authentication key for authentication
to a remote system (eg. for git hooks).

#### gitolite::params
System specific parameters.


### defined types

#### gitolite::repo
Define git repositories

#### gitolite::repos
Define several git repositories with merged default values.

#### gitolite::user
This resources defines a git user

#### gitolite::users
Define several git users with merged default values.


## Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint
and the available spec tests  in order to follow the recommended Puppet style guidelines
from the Puppet Labs style guide.

### Authors

This module is mainly written by [Cirrax GmbH](https://cirrax.com).

See the [list of contributors](https://github.com/cirrax/puppet-gitolite/graphs/contributors)
for a list of all contributors.