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

166 lines
7.8 KiB
Markdown
Raw Normal View History

## GitLab: self hosted Git management software
2013-02-27 11:09:48 -05:00
2013-02-27 14:05:57 -05:00
![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png)
2013-02-27 11:09:48 -05:00
![animated-screenshots](https://gist.github.com/fnkr/2f9badd56bfe0ed04ee7/raw/4f48806fbae97f556c2f78d8c2d299c04500cb0d/compiled.gif)
2013-06-23 15:54:24 -04: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 14:05:57 -05:00
* powered by Ruby on Rails
* completely free and open source (MIT license)
* used by more than 25.000 organizations to keep their code secure
2013-02-27 14:05:57 -05:00
### Code status
2011-11-15 09:41:33 -05:00
* [![build status](http://ci.gitlab.org/projects/1/status.png?ref=master)](http://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch)
2011-11-15 09:41:33 -05:00
2013-02-28 12:30:07 -05:00
* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
2013-06-24 12:54:08 -04:00
* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq) this button can be yellow (small updates are available) but must not be red (a security fix or an important update is available), gems are updated in major releases of GitLab.
2011-11-25 17:30:51 -05:00
2013-03-10 14:29:34 -04:00
* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq)
### Resources
2011-11-15 09:41:33 -05: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 Enterprise Edition](https://www.gitlab.com/features/) offers additional features that are useful for larger organizations (100+ users).
* [GitLab CI](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) is a continuous integration (CI) server that is easy to integrate with GitLab.
2011-11-15 09:41:33 -05:00
2013-02-27 14:05:57 -05:00
### Requirements
2011-11-15 09:41:33 -05:00
* Ubuntu/Debian**
2013-09-19 04:45:31 -04:00
* ruby 1.9.3+
* git 1.7.10+
* redis 2.0+
* MySQL or PostgreSQL
2011-11-15 09:41:33 -05:00
** More details are in the [requirements doc](doc/install/requirements.md)
### Installation
#### Official installation methods
2013-03-02 17:27:52 -05:00
* [Manual installation guide for a production server](doc/install/installation.md)
* [GitLab Chef Cookbook](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/README.md) This cookbook can be used both for development installations and production installations. If you want to [contribute](CONTRIBUTE.md) to GitLab we suggest you follow the [development installation on a virtual machine with Vagrant](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/doc/development.md) instructions to install all testing dependencies.
#### Third party one-click installers
* [Digital Ocean 1-Click Application Install](https://www.digitalocean.com/blog_posts/host-your-git-repositories-in-55-seconds-with-gitlab) Have a new server up in 55 seconds. Digital Ocean uses SSD disks which is great for an IO intensive app such as GitLab.
* [BitNami one-click installers](http://bitnami.com/stack/gitlab) This package contains both GitLab and GitLab CI. It is available as installer, virtual machine or for cloud hosting providers (Amazon Web Services/Azure/etc.).
#### Unofficial installation methods
* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) repository with unofficial guides for using GitLab with different software (operating systems, webservers, etc.) than the official version.
* [Installation guides](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Unofficial-Installation-Guides) public wiki with unofficial guides to install GitLab on different operating systems.
### New versions and upgrading
Since 2011 GitLab is released on the 22nd of every month. Every new release includes an upgrade guide.
* [Upgrade guides](doc/update)
* [Changelog](CHANGELOG)
2013-09-08 06:31:00 -04:00
* 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).
### Run in production mode
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:
sudo service gitlab start
or by directly calling the script
2013-03-02 17:27:52 -05:00
sudo /etc/init.d/gitlab start
2013-03-02 17:27:52 -05:00
### Run in development mode
Start it with [Foreman](https://github.com/ddollar/foreman)
2013-03-02 17:27:52 -05:00
bundle exec foreman start -p 3000
2013-03-02 17:27:52 -05:00
or start each component separately
2013-03-02 17:27:52 -05:00
bundle exec rails s
script/background_jobs start
2013-03-02 17:27:52 -05:00
### Run the tests
2013-03-02 17:27:52 -05:00
* Seed the database
2013-03-02 17:27:52 -05:00
2013-03-03 11:22:56 -05:00
bundle exec rake db:setup RAILS_ENV=test
bundle exec rake db:seed_fu RAILS_ENV=test
2013-03-02 17:27:52 -05:00
* Run all tests
2013-03-02 17:38:48 -05:00
bundle exec rake gitlab:test RAILS_ENV=test
2013-03-02 17:27:52 -05:00
2013-05-03 04:03:49 -04:00
* [RSpec](http://rspec.info/) unit and functional tests
2013-03-02 17:38:48 -05:00
All RSpec tests: bundle exec rake spec
Single RSpec file: bundle exec rspec spec/controllers/commit_controller_spec.rb
2013-03-02 17:27:52 -05:00
* [Spinach](https://github.com/codegram/spinach) integration tests
2013-03-02 17:38:48 -05:00
All Spinach tests: bundle exec rake spinach
Single Spinach test: bundle exec spinach features/project/issues/milestones.feature
### GitLab interfaces
* [GitLab API doc](doc/api/README.md) or see the [GitLab API website](http://api.gitlab.org/)
* [Rake tasks](doc/raketasks) including a [backup and restore procedure](doc/raketasks/backup_restore.md)
* [Directory structure](doc/install/structure.md)
* [Database installation](doc/install/databases.md)
2013-03-02 17:27:52 -05:00
* [Markdown specification](doc/markdown/markdown.md)
* [Security guide](doc/security/rack_attack.md) to throttle abusive requests
2013-03-02 17:27:52 -05:00
### Getting help
2013-03-02 17:27:52 -05:00
* [Maintenance policy](MAINTENANCE.md) specifies what versions are supported.
* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) contains solutions to common problems.
* [Mailing list](https://groups.google.com/forum/#!forum/gitlabhq) and [Stack Overflow](http://stackoverflow.com/questions/tagged/gitlab) are the best places 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 has resolved it. 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 17:27:52 -05:00
2013-04-17 16:00:31 -04:00
* [Feedback and suggestions forum](http://feedback.gitlab.com) is the place to propose and discuss new features for GitLab.
2013-03-02 17:38:48 -05: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.
* [Support subscription](http://www.gitlab.com/subscription/) connects you to the knowledge of GitLab experts that will resolve your issues and answer your questions.
2013-03-02 17:27:52 -05:00
* [Consultancy](http://www.gitlab.com/consultancy/) from the GitLab experts for installations, upgrades and customizations.
* [#gitlab IRC channel](http://www.freenode.net/) on Freenode is unofficial but offers a way to get in touch with other GitLab users who may be able to help you.
2013-12-07 12:03:02 -05:00
* [Book](http://www.packtpub.com/gitlab-repository-management/book) written by GitLab enthusiast Jonathan M. Hethey is unofficial but it offers a good overview.
2013-03-02 17:38:48 -05:00
### Getting in touch
2011-11-15 09:41:33 -05:00
2013-10-02 08:43:11 -04:00
* [Core team](http://gitlab.org/team/)
2011-12-06 16:11:22 -05:00
2013-10-02 08:43:11 -04:00
* [Contributors](http://contributors.gitlab.org/)
2011-11-15 09:41:33 -05:00
2013-10-02 08:43:11 -04:00
* [Community](http://gitlab.org/community/)