Documentation

Welcome in the GitRoot documentation.

This documentation cover from first usage with an instance already deployed to the deployment of an instance in a VPS server.

You will also find a lot of how-to, some more technicals explanations and some rationales about the project itself.

How to test

Today 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.

Tutorials

• From zero to hero: launch GitRoot locally, create a repo, install a first plugin and use it
• Use an instance: use an instance as a guest
• Deploy an instance: deploy an instance on a vps

How-To

Repositories

• create a repository
• delete a repository
• push force

Users

• add an user
• delete an user
• ban an user

Plugins

• install a plugin
• active a plugin
• plugn rights
• delete a plugin

Web

• customize your repository
• manage web thanks to SFTP

More advanced usage

• no anonymous push
• all contributors can push on all branch

Technicals

• contributing: how to contribute
• readme: install, run locally and test the code
• default branch: most important branch
• .gitroot/users.yml specification: most important file
• .gitroot/repoConfiguration.yml specification: repository configuration
• .gitroot/repositories.yml specification: repositories definitions
• .gitroot/plugins.yml specification
• root repository: most important repository
• executors: run commands outside of wasm

Rationales

• licence EUPL: why EUPL? Why not aGPL?
• golang language: why golang?