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

toc	comments
false	false

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

• User documentation
• Administrator documentation
• Technical Articles

Getting started with GitLab

• GitLab Basics: Start working on your command line and on GitLab.
• GitLab Workflow: Enhance your workflow with the best of GitLab Workflow.
  • See also GitLab Workflow - an overview.
• GitLab Markdown: GitLab's advanced formatting system (GitLab Flavored Markdown).
• GitLab Quick Actions: Textual shortcuts for common actions on issues or merge requests that are usually done by clicking buttons or dropdowns in GitLab's UI.
• Auto DevOps

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

• Projects:
  • Project settings
  • Create a project
  • Fork a project
  • Importing and exporting projects between instances.
  • Project access: Setting up your project's visibility to public, internal, or private.
  • GitLab Pages: Build, test, and deploy your static website with GitLab Pages.
• Groups: Organize your projects in groups.
  • Subgroups
• Search through GitLab: Search for issues, merge requests, projects, groups, todos, and issues in Issue Boards.
• Snippets: Snippets allow you to create little bits of code.
• Wikis: Enhance your repository documentation with built-in wikis.

Repository

Manage your repositories from the UI (user interface):

• Files
  • Create a file
  • Upload a file
  • File templates
  • Create a directory
  • Start a merge request (when committing via UI)
• Branches
  • Default branch
  • Create a branch
  • Protected branches
  • Delete merged branches
• Commits
  • Signing commits: use GPG to sign your commits.

Issues and Merge Requests (MRs)

• Discussions: Threads, comments, and resolvable discussions in issues, commits, and merge requests.
• Issues
• Project issue Board
• Issues and merge requests templates: Create templates for submitting new issues and merge requests.
• Labels: Categorize your issues or merge requests based on descriptive titles.
• Merge Requests
  • Work In Progress Merge Requests
  • Merge Request discussion resolution: Resolve discussions, move discussions in a merge request to an issue, only allow merge requests to be merged if all discussions are resolved.
  • Checkout merge requests locally
  • Cherry-pick
• Milestones: Organize issues and merge requests into a cohesive group, optionally setting a due date.
• Todos: A chronological list of to-dos that are waiting for your input, all in a simple dashboard.

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

• Importing to GitLab: Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
• Migrating from SVN: Convert a SVN repository to Git and GitLab.

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

• Access restrictions: Define which Git access protocols can be used to talk to GitLab
• Authentication/Authorization: Enforce 2FA, configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.

Features

• Container Registry: Configure Docker Registry with GitLab.
• Custom Git hooks: Custom Git hooks (on the filesystem) for when webhooks aren't enough.
• Git LFS configuration: Learn how to use LFS under GitLab.
• GitLab Pages configuration: Configure GitLab Pages.
• High Availability: Configure multiple servers for scaling or high availability.
• User cohorts: View user activity over time.
• Web terminals: Provide terminal access to environments from within GitLab.
• GitLab CI
  • CI admin settings: Define max artifacts size and expiration time.

Integrations

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

Monitoring

• GitLab performance monitoring with InfluxDB: Configure GitLab and InfluxDB for measuring performance metrics.
• GitLab performance monitoring with Prometheus: Configure GitLab and Prometheus for measuring performance metrics.
• Monitoring uptime: Check the server status using the health check endpoint.

Performance

• Housekeeping: Keep your Git repository tidy and fast.
• Operations: Keeping GitLab up and running.
• Polling: Configure how often the GitLab UI polls for updates.
• Request Profiling: Get a detailed profile on slow requests.
• Performance Bar: Get performance information for the current page.

Customization

• Adjust your instance's timezone: Customize the default time zone of GitLab.
• Environment variables: Supported environment variables that can be used to override their defaults values in order to configure GitLab.
• Header logo: Change the logo on the overall page and email header.
• Issue closing pattern: Customize how to close an issue from commit messages.
• Libravatar: Use Libravatar instead of Gravatar for user avatars.
• Welcome message: Add a custom welcome message to the sign-in page.

Admin tools

• Gitaly: Configuring Gitaly, GitLab's Git repository storage service
• Raketasks: Backups, maintenance, automatic webhook setup and the importing of projects.
  • Backup and restore: Backup and restore your GitLab instance.
• 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

• Debugging tips: Tips to debug problems when things go wrong
• Log system: Where to look for logs.
• Sidekiq Troubleshooting: Debug when Sidekiq appears hung and is not processing jobs.

Contributor documentation

• Development: All styleguides and explanations how to contribute.
• Legal: Contributor license agreements.
• Writing documentation: Contributing to GitLab Docs.