README

此插件为 GitLab 提供了 Social 2 for Craft CMS 的集成。

需求

此插件需要 Social 2.0.0 或更高版本。

安装

要安装此插件，请按照以下说明操作。

打开您的终端并转到您的 Craft 项目
```
 cd /path/to/project
```

然后告诉 Composer 加载插件

 composer require skayocrafts/social-gitlab

在控制面板中，转到设置 → 插件，并点击 GitLab 的“安装”按钮。

设置

要启用 GitLab 登录提供者，转到 Social → 设置 → 登录提供者，并配置“GitLab”登录提供者。

自托管 GitLab 配置

如果您有自托管的 GitLab，并且想用其代替 gitlab.com 进行 OAuth，则可以在 config/social.php 中设置域名，如下所示

<?php

return [
    'loginProviders' => [
        // ... some other config ...
        'gitlab' => [
            // ... some other config ...
            'oauth' => [
            	// ... some other config ...
                'options' => [
                    // ... some other config ...
                    'domain' => 'https://gitlab.example.com'    
                ]
            ],
        ]
    ]
];

有关社交配置的更多信息，请查看这里

一些额外信息

默认用户字段映射

GitLab 登录提供者默认定义以下用户字段映射

[
    'id'       => '{{ profile.getId() }}',
    'email'    => '{{ profile.getEmail() }}',
    'username' => '{{ profile.getUsername() }}',
    'photo'    => '{{ profile.getAvatarUrl() }}',
]

您可以使用 loginProviders 配置覆盖和扩展默认映射。

配置文件对象

GitLab 登录提供者的配置文件响应是一个 GitlabResourceOwner 对象。

方法

getId()
getName()
getUsername()
getEmail()
getAvatarUrl()
getProfileUrl()
getToken()
isActive()
isAdmin()
isExternal()
toArray()
getDomain()
setDomain()
getApiClient()
get()

skayocrafts / social-gitlab

维护者

详细信息

README

需求

安装

设置

自托管 GitLab 配置

一些额外信息

默认用户字段映射

配置文件对象

方法