GitRoot

 1# GitRoot
 2
 3Welcome in your new git repository.
 4
 5## First configure your repo
 6
 7GitRoot force to use signed commit. Configure your git client for this repository by executing:
 8
 9```sh
10.gitroot/init.sh
11```
12
13> Don't want to run unknown sh? See [manually init client](https://gitroot.dev/doc/how-tos/manual_init_client.html).
14
15## Add collaborators
16
17In any GitRoot repository you will find a `.gitroot/users.yml` file. To add a user just append its informations in the right group.
18
19```yml
20owner:
21  branches:
22    - name: main
23  users:
24    - pseudo: GitRoot
25      avatar: ""
26      emails:
27        - GitRoot@yourinstance.com
28      ssh:
29        - SSH
30    - pseudo: You
31      avatar: ""
32      emails:
33        - you@yourinstance.com
34      ssh:
35        - SSH
36group:
37  branches:
38    - name: main
39  users:
40    - pseudo: PSEUDO
41      avatar: ""
42      emails:
43        - EMAIL
44      ssh:
45        - SSH
46```
47
48`group` is the group name where user will reside. You can choose any name you want, gitroot don't use it (but don't delete owner group). Group is just a convenience way to group users.
49
50Each group manage `branches`. Every branch name in this group means only user of this group can write to them. All others branches will be "open" and anyone can write to them.
51
52Each group have `users`. A user is at least a ssh key. All others informations are here for convience and not used by gitroot (today).
53
54## Active plugins
55
56In any GitRoot repository you will find a `.gitroot/plugins.yml` file. It contain all plugins available in your instance. To active one, just change the boolean `active` to `true`, commit and push.
57
58## Need more?
59
60Read the official [https://gitroot.dev/doc/](https://gitroot.dev/doc/).