2015-06-10 21:37:48 +00:00
# Documentation
## User documentation
- [API ](api/README.md ) Automate GitLab via a simple and powerful API.
2016-06-15 03:34:35 +00: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 21:37:48 +00:00
- [GitLab as OAuth2 authentication service provider ](integration/oauth_provider.md ). It allows you to login to other applications from GitLab.
2016-06-15 03:34:35 +00:00
- [Container Registry ](container_registry/README.md ) Learn how to use GitLab Container Registry.
2015-07-05 15:23:09 +00:00
- [GitLab Basics ](gitlab-basics/README.md ) Find step by step how to start working on your commandline and on GitLab.
2015-06-10 21:37:48 +00:00
- [Importing to GitLab ](workflow/importing/README.md ).
2016-06-21 17:28:08 +00:00
- [Importing and exporting projects between instances ](user/project/settings/import_export.md ).
2016-08-03 05:54:01 +00:00
- [Markdown ](user/markdown.md ) GitLab's advanced formatting system.
2016-06-15 03:34:35 +00:00
- [Migrating from SVN ](workflow/importing/migrating_from_svn.md ) Convert a SVN repository to Git and GitLab.
2016-07-12 14:53:54 +00:00
- [Permissions ](user/permissions.md ) Learn what each role in a project (external/guest/reporter/developer/master/owner) can do.
2015-06-12 02:54:21 +00:00
- [Profile Settings ](profile/README.md )
2015-06-10 21:37:48 +00:00
- [Project Services ](project_services/project_services.md ) Integrate a project with external services, such as CI and chat.
- [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.
2016-03-10 19:48:29 +00:00
- [Webhooks ](web_hooks/web_hooks.md ) Let GitLab notify you when new code has been pushed to your project.
2015-06-10 21:37:48 +00:00
- [Workflow ](workflow/README.md ) Using GitLab functionality and importing projects from GitHub and SVN.
2016-08-22 14:09:15 +00:00
- [Koding ](user/project/koding.md ) Learn how to use Koding, the online IDE.
2015-06-10 21:37:48 +00:00
## Administrator documentation
2016-07-22 09:18:05 +00: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-22 02:25:15 +00:00
- [Authentication/Authorization ](administration/auth/README.md ) Configure
external authentication with LDAP, SAML, CAS and additional Omniauth providers.
2016-07-05 12:04:44 +00:00
- [Custom Git hooks ](administration/custom_hooks.md ) Custom Git hooks (on the filesystem) for when webhooks aren't enough.
2015-06-10 21:37:48 +00:00
- [Install ](install/README.md ) Requirements, directory structures and installation from source.
2016-06-15 03:34:35 +00:00
- [Restart GitLab ](administration/restart_gitlab.md ) Learn how to restart GitLab and its components.
2016-03-22 02:25:15 +00:00
- [Integration ](integration/README.md ) How to integrate with systems such as JIRA, Redmine, Twitter.
2015-06-10 21:37:48 +00:00
- [Issue closing ](customization/issue_closing.md ) Customize how to close an issue from commit messages.
2016-08-22 14:09:15 +00:00
- [Koding ](administration/integration/koding.md ) Set up Koding to use with GitLab.
2015-06-10 21:37:48 +00:00
- [Libravatar ](customization/libravatar.md ) Use Libravatar for user avatars.
2016-06-13 12:19:29 +00:00
- [Log system ](administration/logs.md ) Log system.
2015-12-29 11:58:32 +00:00
- [Environment Variables ](administration/environment_variables.md ) to configure GitLab.
2016-06-15 03:34:35 +00:00
- [Operations ](operations/README.md ) Keeping GitLab up and running.
2016-03-10 19:48:29 +00:00
- [Raketasks ](raketasks/README.md ) Backups, maintenance, automatic webhook setup and the importing of projects.
2016-06-15 03:34:35 +00:00
- [Repository checks ](administration/repository_checks.md ) Periodic Git repository checks.
2016-06-22 21:04:51 +00:00
- [Repository storages ](administration/repository_storages.md ) Manage the paths used to store repositories.
2015-06-10 21:37:48 +00: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.
2015-09-21 07:46:47 +00:00
- [Reply by email ](incoming_email/README.md ) Allow users to comment on issues and merge requests by replying to notification emails.
2015-09-16 08:58:33 +00: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 15:10:08 +00:00
- [Git LFS configuration ](workflow/lfs/lfs_administration.md )
2016-01-21 21:59:15 +00:00
- [Housekeeping ](administration/housekeeping.md ) Keep your Git repository tidy and fast.
2016-06-15 03:34:35 +00:00
- [GitLab Performance Monitoring ](monitoring/performance/introduction.md ) Configure GitLab and InfluxDB for measuring performance metrics.
- [Monitoring uptime ](monitoring/health_check.md ) Check the server status using the health check endpoint.
2016-06-08 02:40:38 +00:00
- [Debugging Tips ](administration/troubleshooting/debug.md ) Tips to debug problems when things go wrong
2016-06-15 03:34:35 +00: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.
2016-07-22 11:57:45 +00:00
- [Multiple mountpoints for the repositories storage ](administration/repository_storages.md ) Define multiple repository storage paths to distribute the storage load.
2015-06-10 21:37:48 +00:00
## Contributor documentation
2016-08-04 10:39:09 +00:00
- [Development ](development/README.md ) All styleguides and explanations how to contribute.
2015-06-10 21:37:48 +00:00
- [Legal ](legal/README.md ) Contributor license agreements.