README.md 4.57 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
### GitLab allows you to
 * keep your code secure on your own server
 * manage repositories, users and access permissions
8
9
 * communicate through issues, line-comments and wiki pages
 * perform code review with merge requests
10
11

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

13
14
* powered by Ruby on Rails
* completely free and open source (MIT license)
15
* used by 10.000 organizations 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
28
* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)

29
### Resources
Nihad Abbasov's avatar
Nihad Abbasov committed
30

31
32
33
34
35
* 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
36

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
37
### Requirements
Nihad Abbasov's avatar
Nihad Abbasov committed
38

39
* Ubuntu/Debian**
40
* ruby 1.9.3
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
41
* MySQL
Nihad Abbasov's avatar
Nihad Abbasov committed
42
* git
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
43
* gitlab-shell
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
44
* redis
Nihad Abbasov's avatar
Nihad Abbasov committed
45

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

48
49
### Installation

50
#### For production
51

52
53
54
Follow the installation guide for production server.

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

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

58
59
60
61
62

#### For development

If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working sandboxed and with all dependencies.

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

65
### Starting
66

67
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
68

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
69
        sudo service gitlab start
70

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
71
  or
72

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
73
        sudo /etc/init.d/gitlab restart
74

75
2. Start it with [Foreman](https://github.com/ddollar/foreman) in development mode
76

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
77
        bundle exec foreman start -p 3000
78

79
 or start it manually
80

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
81
82
        bundle exec rails s
        bundle exec rake sidekiq:start
83
84
85

### Running the tests

86
* Seed the database
87

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
88
89
        bundle exec rake db:setup RAILS_ENV=test
        bundle exec rake db:seed_fu RAILS_ENV=test
90
91

* Run all tests
92

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
93
        bundle exec rake gitlab:test
94
95

* Rspec unit and functional tests
96

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
97
        bundle exec rake spec
98
99

* Spinach integration tests
100

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
101
        bundle exec rake spinach
102
103
104
105
106
107
108
109
110
111
112
113

### 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/)
114

115
116
117
118
119
120
121
122
### 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)

123
124
### Other documentation

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

127
128
129
130
* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)

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

131
### Getting in touch
Nihad Abbasov's avatar
Nihad Abbasov committed
132

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

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

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

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

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