Documentation

User documentation

• API Automate GitLab via a simple and powerful API.
• CI GitLab Continuous Integration (CI) getting started, .gitlab-ci.yml options, and examples.
• GitLab as OAuth2 authentication service provider. It allows you to login to other applications from GitLab.
• GitLab Basics Find step by step how to start working on your commandline and on GitLab.
• Importing to GitLab.
• Markdown GitLab's advanced formatting system.
• Migrating from SVN Convert a SVN repository to Git and GitLab
• Permissions Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
• Profile Settings
• Project Services Integrate a project with external services, such as CI and chat.
• Public access Learn how you can allow public and internal access to projects.
• Analytics
• Container Registry Learn how to use GitLab Container Registry.
• SSH Setup your ssh keys and deploy keys for secure access to your projects.
• Webhooks Let GitLab notify you when new code has been pushed to your project.
• Workflow Using GitLab functionality and importing projects from GitHub and SVN.
• GitLab Pages Using GitLab Pages.
• Custom templates for issues and merge requests Pre-fill the description of issues and merge requests to your liking.

Administrator documentation

• Audit Events Check how user access changed in projects and groups.
• Authentication/Authorization Configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.
• Changing the appearance of the login page Make the login page branded for your GitLab instance.
• Custom git hooks Custom git hooks (on the filesystem) for when webhooks aren't enough.
• Email Email GitLab users from GitLab
• Git Hooks Advanced push rules for your project.
• Help message Set information about administrators of your GitLab instance.
• Install Requirements, directory structures and installation from source.
• Installing your license
• Integration How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
• Restart GitLab Learn how to restart GitLab and its components
• Issue closing Customize how to close an issue from commit messages.
• Libravatar Use Libravatar for user avatars.
• Log system Log system.
• Environment Variables to configure GitLab.
• Operations Keeping GitLab up and running
• Raketasks Backups, maintenance, automatic webhook setup and the importing of projects.
• Repository checks Periodic Git repository checks
• Security Learn what you can do to further secure your GitLab instance.
• System hooks Notifications when users, projects and keys are changed.
• Update Update guides to upgrade your installation.
• Welcome message Add a custom welcome message to the sign-in page.
• Reply by email Allow users to comment on issues and merge requests by replying to notification emails.
• Migrate GitLab CI to CE/EE Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
• Downgrade back to CE Follow this guide if you need to downgrade from EE to CE.
• git-annex configuration
• Git LFS configuration
• Housekeeping Keep your Git repository tidy and fast.
• GitLab Pages configuration
• Elasticsearch Enable Elasticsearch
• GitLab Performance Monitoring Configure GitLab and InfluxDB for measuring performance metrics
• Monitoring uptime Check the server status using the health check endpoint
• Sidekiq Troubleshooting Debug when Sidekiq appears hung and is not processing jobs
• High Availability Configure multiple servers for scaling or high availability
• GitLab GEO Configure GitLab GEO, a secondary read-only GitLab instance
• Container Registry Configure Docker Registry with GitLab

Contributor documentation

• Documentation styleguide Use this styleguide if you are contributing to documentation.
• Development Explains the architecture and the guidelines for shell commands.
• Legal Contributor license agreements.