Commit 9abe5d36 authored by Marin Jankovski's avatar Marin Jankovski
Browse files

Add libravatar documentation.

parent 672bd390
......@@ -20,6 +20,7 @@
- [Update](update/ Update guides to upgrade your installation.
- [Welcome message](customization/ Add a custom welcome message to the sign-in page.
- [Issue closing](customization/ Customize how to close an issue from commit messages.
- [Libravatar](customization/ Use Libravatar for user avatars.
## Contributor documentation
# Use Libravatar service with GitLab
GitLab by default supports [Gravatar]( avatar service.
Libravatar is a service which delivers your avatar (profile picture) to other websites and their API is
[heavily based on gravatar](
This means that it is not complicated to switch to Libravatar avatar service or even self hosted Libravatar server.
# Configuration
In [gitlab.yml gravatar section]( set
the configuration options as follows:
## For HTTP
enabled: true
# gravatar urls: possible placeholders: %{hash} %{size} %{email}
plain_url: "{hash}?s=%{size}&d=identicon"
## For HTTPS
enabled: true
# gravatar urls: possible placeholders: %{hash} %{size} %{email}
ssl_url: "{hash}?s=%{size}&d=identicon"
## Self-hosted
If you are [running your own libravatar service]( the url will be different in the configuration
but the important part is to provide the same placeholders so GitLab can parse the url correctly.
For example, you host a service on `` the `plain_url` you need to supply in `gitlab.yml` is
## Omnibus-gitlab example
In `/etc/gitlab/gitlab.rb`:
#### For http
gitlab_rails['gravatar_enabled'] = true
gitlab_rails['gravatar_plain_url'] = "{hash}?s=%{size}&d=identicon"
#### For https
gitlab_rails['gravatar_enabled'] = true
gitlab_rails['gravatar_ssl_url'] = "{hash}?s=%{size}&d=identicon"
Run `sudo gitlab-ctl reconfigure` for changes to take effect.
## Default URL for missing images
[Libravatar supports different sets]( of `missing images` for emails not found on the Libravatar service.
In order to use a different set other than `identicon`, replace `&d=identicon` portion of the url with another supported set.
For example, you can use `retro` set in which case url would look like: `plain_url: "{hash}?s=%{size}&d=retro"`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment