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

13 KiB

GitLab Documentation

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

We offer four different products for you and your company:

  • 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.

Note: We are unifying the documentation for CE and EE. To check if certain feature is available in CE or EE, look for a note right below the page title containing the GitLab version which introduced that feature.


Shortcuts to GitLab's most visited docs:

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

Getting started with GitLab

User 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 files and branches 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.

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.
  • Koding: Set up Koding to use with GitLab.
  • Mattermost: Set up GitLab with Mattermost.

Monitoring

Performance

Customization

Admin tools

  • 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