gitlab-org--gitlab-foss/README.md

162 lines
6.3 KiB
Markdown
Raw Normal View History

## GitLab: self hosted Git management software
2013-02-27 16:09:48 +00:00
2013-02-27 19:05:57 +00:00
![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png)
2013-02-27 16:09:48 +00:00
### GitLab allows you to
* keep your code secure on your own server
* manage repositories, users and access permissions
* communicate through issues, line-comments and wiki pages
* perform code review with merge requests
### GitLab is
2013-02-27 19:05:57 +00:00
* powered by Ruby on Rails
* completely free and open source (MIT license)
* used by more than 10.000 organizations to keep their code secure
2013-02-27 19:05:57 +00:00
### Code status
2011-11-15 14:41:33 +00:00
2013-04-09 07:14:11 +00:00
* [![build status](http://ci.gitlab.org/projects/1/status.png?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch)
2011-11-15 14:41:33 +00:00
* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) travis-ci.org (master branch)
2013-02-27 19:05:57 +00:00
2013-02-28 17:30:07 +00:00
* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
2013-02-27 19:05:57 +00:00
* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq)
2011-11-25 22:30:51 +00:00
2013-03-10 18:29:34 +00:00
* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)
### Resources
2011-11-15 14:41:33 +00:00
* 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 commercial services: [Homepage](http://www.gitlab.com/) [Subscription](http://www.gitlab.com/subscription/) [Consultancy](http://www.gitlab.com/consultancy/) [GitLab Cloud](http://www.gitlab.com/cloud/) [Blog](http://blog.gitlab.com/)
* GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
2011-11-15 14:41:33 +00:00
2013-02-27 19:05:57 +00:00
### Requirements
2011-11-15 14:41:33 +00:00
* Ubuntu/Debian**
2013-03-12 12:16:55 +00:00
* ruby 1.9.3
2012-11-21 10:52:55 +00:00
* MySQL
2011-11-15 14:41:33 +00:00
* git
2013-02-27 16:09:48 +00:00
* gitlab-shell
2012-01-02 20:34:49 +00:00
* redis
2011-11-15 14:41:33 +00:00
** More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
2013-03-02 22:27:52 +00:00
### Installation
2013-05-06 15:08:09 +00:00
Check out our [maintenance policy](MAINTENANCE.md) to see what versions are supported.
#### Official production installation
* [Installation guide for a production server](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
#### Official development installation
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 with all dependencies.
* [Vagrant virtual machine for development](https://github.com/gitlabhq/gitlab-vagrant-vm)
#### Unsupported production installation
* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) for setup on different platforms
* [Unofficial installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides)
* [BitNami one-click installers](http://bitnami.com/stack/gitlab)
* [TurnKey Linux virtual appliance](http://www.turnkeylinux.org/gitlab)
### New versions and upgrading
Each month on the 22th a new version is released together with an upgrade guide.
* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/tree/master/doc/update)
* [Changelog](https://github.com/gitlabhq/gitlabhq/blob/master/CHANGELOG)
2013-04-03 07:00:01 +00:00
* Features that will be in the next release are listed on [the feedback and suggestions forum with the status "started"](http://feedback.gitlab.com/forums/176466-general/status/796456).
### Run in production mode
1. The Installation guide contains instructions on how to download an init script and run it automatically on boot. You can also start the init script manually:
2013-03-03 16:21:36 +00:00
sudo service gitlab start
or by directly calling the script
2013-03-02 22:27:52 +00:00
sudo /etc/init.d/gitlab start
2013-03-02 22:27:52 +00:00
### Run in development mode
Start it with [Foreman](https://github.com/ddollar/foreman)
2013-03-02 22:27:52 +00:00
2013-03-03 16:21:36 +00:00
bundle exec foreman start -p 3000
2013-03-02 22:27:52 +00:00
or start each component separately
2013-03-02 22:27:52 +00:00
2013-03-03 16:21:36 +00:00
bundle exec rails s
bundle exec rake sidekiq:start
2013-03-02 22:27:52 +00:00
### Run the tests
2013-03-02 22:27:52 +00:00
* Seed the database
2013-03-02 22:27:52 +00:00
2013-03-03 16:22:56 +00:00
bundle exec rake db:setup RAILS_ENV=test
bundle exec rake db:seed_fu RAILS_ENV=test
2013-03-02 22:27:52 +00:00
* Run all tests
2013-03-02 22:38:48 +00:00
2013-03-03 16:22:56 +00:00
bundle exec rake gitlab:test
2013-03-02 22:27:52 +00:00
2013-05-03 08:03:49 +00:00
* [RSpec](http://rspec.info/) unit and functional tests
2013-03-02 22:38:48 +00:00
2013-03-03 16:22:56 +00:00
bundle exec rake spec
2013-03-02 22:27:52 +00:00
* [Spinach](https://github.com/codegram/spinach) integration tests
2013-03-02 22:38:48 +00:00
2013-03-03 16:22:56 +00:00
bundle exec rake spinach
### GitLab interfaces
* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
* [Directory structure](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/structure.md)
* [Databases](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/databases.md)
2013-03-02 22:27:52 +00:00
### Getting help
2013-03-02 22:27:52 +00:00
* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq) is the best place to ask questions. For example you can use it if you have questions about: permission denied errors, invisible repos, can't clone/pull/push or with web hooks that don't fire. Please search for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there to a fix.
2013-03-02 22:27:52 +00:00
2013-04-17 20:00:31 +00:00
* [Feedback and suggestions forum](http://feedback.gitlab.com) is the place to propose and discuss new features for GitLab.
2013-03-02 22:38:48 +00:00
* [Support subscription](http://www.gitlab.com/subscription/) connect you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
2013-03-02 22:27:52 +00:00
2013-04-21 14:49:23 +00:00
* [Consultancy](http://www.gitlab.com/consultancy/) allows you hire GitLab experts for installations, upgrades and customizations.
2013-03-02 22:38:48 +00:00
2013-04-17 20:00:31 +00:00
* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) describes how to submit pull requests and issues. Pull requests and issues not in line with the guidelines in this document will be closed.
2013-03-02 22:38:48 +00:00
### Getting in touch
2011-11-15 14:41:33 +00:00
* [Core team](https://github.com/gitlabhq?tab=members)
2011-12-06 21:11:22 +00:00
* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
2011-11-15 14:41:33 +00:00
* [Leader](https://github.com/randx)
2011-11-15 14:41:33 +00:00
* [Contact page](http://gitlab.org/contact/)