gitlab-org--gitlab-foss/doc
Achilleas Pipinellis 97ef4cbe43 Merge branch 'docs-update-articles-list' into 'master'
Docs: update articles list

Closes #35800

See merge request !13229
2017-08-01 17:28:54 +00:00
..
administration Fix LDAP documentation and example config 2017-07-31 08:43:27 -07:00
api Merge branch '34519-extend-api-group-secret-variable' into 'master' 2017-08-01 09:29:50 +00:00
articles add article to list 2017-08-01 11:57:23 -03:00
ci link to CI/CD Deep Dive demo for #5800 2017-08-01 11:47:08 -03:00
container_registry
customization Add username parameter to gravatar URL 2017-06-01 10:07:24 -05:00
development Add code review guidelines related to Build [CI skip]. 2017-08-01 14:01:48 +00:00
downgrade_ee_to_ce Backports for ee-2112 2017-07-06 16:25:03 +08:00
gitlab-basics Refactor groups docs 2017-07-16 16:03:39 +00:00
hooks
incoming_email
install Add libre2-dev to the list of dependencies 2017-07-20 16:11:09 +01:00
integration Improve wording related to deploy chatops command 2017-07-28 12:16:07 +02:00
intro
legal
logs
markdown
migrate_ci_to_ce
monitoring
operations
pages
permissions
profile Docs new topic: "user/profile/index" 2017-07-27 19:23:35 +00:00
project_services
public_access
raketasks Merge branch 'harish-update-backup-restore-docs' into 'master' 2017-07-27 16:01:44 +00:00
security
ssh
system_hooks
topics
university Merge branch 'techbeacon_ci' into 'master' 2017-07-28 15:09:24 +00:00
update Update 9.3-to-9.4.md 2017-07-17 21:29:33 +00:00
user Fix username typo (jonh to John) 2017-08-01 01:35:16 +00:00
web_hooks
workflow Update gitlab_flow.md, Teatro seems to be completely dead, see also https://forum.gitlab.com/t/gitlab-flow-documentation-teatro/7774 2017-07-28 13:28:47 +00:00
README.md New doc topic user/project/index 2017-07-31 09:44:07 +00:00

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.


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

  • User documentation: Learn how to use GitLab and explore its features
  • 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.
  • Signing commits: use GPG to sign your commits.

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