Download as
Browse Code »

Commit c296ecfb59fcb2d4588f9f4352ec784ab899ec01

Authored by dosire
1 parent 07157799
Exists in spb-stable and in 3 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb

Remove duplication with readme. Remove unneeded spaces. Prevent people writing ~… 

…git in the documentation. Descriptive headers.
Showing 2 changed files with 29 additions and 21 deletions   Show diff stats
README.md
  Diff comments   View file @c296ecf
... ... @@ -68,11 +68,9 @@
68 68  
69 69 ### New versions and upgrading
70 70  
71   -Since 2011 GitLab is released on the 22nd of every month. Every new release includes an upgrade guide.
  71 +Since 2011 GitLab is released on the 22nd of every month. Every new release includes an [upgrade guide](doc/update) and new features are detailed in the [Changelog](CHANGELOG).
72 72  
73   -* [Upgrade guides](doc/update)
74   -
75   -* [Changelog](CHANGELOG)
  73 +It is recommended to follow a monthly upgrade schedule. Security releases come out when needed. For more information about the release process see the documentation for [monthly](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/release/monthly.md) and [security](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/release/security.md) releases.
76 74  
77 75 * Features that will be in the next releases are listed on [the feedback and suggestions forum](http://feedback.gitlab.com/forums/176466-general) with the status [started](http://feedback.gitlab.com/forums/176466-general/status/796456) and [completed](http://feedback.gitlab.com/forums/176466-general/status/796457).
78 76  
... ...
doc/development/architecture.md
  Diff comments   View file @c296ecf
... ... @@ -3,23 +3,25 @@
3 3  
4 4 # Software delivery
5 5  
6   -There's two editions of GitLab: [Enterprise Edition](https://www.gitlab.com/features/) (EE) and [Community Edition](http://gitlab.org/gitlab-ce/) (CE). GitLab CE is delivered via git from the [gitlabhq repository](https://gitlab.com/gitlab-org/gitlab-ce/tree/master). New versions of GitLab are released in stable branches and the master branch is for bleeding edge development. EE releases are available not long after CE releases. To obtain the GitLab EE there is a [repository at gitlab.com](https://gitlab.com/subscribers/gitlab-ee). A new version of CE is delivered every month on the 22nd of the month. For this reason it is recommended to follow a monthly upgrade schedule because usually one can't skip versions when upgrading but must upgrade incrementally. Security updates come out on an informal basis.
  6 +There are two editions of GitLab: [Enterprise Edition](https://www.gitlab.com/features/) (EE) and [Community Edition](http://gitlab.org/gitlab-ce/) (CE). GitLab CE is delivered via git from the [gitlabhq repository](https://gitlab.com/gitlab-org/gitlab-ce/tree/master). New versions of GitLab are released in stable branches and the master branch is for bleeding edge development.
7 7  
8   -Both EE and CE require an add-on component called gitlab-shell. It is obtained from the [gitlab-shell repository](https://gitlab.com/gitlab-org/gitlab-shell/tree/master). New versions are usually tags but staying on the master branch will give you the latest stable version. New releases are generally around the same time as GitLab CE releases with exception for informal security updates deemed critical.
  8 +EE releases are available not long after CE releases. To obtain the GitLab EE there is a [repository at gitlab.com](https://gitlab.com/subscribers/gitlab-ee). For more information about the release process see the section 'New versions and upgrading' in the readme.
  9 +
  10 +Both EE and CE require an add-on component called gitlab-shell. It is obtained from the [gitlab-shell repository](https://gitlab.com/gitlab-org/gitlab-shell/tree/master). New versions are usually tags but staying on the master branch will give you the latest stable version. New releases are generally around the same time as GitLab CE releases with exception for informal security updates deemed critical.
9 11  
10 12 # System Layout
11 13  
12   -When referring to `~git` it means the home directory of the `git` user which is typically `/home/git`.
  14 +When referring to ~git in the picures it means the home directory of the git user which is typically /home/git.
13 15  
14   -GitLab is primarily installed within the `/home/git` user home directory as `git` user. Within the home directory is where the gitlabhq server software resides as well as the repositories (though repository location is configurable). The bare repositories are located in `~git/repositories`. GitLab is a ruby on rails application so the particulars of the inner workings can be learned by studying how a ruby on rails application works. To serve repositories over SSH there's an add-on application called gitlab-shell which is installed in `/home/git/gitlab-shell`.
  16 +GitLab is primarily installed within the `/home/git` user home directory as `git` user. Within the home directory is where the gitlabhq server software resides as well as the repositories (though the repository location is configurable). The bare repositories are located in `/home/git/repositories`. GitLab is a ruby on rails application so the particulars of the inner workings can be learned by studying how a ruby on rails application works. To serve repositories over SSH there's an add-on application called gitlab-shell which is installed in `/home/git/gitlab-shell`.
15 17  
16 18 ## Components
17 19  
18 20 ![GitLab Diagram Overview](resources/gitlab_diagram_overview.png "GitLab Diagram Overview")
19 21  
20   -A typical install of GitLab will be on RHEL or Ubuntu Linux. It uses Apache or nginx as a web front end to proxypass the Unicorn web server. Communication between Unicorn and the front end is usually HTTP but access via socket is also supported. The web front end accesses `~git/gitlab/public` bypassing the Unicorn server to serve static pages, uploads (e.g. avatar images or attachments), and precompiled assets. GitLab serves web pages and a [GitLab API](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/api) using the Unicorn web server. It uses Sidekiq as a job queue which, in turn, uses redis as a non-persistent database backend for job information, meta data, and incomming jobs. The GitLab web app uses MySQL or PostgreSQL for persistent database information (e.g. users, permissions, issues, other meta data). GitLab stores the bare git repositories it serves in `~git/repositories` by default. It also keeps default branch and hook information with the bare repository. `~git/gitlab-satellites` keeps checked out repositories when performing actions such as a merge request, editing files in the web interface, etc. The satellite repository is used by the web interface for editing repositories and the wiki which is also a git repository. When serving repositories over HTTP/HTTPS GitLab utilizes the GitLab API to resolve authorization and access as well as serving git objects.
  22 +A typical install of GitLab will be on Ubuntu Linux or RHEL/CentOS. It uses Nginx or Apache as a web front end to proxypass the Unicorn web server. Communication between Unicorn and the front end is usually HTTP but access via socket is also supported. The web front end accesses `/home/git/gitlab/public` bypassing the Unicorn server to serve static pages, uploads (e.g. avatar images or attachments), and precompiled assets. GitLab serves web pages and a [GitLab API](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/api) using the Unicorn web server. It uses Sidekiq as a job queue which, in turn, uses redis as a non-persistent database backend for job information, meta data, and incomming jobs. The GitLab web app uses MySQL or PostgreSQL for persistent database information (e.g. users, permissions, issues, other meta data). GitLab stores the bare git repositories it serves in `/home/git/repositories` by default. It also keeps default branch and hook information with the bare repository. `/home/git/gitlab-satellites` keeps checked out repositories when performing actions such as a merge request, editing files in the web interface, etc. The satellite repository is used by the web interface for editing repositories and the wiki which is also a git repository. When serving repositories over HTTP/HTTPS GitLab utilizes the GitLab API to resolve authorization and access as well as serving git objects.
21 23  
22   -The add-on component gitlab-shell serves repositories over SSH. It manages the SSH keys within `~git/.ssh/authorized_keys` which should not be manually edited. gitlab-shell accesses the bare repositories directly to serve git objects and communicates with redis to submit jobs to Sidekiq for GitLab to process. gitlab-shell queries the GitLab API to determine authorization and access.
  24 +The add-on component gitlab-shell serves repositories over SSH. It manages the SSH keys within `/home/git/.ssh/authorized_keys` which should not be manually edited. gitlab-shell accesses the bare repositories directly to serve git objects and communicates with redis to submit jobs to Sidekiq for GitLab to process. gitlab-shell queries the GitLab API to determine authorization and access.
23 25  
24 26 ## Installation Folder Summary
25 27  
... ... @@ -30,7 +32,7 @@ To summarize here's the [directory structure of the `git` user home directory](.
30 32  
31 33 ps aux | grep '^git'
32 34  
33   -GitLab has several components to operate. As a system user (i.e. any user that is not the `git` user) it requires a persistent database (MySQL/PostreSQL) and redis database. It also uses Apache httpd or nginx to proxypass Unicorn. As the `git` user it starts Sidekiq and Unicorn (a simple ruby HTTP server running on port `8080` by default). Under the gitlab user there are normally 6 processes: `unicorn_rails master` (1 process), `unicorn_rails worker` (2 processes), `python pygments` (2 processes), `sidekiq` (1 process). Pygments is used by GitLab for syntax highlighting in the web interface.
  35 +GitLab has several components to operate. As a system user (i.e. any user that is not the `git` user) it requires a persistent database (MySQL/PostreSQL) and redis database. It also uses Apache httpd or nginx to proxypass Unicorn. As the `git` user it starts Sidekiq and Unicorn (a simple ruby HTTP server running on port `8080` by default). Under the gitlab user there are normally 4 processes: `unicorn_rails master` (1 process), `unicorn_rails worker` (2 processes), `sidekiq` (1 process).
34 36  
35 37 ## Repository access
36 38  
... ... @@ -38,24 +40,32 @@ Repositories get accessed via HTTP or SSH. HTTP cloning/push/pull utilizes the G
38 40  
39 41 # Troubleshooting
40 42  
41   -See also the [IRC F.A.Q.](https://github.com/gitlabhq/gitlab-public-wiki/wiki/IRC-channel-Guidelines-and-F.A.Q.) and [Troubleshooting Guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki).
  43 +See the README for more information.
42 44  
43   -## Services
  45 +## Init scripts of the services
44 46  
45   -GitLab (includes Unicorn and Sidekiq), redis (non-persistent DB), SSH (all of the following)
  47 +The GitLab init script starts and stops Unicorn and Sidekiq.
46 48  
47 49 ```
48 50 /etc/init.d/gitlab
49 51 Usage: service gitlab {start|stop|restart|reload|status}
  52 +```
50 53  
  54 +Redis (key-value store/non-persistent database)
  55 +
  56 +```
51 57 /etc/init.d/redis
52 58 Usage: /etc/init.d/redis {start|stop|status|restart|condrestart|try-restart}
  59 +```
  60 +
  61 +SSH daemon
53 62  
  63 +```
54 64 /etc/init.d/sshd
55 65 Usage: /etc/init.d/sshd {start|stop|restart|reload|force-reload|condrestart|try-restart|status}
56 66 ```
57 67  
58   -Web front end (one of the following)
  68 +Web server (one of the following)
59 69  
60 70 ```
61 71 /etc/init.d/httpd
... ... @@ -75,17 +85,17 @@ $ /etc/init.d/postgresql
75 85 Usage: /etc/init.d/postgresql {start|stop|restart|reload|force-reload|status} [version ..]
76 86 ```
77 87  
78   -## Log locations
  88 +## Log locations of the services
79 89  
80   -Note: `~git/` is shorthand for `/home/git`.
  90 +Note: `/home/git/` is shorthand for `/home/git`.
81 91  
82 92 gitlabhq (includes Unicorn and Sidekiq logs)
83 93  
84   -* `~git/gitlab/log/` contains `application.log`, `production.log`, `sidekiq.log`, `unicorn.stdout.log`, `githost.log`, `satellites.log`, and `unicorn.stderr.log` normally.
  94 +* `/home/git/gitlab/log/` contains `application.log`, `production.log`, `sidekiq.log`, `unicorn.stdout.log`, `githost.log`, `satellites.log`, and `unicorn.stderr.log` normally.
85 95  
86 96 gitlab-shell
87 97  
88   -* `~git/gitlab-shell/gitlab-shell.log`
  98 +* `/home/git/gitlab-shell/gitlab-shell.log`
89 99  
90 100 ssh
91 101  
... ... @@ -117,13 +127,13 @@ MySQL
117 127  
118 128 ## GitLab specific config files
119 129  
120   -GitLab has configuration files located in `~git/gitlab/config/*`. Commonly referenced config files include:
  130 +GitLab has configuration files located in `/home/git/gitlab/config/*`. Commonly referenced config files include:
121 131  
122 132 * `gitlab.yml` - GitLab configuration.
123 133 * `unicorn.rb` - Unicorn web server settings.
124 134 * `database.yml` - Database connection settings.
125 135  
126   -gitlab-shell has a configuration file at `~git/gitlab-shell/config.yml`.
  136 +gitlab-shell has a configuration file at `/home/git/gitlab-shell/config.yml`.
127 137  
128 138 ## Maintenance Tasks
129 139  
... ...