From d36aa82340b8bdd23296de41b9c2a49765d92fcd Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 19 Feb 2020 03:08:47 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/administration/operations/unicorn.md | 20 ++++++++++++------- doc/api/oauth2.md | 33 ++++++++++++++++++++------------ doc/user/profile/notifications.md | 22 +++++++++++---------- doc/user/project/settings/index.md | 2 +- 4 files changed, 47 insertions(+), 30 deletions(-) (limited to 'doc') diff --git a/doc/administration/operations/unicorn.md b/doc/administration/operations/unicorn.md index edd580d10c7..561cd7ac1ce 100644 --- a/doc/administration/operations/unicorn.md +++ b/doc/administration/operations/unicorn.md @@ -64,13 +64,19 @@ between requests_, so no user requests are affected. You can set the minimum and maximum memory threshold (in bytes) for the Unicorn worker killer by setting the following values `/etc/gitlab/gitlab.rb`: -```ruby -unicorn['worker_memory_limit_min'] = "1024 * 1 << 20" -unicorn['worker_memory_limit_max'] = "1280 * 1 << 20" -``` - -NOTE: **Note:** -These values apply to GitLab 12.7.0 or newer versions. For older GitLab versions please consult [previous worker memory limits](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/12.6.0+ee.0/files/gitlab-cookbooks/gitlab/attributes/default.rb#L422-423). +- For GitLab **12.7** and newer: + + ```ruby + unicorn['worker_memory_limit_min'] = "1024 * 1 << 20" + unicorn['worker_memory_limit_max'] = "1280 * 1 << 20" + ``` + +- For GitLab **12.6** and older: + + ```ruby + unicorn['worker_memory_limit_min'] = "400 * 1 << 20" + unicorn['worker_memory_limit_max'] = "650 * 1 << 20" + ``` Otherwise, you can set the `GITLAB_UNICORN_MEMORY_MIN` and `GITLAB_UNICORN_MEMORY_MAX` [environment variables](../environment_variables.md). diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index c70ca1a74d5..1991ad4bd14 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -215,21 +215,24 @@ curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api ## Retrieving the Token Info -To verify the details of a token you can call the `token/info` endpoint. This is provided from the doorkeeper gem (see [`/oauth/token/info`](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo)). +To verify the details of a token, use the `token/info` endpoint provided by the Doorkeeper gem. +For more information, see [`/oauth/token/info`](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo). -You will need to supply the access token, either as a parameter +You must supply the access token, either: -``` -GET https://gitlab.example.com/oauth/token/info?access_token=OAUTH-TOKEN -``` +- As a parameter: -Or in the Authorization header: + ``` + GET https://gitlab.example.com/oauth/token/info?access_token= + ``` -``` -curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/oauth/token/info -``` +- In the Authorization header: -You will receive the following in response: + ```shell + curl --header "Authorization: Bearer " https://gitlab.example.com/oauth/token/info + ``` + +The following is an example response: ```json { @@ -241,5 +244,11 @@ You will receive the following in response: } ``` -CAUTION: **Deprecated fields:** -The fields `scopes` and `expires_in_seconds` are also included in the response. They are aliases for `scope` and `expires_in` respectively and have been included to prevent breaking changes introduced in [doorkeeper 5.0.2](https://github.com/doorkeeper-gem/doorkeeper/wiki/Migration-from-old-versions#from-4x-to-5x). Please don't rely on these fields as they will be removed in a later release. +### Deprecated fields + +The fields `scopes` and `expires_in_seconds` are included in the response. + +These are aliases for `scope` and `expires_in` respectively, and have been included to +prevent breaking changes introduced in [doorkeeper 5.0.2](https://github.com/doorkeeper-gem/doorkeeper/wiki/Migration-from-old-versions#from-4x-to-5x). + +Don't rely on these fields as they will be removed in a later release. diff --git a/doc/user/profile/notifications.md b/doc/user/profile/notifications.md index d3444b9aa13..96ae8d04e03 100644 --- a/doc/user/profile/notifications.md +++ b/doc/user/profile/notifications.md @@ -203,16 +203,18 @@ Notification email messages include GitLab-specific headers. You can filter the The following table lists all GitLab-specific email headers: | Header | Description | -|-----------------------------|-------------------------------------------------------------------------| -| X-GitLab-Project | The name of the project the notification belongs to | -| X-GitLab-Project-Id | The ID of the project | -| X-GitLab-Project-Path | The path of the project | -| X-GitLab-(Resource)-ID | The ID of the resource the notification is for, where resource is `Issue`, `MergeRequest`, `Commit`, etc| -| X-GitLab-Discussion-ID | Only in comment emails, the ID of the thread the comment is from | -| X-GitLab-Pipeline-Id | Only in pipeline emails, the ID of the pipeline the notification is for | -| X-GitLab-Reply-Key | A unique token to support reply by email | -| X-GitLab-NotificationReason | The reason for being notified: one of `mentioned`, `assigned`, or `own_activity` | -| List-Id | The path of the project in a RFC 2919 mailing list identifier useful for email organization, for example, with Gmail filters | +|------------------------------------|-------------------------------------------------------------------------| +| X-GitLab-Group-Id **(PREMIUM)** | The group's ID. Only present on notification emails for epics. | +| X-GitLab-Group-Path **(PREMIUM)** | The group's path. Only present on notification emails for epics. | +| X-GitLab-Project | The name of the project the notification belongs to. | +| X-GitLab-Project-Id | The project's ID. | +| X-GitLab-Project-Path | The project's path. | +| X-GitLab-(Resource)-ID | The ID of the resource the notification is for. The resource, for example, can be `Issue`, `MergeRequest`, `Commit`, or another such resource. | +| X-GitLab-Discussion-ID | The ID of the thread the comment belongs to, in notification emails for comments. | +| X-GitLab-Pipeline-Id | The ID of the pipeline the notification is for, in notification emails for pipelines. | +| X-GitLab-Reply-Key | A unique token to support reply by email. | +| X-GitLab-NotificationReason | The reason for the notification. This can be `mentioned`, `assigned`, or `own_activity`. | +| List-Id | The path of the project in an RFC 2919 mailing list identifier. This is useful for email organization with filters, for example. | ### X-GitLab-NotificationReason diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md index 158aaf143a9..70a1ec64d8e 100644 --- a/doc/user/project/settings/index.md +++ b/doc/user/project/settings/index.md @@ -204,7 +204,7 @@ namespace if needed. #### Remove a project NOTE: **Note:** -Only project owners and admins have [permissions]((../../permissions.md#project-members-permissions) to remove a project. +Only project owners and admins have [permissions](../../permissions.md#project-members-permissions) to remove a project. To remove a project: -- cgit v1.2.3