2014-04-24 18:48:22 -04:00
|
|
|
# Documentation
|
2014-04-02 06:46:17 -04:00
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
## User documentation
|
2014-04-02 06:46:17 -04:00
|
|
|
|
2014-11-24 05:30:07 -05:00
|
|
|
- [API](api/README.md) Automate GitLab via a simple and powerful API.
|
|
|
|
|
- [Markdown](markdown/markdown.md) GitLab's advanced formatting system.
|
2014-04-24 18:48:22 -04:00
|
|
|
- [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
|
2014-11-24 05:30:07 -05: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.
|
2014-04-24 18:48:22 -04:00
|
|
|
- [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
|
|
|
|
|
- [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
|
2015-01-23 14:18:10 -05:00
|
|
|
- [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
|
2015-02-19 01:07:09 -05:00
|
|
|
- [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
|
2014-04-02 06:46:17 -04:00
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
## Administrator documentation
|
2014-04-02 06:46:17 -04:00
|
|
|
|
2015-02-16 12:10:07 -05:00
|
|
|
- [Install](install/README.md) Requirements, directory structures and installation from source.
|
2014-04-24 18:48:22 -04:00
|
|
|
- [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
|
2014-11-24 05:30:07 -05:00
|
|
|
- [Raketasks](raketasks/README.md) Backups, maintenance, automatic web hook setup and the importing of projects.
|
2014-11-07 13:18:00 -05:00
|
|
|
- [Custom git hooks](hooks/custom_hooks.md) Custom git hooks (on the filesystem) for when web hooks aren't enough.
|
2014-11-24 05:30:07 -05:00
|
|
|
- [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
|
2014-04-24 18:48:22 -04:00
|
|
|
- [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
|
|
|
|
|
- [Update](update/README.md) Update guides to upgrade your installation.
|
2014-08-20 05:56:52 -04:00
|
|
|
- [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
|
2014-10-02 04:53:33 -04:00
|
|
|
- [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages.
|
2014-10-14 05:23:33 -04:00
|
|
|
- [Libravatar](customization/libravatar.md) Use Libravatar for user avatars.
|
2014-12-15 09:17:10 -05:00
|
|
|
- [Operations](operations/README.md) Keeping GitLab up and running
|
2015-02-13 07:58:54 -05:00
|
|
|
- [Log system](logs/logs.md) Log system
|
2014-04-02 06:46:17 -04:00
|
|
|
|
2014-04-24 18:48:22 -04:00
|
|
|
## Contributor documentation
|
|
|
|
|
|
|
|
|
|
- [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
|
|
|
|
|
- [Legal](legal/README.md) Contributor license agreements.
|
|
|
|
|
- [Release](release/README.md) How to make the monthly and security releases.
|
