| .. | ||
| administration | ||
| api | ||
| ci | ||
| container_registry | ||
| customization | ||
| development | ||
| downgrade_ee_to_ce | ||
| gitlab-basics | ||
| hooks | ||
| incoming_email | ||
| install | ||
| integration | ||
| intro | ||
| legal | ||
| logs | ||
| markdown | ||
| migrate_ci_to_ce | ||
| monitoring | ||
| operations | ||
| pages | ||
| permissions | ||
| profile | ||
| project_services | ||
| public_access | ||
| raketasks | ||
| security | ||
| ssh | ||
| system_hooks | ||
| topics | ||
| university | ||
| update | ||
| user | ||
| web_hooks | ||
| workflow | ||
| README.md | ||
GitLab Community Edition Documentation
All technical content published by GitLab lives in the documentation, including:
- General Documentation
- User docs: general documentation dedicated to regular users of GitLab
- Admin docs: general documentation dedicated to administrators of GitLab instances
- Contributor docs: general documentation on how to develop and contribute to GitLab
- Technical Articles
- User guides: technical content to guide regular users from point A to point B
- Admin guides: technical content to guide administrators of GitLab instances from point A to point B
- Technical Overviews: technical content describing features, solutions, and third-party integrations
- Tutorials: technical content provided step-by-step on how to do things, or how to reach very specific objectives
- Indexes per Topic: content gathering all resources already published by GitLab related to an specific subject or theme, including:
- General Docs
- Technical Articles
- Blog Posts
- Video Tutorials
See also:
- Distinction between General Documentation and Technical Articles
- GitLab University: guides to learn Git and GitLab through courses and videos.
User Documentation
- Account Security Securing your account via two-factor authentication, etc.
- API Automate GitLab via a simple and powerful API.
- CI/CD GitLab Continuous Integration (CI) and Continuous Delivery (CD) getting started,
.gitlab-ci.ymloptions, and examples. - GitLab as OAuth2 authentication service provider. It allows you to login to other applications from GitLab.
- Container Registry Learn how to use GitLab Container Registry.
- GitLab basics Find step by step how to start working on your commandline and on GitLab.
- GitLab Pages Using GitLab Pages.
- Importing to GitLab Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
- Importing and exporting projects between instances.
- 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.
- Snippets Snippets allow you to create little bits of code.
- 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.
- Git Attributes Managing Git attributes using a
.gitattributesfile. - Git cheatsheet Download a PDF describing the most used Git operations.
Administrator Documentation
- Access restrictions Define which Git access protocols can be used to talk to GitLab
- Authentication/Authorization Configure external authentication with LDAP, SAML, CAS and additional Omniauth providers.
- Custom Git hooks Custom Git hooks (on the filesystem) for when webhooks aren't enough.
- Install Requirements, directory structures and installation from source.
- Restart GitLab Learn how to restart GitLab and its components.
- Integration How to integrate with systems such as JIRA, Redmine, Twitter.
- Issue closing pattern Customize how to close an issue from commit messages.
- Koding Set up Koding to use with GitLab.
- Web terminals Provide terminal access to environments from within GitLab.
- Libravatar Use Libravatar instead of Gravatar 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.
- 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.
- Update Update guides to upgrade your installation.
- Welcome message Add a custom welcome message to the sign-in page.
- Header logo Change the logo on the overall page and email header.
- 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.
- Git LFS configuration
- Housekeeping Keep your Git repository tidy and fast.
- GitLab Pages configuration Configure GitLab Pages.
- 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.
- Request Profiling Get a detailed profile on slow requests.
- Monitoring uptime Check the server status using the health check endpoint.
- Debugging Tips Tips to debug problems when things go wrong
- Sidekiq Troubleshooting Debug when Sidekiq appears hung and is not processing jobs.
- High Availability Configure multiple servers for scaling or high availability.
- Container Registry Configure Docker Registry with GitLab.
Contributor Documentation
- Development All styleguides and explanations how to contribute.
- Writing documentation
- Legal Contributor license agreements.