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-04-24 18:48:22 -04:00
- [API ](api/README.md ) Explore how you can access GitLab via a simple and powerful API.
- [Markdown ](markdown/markdown.md ) Learn what you can do with GitLab's advanced formatting system.
- [Permissions ](permissions/permissions.md ) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
2014-10-16 12:34:19 -04:00
- [Project Services ](project_services/project_services.md ) Explore how project services can integrate a project with external services, such as for CI.
2014-04-24 18:48:22 -04:00
- [Public access ](public_access/public_access.md ) Learn how you can allow public and internal access to a project.
- [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.
- [Workflow ](workflow/README.md ) Learn how to use Git and GitLab together.
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
2014-04-24 18:48:22 -04:00
- [Install ](install/README.md ) Requirements, directory structures and manual installation.
- [Integration ](integration/README.md ) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
- [Raketasks ](raketasks/README.md ) Explore what GitLab has in store for you to make administration easier.
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-04-24 18:48:22 -04:00
- [System hooks ](system_hooks/system_hooks.md ) Let GitLab notify you when certain management tasks need to be carried out.
- [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-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.