GitRoot

 1# GitRoot
 2
 3Welcome in your new git repository.
 4
 5## Add collaborators
 6
 7In any GitRoot repository you will find a `.gitroot/users.yml` file. To add a user just append its informations in the right group.
 8
 9```yml
10owner:
11  branches:
12    - name: main
13  users:
14    - pseudo: GitRoot
15      avatar: ""
16      emails:
17        - GitRoot@yourinstance.com
18      ssh:
19        - SSH
20    - pseudo: You
21      avatar: ""
22      emails:
23        - you@yourinstance.com
24      ssh:
25        - SSH
26group:
27  branches:
28    - name: main
29  users:
30    - pseudo: PSEUDO
31      avatar: ""
32      emails:
33        - EMAIL
34      ssh:
35        - SSH
36```
37
38`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.
39
40Each 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.
41
42Each group have `users`. A user is at least a ssh key. All others informations are here for convience and not used by gitroot (today).
43
44## Active plugins
45
46In 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.
47
48## Need more?
49
50Read the official [https://gitroot.dev/doc/](https://gitroot.dev/doc/).