README.md 4.37 KB
Newer Older
1
## GitLab: self hosted Git management software
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
2

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
3
![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
4

5
6
7
8
9
10
11
### GitLab allows you to
 * keep your code secure on your own server
 * manage repositories, users and access permissions
 * communicate though issues, line-comments and wiki's
 * perform code reviews with merge requests

### GitLab is
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
12

13
14
15
* powered by Ruby on Rails
* completely free and open source (MIT license)
* used by 10.000 organization to keep their code secure
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
16

17
### Code status
Nihad Abbasov's avatar
Nihad Abbasov committed
18

19
* [![build status](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch)
Nihad Abbasov's avatar
Nihad Abbasov committed
20

21
* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) travis-ci.org (master branch)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
22

Un1matr1x's avatar
Un1matr1x committed
23
* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
24

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
25
* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
26

27
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
28

29
30
31
32
33
* GitLab.org community site: [Homepage](http://gitlab.org) [Screenshots](http://gitlab.org/screenshots/) [Blog](http://blog.gitlab.org/) [Demo](http://demo.gitlabhq.com/users/sign_in)

* GitLab.com: [Homepage](http://blog.gitlab.com/) [Hosted pricing](http://blog.gitlab.com/pricing/) [Services](http://blog.gitlab.com/services/) [Blog](http://blog.gitlab.com/blog/)

* GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
Nihad Abbasov's avatar
Nihad Abbasov committed
34

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
35
### Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
36

37
* Ubuntu/Debian*
Valeriy Sizov's avatar
Valeriy Sizov committed
38
* ruby 1.9.3+
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
39
* MySQL
Nihad Abbasov's avatar
Nihad Abbasov committed
40
* git
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
41
* gitlab-shell
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
42
* redis
Nihad Abbasov's avatar
Nihad Abbasov committed
43

44
45
* More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)

46
47
48
### Installation

You can either follow the "ordinary" Installation guide to install it on a machine or use the Vagrant virtual machine. The Installation guide is recommended to set up a production server. The Vargrant virtual machine is recommended for development since it makes it much easier to set up all the dependencies for integration testing.
49
50
51
52
53
54
55

* [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)

* [Installation guide for the current master branch](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)

* [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)

56
### Starting
57

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
58
1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab with:
59

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
60
        sudo service gitlab start
61

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
62
  or
63

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
64
        sudo /etc/init.d/gitlab restart
65

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
66
2. Start it with [Foreman](https://github.com/ddollar/foreman) in development model
67

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
68
        bundle exec foreman start -p 3000
69

Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
70
3. Start it manually in development mode
71

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
72
73
        bundle exec rails s
        bundle exec rake sidekiq:start
74
75
76
77
78

### Running the tests

* Seed the database with

79
80
    bundle exec rake db:setup RAILS_ENV=test
    bundle exec rake db:seed_fu RAILS_ENV=test
81
82

* Run all tests
83

84
    bundle exec rake gitlab:test
85
86

* Rspec unit and functional tests
87

88
    bundle exec rake spec
89
90

* Spinach integration tests
91

92
    bundle exec rake spinach
93
94
95
96
97
98
99
100
101
102
103
104

### Getting help

* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)

* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq)

* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general)

* [Paid support](http://blog.gitlab.com/support/)

* [Paid services](http://blog.gitlab.com/services/)
105

106
107
108
109
110
111
112
113
### New versions and the API

Each month on the 22th a new version is released together with an upgrade guide.

* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)

* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)

114
115
### Other documentation

116
117
* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)

118
119
120
121
* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)

* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes)

122
### Getting in touch
Nihad Abbasov's avatar
Nihad Abbasov committed
123

124
* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
Nihad Abbasov's avatar
Nihad Abbasov committed
125

126
* [Core team](https://github.com/gitlabhq?tab=members)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
127

128
* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
Nihad Abbasov's avatar
Nihad Abbasov committed
129

130
* [Leader](https://github.com/randx)
Nihad Abbasov's avatar
Nihad Abbasov committed
131

132
* [Contact page](http://gitlab.org/contact/)