GitRoot

 1<!--
 2SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
 3
 4SPDX-License-Identifier: CC-BY-SA-4.0
 5-->
 6
 7# GitRoot documentation
 8
 9Welcome in the GitRoot documentation.
10
11This documentation cover from [first](./tutorials/from_zero_to_hero.md) usage with an instance already deployed to [the deployment](./tutorials/deploy_instance.md) of an instance in a VPS server.
12
13You will also find a lot of [how-to](#how-to), some more [technicals](#technicals) explanations and some [rationales](#rationales) about the project itself.
14
15## How to test
16
17Today you need to deploy GitRoot before behing able to try it. Soon I hope to deploy a demo instance, like that you will be able to try it without install.
18
19## Tutorials
20
21- [From zero to hero](./tutorials/from_zero_to_hero.md): launch GitRoot locally, create a repo, install a first plugin and use it
22- [Use an instance](./tutorials/use_instance.md): use an instance as a guest
23- [Deploy an instance](./tutorials/deploy_instance.md): deploy an instance on a vps
24
25## How-To
26
27### Repositories
28
29- [create a repository](./how-tos/create_repository.md)
30- [delete a repository](./how-tos/delete_repository.md)
31- [push force](./how-tos/force_push.md)
32
33### Users
34
35- [add an user](./how-tos/add_user.md)
36- [delete an user](./how-tos/delete_user.md)
37- [ban an user](./how-tos/ban_user.md)
38
39### Plugins
40
41- [install a plugin](./how-tos/install_plugin.md)
42- [active a plugin](./how-tos/active_plugin.md)
43- [plugn rights](./how-tos/plugin_rights.md)
44- [delete a plugin](./how-tos/delete_plugin.md)
45
46### Web
47
48- [customize your repository](./how-tos/customize_web.md)
49
50### More advanced usage
51
52- [no anonymous push](./how-tos/no_anonymous_user.md)
53- [all contributors can push on all branch](./how-tos/contributors_can_write_all.md)
54- [manually init git client](./how-tos/manual_init_client.md)
55
56## Technicals
57
58- [contributing](../CONTRIBUTING.md): how to contribute
59- [readme](../README.md): install, run locally and test the code
60- [default branch](./technicals/default_branch.md): most important branch
61- [.gitroot/users.yml specification](./technicals/users_file.md): most important file
62- .gitroot/repositories.yml specification
63- .gitroot/plugins.yml specification
64
65## Rationales
66
67- [licence EUPL](./rationales/rationale_licence.md): why EUPL? Why not aGPL?
68- [golang language](./rationales/rationale_golang.md): why golang?