diff --git a/doc/install/structure.md b/doc/install/structure.md index 536c933c3bff0906d4d06875e281e770e04c8741..a67e12cc217d9aafb92e223b5452145731d8c985 100644 --- a/doc/install/structure.md +++ b/doc/install/structure.md @@ -1,24 +1,41 @@ -## Description of GitLab structure +# GitLab directory structure - -### Directory structure +This is the directory structure you will end up with following the instructions in the Installation Guide. |-- home | |-- gitlab + | |-- .ssh | |-- gitlab | |-- gitlab-satellites | |-- git - | |-- repositories | |-- .gitolite + | |-- .ssh + | |-- bin + | |-- gitolite + | |-- repositories + + +**/home/gitlab/.ssh** + Contains the Gitolite admin key GitLab uses to configure Gitolite. + +**/home/gitlab/gitlab** + This is where GitLab lives. + +**/home/gitlab/gitlab-satellites** + Contains a copy of all repositories with a working tree. + It's used for merge requests, editing files, etc. +**/home/git/.ssh** + Contains the SSH access configuration managed by Gitolite. -gitlab - Holds all the code of gitlab application. +**/home/git/bin** + Contains Gitolite executables. -gitlab-satellites - Contains a copy of all repositories with working tree. - Used to automatically merge requests, edit files etc... +**/home/git/gitolite** + This is where Gitolite lives. -repositories - Keeps all you repositories in bare format here +**/home/git/repositories** + Holds all your repositories in bare format. + This is the place Git uses when you pull/push to your projects. +You can change them in your `config/gitlab.yml` file.