diff options
Diffstat (limited to 'doc/administration/customization')
| -rw-r--r-- | doc/administration/customization/branded_login_page.md | 19 | ||||
| -rw-r--r-- | doc/administration/customization/branded_login_page/appearance.png | bin | 0 -> 365120 bytes | |||
| -rw-r--r-- | doc/administration/customization/branded_login_page/custom_sign_in.png | bin | 0 -> 314111 bytes | |||
| -rw-r--r-- | doc/administration/customization/branded_login_page/default_login_page.png | bin | 0 -> 292731 bytes | |||
| -rw-r--r-- | doc/administration/customization/issue_closing.md | 39 | ||||
| -rw-r--r-- | doc/administration/customization/libravatar.md | 82 | ||||
| -rw-r--r-- | doc/administration/customization/welcome_message.md | 12 |
7 files changed, 152 insertions, 0 deletions
diff --git a/doc/administration/customization/branded_login_page.md b/doc/administration/customization/branded_login_page.md new file mode 100644 index 00000000000..d4d9f5f7b5e --- /dev/null +++ b/doc/administration/customization/branded_login_page.md @@ -0,0 +1,19 @@ +# Changing the appearance of the login page + +GitLab Community Edition offers a way to put your company's identity on the login page of your GitLab server and make it a branded login page. + +By default, the page shows the GitLab logo and description. + + + +## Changing the appearance of the login page + +Navigate to the **Admin** area and go to the **Appearance** page. + +Fill in the required details like Title, Description and upload the company logo. + + + +After saving the page, your GitLab login page will have the details you filled in: + + diff --git a/doc/administration/customization/branded_login_page/appearance.png b/doc/administration/customization/branded_login_page/appearance.png Binary files differnew file mode 100644 index 00000000000..6bce1f0a287 --- /dev/null +++ b/doc/administration/customization/branded_login_page/appearance.png diff --git a/doc/administration/customization/branded_login_page/custom_sign_in.png b/doc/administration/customization/branded_login_page/custom_sign_in.png Binary files differnew file mode 100644 index 00000000000..d6020b029a2 --- /dev/null +++ b/doc/administration/customization/branded_login_page/custom_sign_in.png diff --git a/doc/administration/customization/branded_login_page/default_login_page.png b/doc/administration/customization/branded_login_page/default_login_page.png Binary files differnew file mode 100644 index 00000000000..795c7954d8e --- /dev/null +++ b/doc/administration/customization/branded_login_page/default_login_page.png diff --git a/doc/administration/customization/issue_closing.md b/doc/administration/customization/issue_closing.md new file mode 100644 index 00000000000..194b8e00299 --- /dev/null +++ b/doc/administration/customization/issue_closing.md @@ -0,0 +1,39 @@ +# Issue closing pattern + +When a commit or merge request resolves one or more issues, it is possible to automatically have these issues closed when the commit or merge request lands in the project's default branch. + +If a commit message or merge request description contains a sentence matching the regular expression below, all issues referenced from +the matched text will be closed. This happens when the commit is pushed to a project's default branch, or when a commit or merge request is merged into there. + +When not specified, the default `issue_closing_pattern` as shown below will be used: + +```bash +((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?))+) +``` + +Here, `%{issue_ref}` is a complex regular expression defined inside GitLab, that matches a reference to a local issue (`#123`), cross-project issue (`group/project#123`) or a link to an issue (`https://gitlab.example.com/group/project/issues/123`). + +For example: + +``` +git commit -m "Awesome commit message (Fix #20, Fixes #21 and Closes group/otherproject#22). This commit is also related to #17 and fixes #18, #19 and https://gitlab.example.com/group/otherproject/issues/23." +``` + +will close `#18`, `#19`, `#20`, and `#21` in the project this commit is pushed to, as well as `#22` and `#23` in group/otherproject. `#17` won't be closed as it does not match the pattern. It also works with multiline commit messages. + +Tip: you can test this closing pattern at [http://rubular.com][1]. Use this site +to test your own patterns. +Because Rubular doesn't understand `%{issue_ref}`, you can replace this by `#\d+` in testing, which matches only local issue references like `#123`. + +## Change the pattern + +For Omnibus installs you can change the default pattern in `/etc/gitlab/gitlab.rb`: + +``` +issue_closing_pattern: '((?:[Cc]los(?:e[sd]|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?))+)' +``` + +For manual installs you can customize the pattern in [gitlab.yml][0] using the `issue_closing_pattern` key. + +[0]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example +[1]: http://rubular.com/r/Xmbexed1OJ diff --git a/doc/administration/customization/libravatar.md b/doc/administration/customization/libravatar.md new file mode 100644 index 00000000000..c46ce2ee203 --- /dev/null +++ b/doc/administration/customization/libravatar.md @@ -0,0 +1,82 @@ +# Use Libravatar service with GitLab + +GitLab by default supports [Gravatar](https://gravatar.com) avatar service. +Libravatar is a service which delivers your avatar (profile picture) to other websites and their API is +[heavily based on gravatar](https://wiki.libravatar.org/api/). + +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](https://gitlab.com/gitlab-org/gitlab-ce/blob/672bd3902d86b78d730cea809fce312ec49d39d7/config/gitlab.yml.example#L122) set +the configuration options as follows: + +## For HTTP + +```yml + gravatar: + enabled: true + # gravatar URLs: possible placeholders: %{hash} %{size} %{email} + plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" +``` + +## For HTTPS + +```yml + gravatar: + enabled: true + # gravatar URLs: possible placeholders: %{hash} %{size} %{email} + ssl_url: "https://seccdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" +``` + +## Self-hosted + +If you are [running your own libravatar service](https://wiki.libravatar.org/running_your_own/) 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 `http://libravatar.example.com` the `plain_url` you need to supply in `gitlab.yml` is + +`http://libravatar.example.com/avatar/%{hash}?s=%{size}&d=identicon` + + +## Omnibus-gitlab example + +In `/etc/gitlab/gitlab.rb`: + +#### For http + +```ruby +gitlab_rails['gravatar_enabled'] = true +gitlab_rails['gravatar_plain_url'] = "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" +``` + +#### For https + +```ruby +gitlab_rails['gravatar_enabled'] = true +gitlab_rails['gravatar_ssl_url'] = "https://seccdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon" +``` + + +Run `sudo gitlab-ctl reconfigure` for changes to take effect. + + +## Default URL for missing images + +[Libravatar supports different sets](https://wiki.libravatar.org/api/) 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 the URL would look like: `plain_url: "http://cdn.libravatar.org/avatar/%{hash}?s=%{size}&d=retro"` + + +## Usage examples + +#### For Microsoft Office 365 + +If your users are Office 365-users, the "GetPersonaPhoto" service can be used. Note that this service requires login, so this use case is +most useful in a corporate installation, where all users have access to Office 365. + +```ruby +gitlab_rails['gravatar_plain_url'] = 'http://outlook.office365.com/owa/service.svc/s/GetPersonaPhoto?email=%{email}&size=HR120x120' +gitlab_rails['gravatar_ssl_url'] = 'https://outlook.office365.com/owa/service.svc/s/GetPersonaPhoto?email=%{email}&size=HR120x120' +``` diff --git a/doc/administration/customization/welcome_message.md b/doc/administration/customization/welcome_message.md new file mode 100644 index 00000000000..a0cb234bea0 --- /dev/null +++ b/doc/administration/customization/welcome_message.md @@ -0,0 +1,12 @@ +# Customize the complete sign-in page + +Please see [Branded login page](branded_login_page.md) + +# Add a welcome message to the sign-in page (GitLab Community Edition) + +It is possible to add a markdown-formatted welcome message to your GitLab +sign-in page. Users of GitLab Enterprise Edition should use the [branded login +page feature](branded_login_page.md) instead. + +The welcome message (extra_sign_in_text) can now be set/changed in the Admin UI. +Admin area > Settings |
