2016-12-11 04:18:44 -05:00
# GitLab Community Edition documentation
2015-06-10 17:37:48 -04:00
2017-01-19 21:05:04 -05:00
## University
[University ](university/README.md ) contain guides to learn Git and GitLab through courses and videos.
2015-06-10 17:37:48 -04:00
## User documentation
2017-01-24 09:42:28 -05:00
- [Account Security ](user/profile/account/two_factor_authentication.md ) Securing your account via two-factor authentication, etc.
2015-06-10 17:37:48 -04:00
- [API ](api/README.md ) Automate GitLab via a simple and powerful API.
2016-06-14 23:34:35 -04:00
- [CI/CD ](ci/README.md ) GitLab Continuous Integration (CI) and Continuous Delivery (CD) getting started, `.gitlab-ci.yml` options, and examples.
2015-06-10 17:37:48 -04:00
- [GitLab as OAuth2 authentication service provider ](integration/oauth_provider.md ). It allows you to login to other applications from GitLab.
2016-10-06 12:44:09 -04:00
- [Container Registry ](user/project/container_registry.md ) Learn how to use GitLab Container Registry.
2016-10-11 05:30:35 -04:00
- [GitLab basics ](gitlab-basics/README.md ) Find step by step how to start working on your commandline and on GitLab.
2017-01-18 12:46:52 -05:00
- [GitLab Pages ](user/project/pages/index.md ) Using GitLab Pages.
2016-12-16 08:54:23 -05:00
- [Importing to GitLab ](workflow/importing/README.md ) Import your projects from GitHub, Bitbucket, GitLab.com, FogBugz and SVN into GitLab.
2016-06-21 13:28:08 -04:00
- [Importing and exporting projects between instances ](user/project/settings/import_export.md ).
2016-08-03 01:54:01 -04:00
- [Markdown ](user/markdown.md ) GitLab's advanced formatting system.
2016-06-14 23:34:35 -04:00
- [Migrating from SVN ](workflow/importing/migrating_from_svn.md ) Convert a SVN repository to Git and GitLab.
2016-07-12 10:53:54 -04:00
- [Permissions ](user/permissions.md ) Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
2015-06-11 22:54:21 -04:00
- [Profile Settings ](profile/README.md )
2017-02-03 13:41:35 -05:00
- [Project Services ](user/project/integrations//project_services.md ) Integrate a project with external services, such as CI and chat.
2015-06-10 17:37:48 -04:00
- [Public access ](public_access/public_access.md ) Learn how you can allow public and internal access to projects.
- [SSH ](ssh/README.md ) Setup your ssh keys and deploy keys for secure access to your projects.
2017-02-03 13:26:48 -05:00
- [Webhooks ](user/project/integrations/webhooks.md ) Let GitLab notify you when new code has been pushed to your project.
2015-06-10 17:37:48 -04:00
- [Workflow ](workflow/README.md ) Using GitLab functionality and importing projects from GitHub and SVN.
2016-10-12 08:51:56 -04:00
- [Git Attributes ](user/project/git_attributes.md ) Managing Git attributes using a `.gitattributes` file.
2016-11-09 11:42:44 -05:00
- [Git cheatsheet ](https://gitlab.com/gitlab-com/marketing/raw/master/design/print/git-cheatsheet/print-pdf/git-cheatsheet.pdf ) Download a PDF describing the most used Git operations.
2015-06-10 17:37:48 -04:00
## Administrator documentation
2016-07-22 05:18:05 -04:00
- [Access restrictions ](user/admin_area/settings/visibility_and_access_controls.md#enabled-git-access-protocols ) Define which Git access protocols can be used to talk to GitLab
2016-03-21 22:25:15 -04:00
- [Authentication/Authorization ](administration/auth/README.md ) Configure
external authentication with LDAP, SAML, CAS and additional Omniauth providers.
2016-07-05 08:04:44 -04:00
- [Custom Git hooks ](administration/custom_hooks.md ) Custom Git hooks (on the filesystem) for when webhooks aren't enough.
2015-06-10 17:37:48 -04:00
- [Install ](install/README.md ) Requirements, directory structures and installation from source.
2016-06-14 23:34:35 -04:00
- [Restart GitLab ](administration/restart_gitlab.md ) Learn how to restart GitLab and its components.
2016-03-21 22:25:15 -04:00
- [Integration ](integration/README.md ) How to integrate with systems such as JIRA, Redmine, Twitter.
2016-09-21 07:01:48 -04:00
- [Issue closing pattern ](administration/issue_closing_pattern.md ) Customize how to close an issue from commit messages.
2016-08-22 10:09:15 -04:00
- [Koding ](administration/integration/koding.md ) Set up Koding to use with GitLab.
2016-12-20 06:05:39 -05:00
- [Web terminals ](administration/integration/terminal.md ) Provide terminal access to environments from within GitLab.
2016-09-21 07:01:48 -04:00
- [Libravatar ](customization/libravatar.md ) Use Libravatar instead of Gravatar for user avatars.
2016-06-13 08:19:29 -04:00
- [Log system ](administration/logs.md ) Log system.
2015-12-29 06:58:32 -05:00
- [Environment Variables ](administration/environment_variables.md ) to configure GitLab.
2016-09-25 06:44:09 -04:00
- [Operations ](administration/operations.md ) Keeping GitLab up and running.
2016-03-10 14:48:29 -05:00
- [Raketasks ](raketasks/README.md ) Backups, maintenance, automatic webhook setup and the importing of projects.
2016-06-14 23:34:35 -04:00
- [Repository checks ](administration/repository_checks.md ) Periodic Git repository checks.
2017-01-24 15:05:27 -05:00
- [Repository storage paths ](administration/repository_storage_paths.md ) Manage the paths used to store repositories.
2015-06-10 17:37:48 -04:00
- [Security ](security/README.md ) Learn what you can do to further secure your GitLab instance.
- [System hooks ](system_hooks/system_hooks.md ) Notifications when users, projects and keys are changed.
- [Update ](update/README.md ) Update guides to upgrade your installation.
- [Welcome message ](customization/welcome_message.md ) Add a custom welcome message to the sign-in page.
2016-09-25 05:55:14 -04:00
- [Reply by email ](administration/reply_by_email.md ) Allow users to comment on issues and merge requests by replying to notification emails.
2015-09-16 04:58:33 -04:00
- [Migrate GitLab CI to CE/EE ](migrate_ci_to_ce/README.md ) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
2015-11-20 10:10:08 -05:00
- [Git LFS configuration ](workflow/lfs/lfs_administration.md )
2016-01-21 16:59:15 -05:00
- [Housekeeping ](administration/housekeeping.md ) Keep your Git repository tidy and fast.
2017-01-18 12:46:52 -05:00
- [GitLab Pages configuration ](administration/pages/index.md ) Configure GitLab Pages.
2017-01-22 08:14:46 -05:00
- [GitLab performance monitoring with InfluxDB ](administration/monitoring/performance/introduction.md ) Configure GitLab and InfluxDB for measuring performance metrics.
2017-02-08 05:38:24 -05:00
- [GitLab performance monitoring with Prometheus ](administration/monitoring/prometheus/index.md ) Configure GitLab and Prometheus for measuring performance metrics.
2016-10-14 13:49:36 -04:00
- [Request Profiling ](administration/monitoring/performance/request_profiling.md ) Get a detailed profile on slow requests.
2016-10-11 09:55:32 -04:00
- [Monitoring uptime ](user/admin_area/monitoring/health_check.md ) Check the server status using the health check endpoint.
2016-06-07 22:40:38 -04:00
- [Debugging Tips ](administration/troubleshooting/debug.md ) Tips to debug problems when things go wrong
2016-06-14 23:34:35 -04:00
- [Sidekiq Troubleshooting ](administration/troubleshooting/sidekiq.md ) Debug when Sidekiq appears hung and is not processing jobs.
- [High Availability ](administration/high_availability/README.md ) Configure multiple servers for scaling or high availability.
- [Container Registry ](administration/container_registry.md ) Configure Docker Registry with GitLab.
2015-06-10 17:37:48 -04:00
## Contributor documentation
2016-08-04 06:39:09 -04:00
- [Development ](development/README.md ) All styleguides and explanations how to contribute.
2015-06-10 17:37:48 -04:00
- [Legal ](legal/README.md ) Contributor license agreements.
