debian-mirror-gitlab/doc/integration/ding_talk.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

91 lines
3.1 KiB
Markdown
Raw Normal View History

2021-12-11 22:18:48 +05:30
---
2022-07-16 23:28:13 +05:30
stage: Manage
group: Authentication and Authorization
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-12-11 22:18:48 +05:30
---
# DingTalk OAuth 2.0 OmniAuth provider **(FREE SELF)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341898) in GitLab 14.5.
You can sign in to GitLab using your DingTalk account.
Sign in to DingTalk Open Platform and create an application on it. DingTalk generates a client ID and secret key for you to use.
1. Sign in to [DingTalk Open Platform](https://open-dev.dingtalk.com/).
1. On the top bar, select **Application development > Enterprise internal development** and then select **Create Application**.
![DingTalk menu](img/ding_talk_menu.png)
1. Fill in the application details:
2022-11-25 23:54:43 +05:30
- **Application Name**: This can be anything. Consider something like `<Organization>'s GitLab`, `<Your Name>'s GitLab`, or something else descriptive.
2021-12-11 22:18:48 +05:30
- **Application Description**: Create a description.
- **Application icon**: Upload qualified icons if needed.
![DingTalk create application](img/ding_talk_create_application.png)
1. Select **Confirm and create**.
1. On the left sidebar, select **DingTalk Application** and find your application. Select it and go to the application information page.
![DingTalk your application](img/ding_talk_your_application.png)
2022-11-25 23:54:43 +05:30
1. In the **Application Credentials** section, note the **AppKey** and **AppSecret** as you use these values later.
2021-12-11 22:18:48 +05:30
![DingTalk credentials](img/ding_talk_credentials.png)
1. On your GitLab server, open the configuration file.
For Omnibus package:
```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
2023-04-23 21:23:45 +05:30
1. Edit the [common configuration file settings](omniauth.md#configure-common-settings)
to add `dingtalk` as a single sign-on provider. This enables Just-In-Time
account provisioning for users who do not have an existing GitLab account.
2021-12-11 22:18:48 +05:30
1. Add the provider configuration:
For Omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [
{
2022-01-26 12:08:38 +05:30
name: "dingtalk",
# label: "Provider name", # optional label for login button, defaults to "Ding Talk"
2022-11-25 23:54:43 +05:30
app_id: "<your_appkey>",
app_secret: "<your_appsecret>"
2021-12-11 22:18:48 +05:30
}
]
```
For installations from source:
```yaml
2022-01-26 12:08:38 +05:30
- { name: 'dingtalk',
# label: 'Provider name', # optional label for login button, defaults to "Ding Talk"
2022-11-25 23:54:43 +05:30
app_id: '<your_appkey>',
app_secret: '<your_appsecret>' }
2021-12-11 22:18:48 +05:30
```
2022-11-25 23:54:43 +05:30
1. Replace `<your_appkey>` with the AppKey from the **Application Credentials** in step 6.
2021-12-11 22:18:48 +05:30
2022-11-25 23:54:43 +05:30
1. Replace `<your_appsecret>` with the AppSecret from the **Application Credentials** in step 6.
2021-12-11 22:18:48 +05:30
1. Save the configuration file.
2022-11-25 23:54:43 +05:30
1. For the changes to take effect, if you installed:
- Using Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure).
- From source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source).