Switch branches/tags
Find file History
Latest commit fde837d Oct 16, 2017 @smcgivern smcgivern Merge branch 'implements-closing-docs' into 'master'
Docs for Add "implements" to the default issue closing message regex

See merge request gitlab-org/gitlab-ce!14880
Permalink
..
Failed to load latest commit information.
administration Fix LDAP config key name Oct 6, 2017
api Update the settings api documentation Oct 13, 2017
articles fix date Aug 31, 2017
ci Update a bunch of docs images Oct 4, 2017
container_registry Move container_registry user docs to new location Sep 25, 2016
customization Add username parameter to gravatar URL Jun 1, 2017
development Merge branch 'evn-add-profiler' into 'master' Oct 12, 2017
downgrade_ee_to_ce Backports for ee-2112 Jul 6, 2017
gitlab-basics Update Create Project Getting Started Aug 20, 2017
hooks Change doc location of custom hooks Jul 5, 2016
incoming_email Move reply by email docs to a new location Sep 25, 2016
install Update doc accordingly to: Oct 12, 2017
integration Fix Google API callback Oct 11, 2017
intro New doc topic: issues May 8, 2017
legal remove undefined word Corporation from CCLA Aug 16, 2016
logs Move logs/logs.md to administration/logs.md Jun 13, 2016
markdown Move markdown doc to the right location Aug 3, 2016
migrate_ci_to_ce Reorg CE Docs landing page Apr 26, 2017
monitoring Reduce size of images from 25MB to 13MB using pngquant Nov 22, 2016
operations Move operations/ to new location Oct 11, 2016
pages Move all Pages related content to a single location Feb 28, 2017
permissions Move permissions/permissions.md to user/permissions.md Jul 12, 2016
profile Docs new topic: "user/profile/index" Jul 27, 2017
project_services All CI offline migrations Mar 17, 2017
public_access Add an image to the public access documentation and fix wrong profile… Jan 19, 2017
raketasks Resolve "Simple documentation update - backup to restore in restore s… Oct 9, 2017
security More review comments Aug 30, 2017
ssh Add a system check for the git user's custom SSH configuration Sep 4, 2017
system_hooks Remove trailing comma in System Hooks payload examples Aug 8, 2017
topics Merge branch 'docs/openid-connect' into 'master' Oct 4, 2017
university Change mode to 644 for all md and png files Sep 25, 2017
update Update doc accordingly to: Oct 12, 2017
user Update automatic_issue_closing.md Oct 13, 2017
web_hooks Move webhooks to new a location under Integrations Feb 3, 2017
workflow Update fast-forward doc links to point at own docs Sep 20, 2017
README.md index project settings doc from other indexes Sep 8, 2017

README.md

toc

GitLab Documentation

Welcome to GitLab, a Git-based fully featured platform for software development!

GitLab offers the most scalable Git-based fully integrated platform for software development, with flexible products and subscription plans:

  • GitLab Community Edition (CE) is an opensource product, self-hosted, free to use. Every feature available in GitLab CE is also available on GitLab Enterprise Edition (Starter and Premium) and GitLab.com.
  • GitLab Enterprise Edition (EE) is an opencore product, self-hosted, fully featured solution of GitLab, available under distinct subscriptions: GitLab Enterprise Edition Starter (EES) and GitLab Enterprise Edition Premium (EEP).
  • GitLab.com: SaaS GitLab solution, with free and paid subscriptions. GitLab.com is hosted by GitLab, Inc., and administrated by GitLab (users don't have access to admin settings).

GitLab EE contains all features available in GitLab CE, plus premium features available in each version: Enterprise Edition Starter (EES) and Enterprise Edition Premium (EEP). Everything available in EES is also available in EEP.


Shortcuts to GitLab's most visited docs:

GitLab CI/CD Other
Quick start guide API
Configuring .gitlab-ci.yml SSH authentication
Using Docker images GitLab Pages

Getting started with GitLab

User account

  • User account: Manage your account
    • Authentication: Account security with two-factor authentication, setup your ssh keys and deploy keys for secure access to your projects.
    • Profile settings: Manage your profile settings, two factor authentication and more.
  • User permissions: Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.

Projects and groups

Repository

Manage your repositories from the UI (user interface):

Issues and Merge Requests (MRs)

Git and GitLab

  • Git: Getting started with Git, branching strategies, Git LFS, advanced use.
  • Git cheatsheet: Download a PDF describing the most used Git operations.
  • GitLab Flow: explore the best of Git with the GitLab Flow strategy.

Migrate and import your projects from other platforms

Continuous Integration, Delivery, and Deployment

  • GitLab CI: Explore the features and capabilities of Continuous Integration, Continuous Delivery, and Continuous Deployment with GitLab.
    • Auto Deploy: Configure GitLab CI for the deployment of your application.
    • Review Apps: Preview changes to your app right from a merge request.
  • GitLab Cycle Analytics: Cycle Analytics measures the time it takes to go from an idea to production for each project you have.
  • GitLab Container Registry: Learn how to use GitLab's built-in Container Registry.

Automation

  • API: Automate GitLab via a simple and powerful API.
  • GitLab Webhooks: Let GitLab notify you when new code has been pushed to your project.

Integrations

  • Project Services: Integrate a project with external services, such as CI and chat.
  • GitLab Integration: Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication.
  • Trello Power-Up: Integrate with GitLab's Trello Power-Up

Administrator documentation

Learn how to administer your GitLab instance. Regular users don't have access to GitLab administration tools and settings.

Install, update, upgrade, migrate

  • Install: Requirements, directory structures and installation from source.
  • Mattermost: Integrate Mattermost with your GitLab installation.
  • Migrate GitLab CI to CE/EE: If you have an old GitLab installation (older than 8.0), follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
  • Restart GitLab: Learn how to restart GitLab and its components.
  • Update: Update guides to upgrade your installation.

User permissions

Features

Integrations

  • Integrations: How to integrate with systems such as JIRA, Redmine, Twitter.
  • Mattermost: Set up GitLab with Mattermost.

Monitoring

Performance

Customization

Admin tools

  • Gitaly: Configuring Gitaly, GitLab's Git repository storage service
  • Raketasks: Backups, maintenance, automatic webhook setup and the importing of projects.
  • Reply by email: Allow users to comment on issues and merge requests by replying to notification emails.
  • Repository checks: Periodic Git repository checks.
  • Repository storage paths: Manage the paths used to store repositories.
  • Security: Learn what you can do to further secure your GitLab instance.
  • System hooks: Notifications when users, projects and keys are changed.

Troubleshooting

Contributor documentation