diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/auth/ldap.md | 12 | ||||
| -rw-r--r-- | doc/api/projects.md | 5 | ||||
| -rw-r--r-- | doc/api/protected_branches.md | 38 | ||||
| -rw-r--r-- | doc/user/group/saml_sso/index.md | 2 |
4 files changed, 42 insertions, 15 deletions
diff --git a/doc/administration/auth/ldap.md b/doc/administration/auth/ldap.md index 186bf4c4825..728add05bd8 100644 --- a/doc/administration/auth/ldap.md +++ b/doc/administration/auth/ldap.md @@ -563,3 +563,15 @@ If you are getting 'Connection Refused' errors when trying to connect to the LDAP server please double-check the LDAP `port` and `encryption` settings used by GitLab. Common combinations are `encryption: 'plain'` and `port: 389`, OR `encryption: 'simple_tls'` and `port: 636`. + +### Connection times out + +If GitLab cannot reach your LDAP endpoint, you will see a message like this: + +``` +Could not authenticate you from Ldapmain because "Connection timed out - user specified timeout". +``` + +If your configured LDAP provider and/or endpoint is offline or otherwise unreachable by GitLab, no LDAP user will be able to authenticate and log in. GitLab does not cache or store credentials for LDAP users to provide authentication during an LDAP outage. + +Contact your LDAP provider or administrator if you are seeing this error. diff --git a/doc/api/projects.md b/doc/api/projects.md index 4aae101791b..38c3708c7e5 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -931,9 +931,13 @@ POST /projects | `auto_devops_deploy_strategy` | string | no | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`) | | `repository_storage` | string | no | **(STARTER ONLY)** Which storage shard the repository is on. Available only to admins | | `approvals_before_merge` | integer | no | **(STARTER)** How many approvers should approve merge requests by default | +| `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project | | `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project | | `mirror_trigger_builds` | boolean | no | **(STARTER)** Pull mirroring triggers builds | | `initialize_with_readme` | boolean | no | `false` by default | +| `template_name` | string | no | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template | +| `use_custom_template` | boolean | no | **(PREMIUM)** Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template | +| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true | NOTE: **Note:** If your HTTP repository is not publicly accessible, add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` @@ -991,6 +995,7 @@ POST /projects/user/:user_id | `external_authorization_classification_label` | string | no | **(PREMIUM)** The classification label for the project | | `mirror` | boolean | no | **(STARTER)** Enables pull mirroring in a project | | `mirror_trigger_builds` | boolean | no | **(STARTER)** Pull mirroring triggers builds | +| `initialize_with_readme` | boolean | no | `false` by default | | `template_name` | string | no | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template | | `use_custom_template` | boolean | no | **(PREMIUM)** Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template | | `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true | diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index a14c9046ca7..debf1b264f9 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -46,7 +46,8 @@ Example response: "access_level": 40, "access_level_description": "Maintainers" } - ] + ], + "code_owner_approval_required": "false" }, ... ] @@ -76,7 +77,8 @@ Example response: "group_id": 1234, "access_level_description": "Example Merge Group" } - ] + ], + "code_owner_approval_required": "false" }, ... ] @@ -115,7 +117,8 @@ Example response: "access_level": 40, "access_level_description": "Maintainers" } - ] + ], + "code_owner_approval_required": "false" } ``` @@ -142,7 +145,8 @@ Example response: "group_id": 1234, "access_level_description": "Example Merge Group" } - ] + ], + "code_owner_approval_required": "false" } ``` @@ -161,14 +165,15 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitla | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `name` | string | yes | The name of the branch or wildcard | -| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) | -| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) | -| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) | -| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash | -| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash | -| `allowed_to_unprotect` | array | no | **(STARTER)**Array of access levels allowed to unprotect, with each described by a hash | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `name` | string | yes | The name of the branch or wildcard | +| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) | +| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) | +| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) | +| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash | +| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash | +| `allowed_to_unprotect` | array | no | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash | +| `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false) | Example response: @@ -192,7 +197,8 @@ Example response: "access_level": 40, "access_level_description": "Maintainers" } - ] + ], + "code_owner_approval_required": "false" } ``` @@ -227,7 +233,8 @@ Example response: "group_id": null, "access_level_description": "Maintainers" } - ] + ], + "code_owner_approval_required": "false" } ``` @@ -268,7 +275,8 @@ Example response: "group_id": null, "access_level_description": "Maintainers" } - ] + ], + "code_owner_approval_required": "false" } ``` diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index 90e4dacbd76..f718f01aba5 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -97,6 +97,8 @@ Once you've set up your identity provider to work with GitLab, you'll need to co ## Providers +NOTE: **Note:** GitLab is unable to provide support for IdPs that are not listed here. + | Provider | Documentation | |----------|---------------| | ADFS (Active Directory Federation Services) | [Create a Relying Party Trust](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) | |