Add OAuth Providers

Citation needed
This section is currently undocumented by the developer.
oauth_providers.yml
1
discord:
2
  provider-data:
3
    name: Discord
4
    oauth-link: https://discordapp.com/api/oauth2/authorize?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&response_type=code&scope=identify%20email&state=
5
    icon: https://static.plajer.xyz/svg/login-discord.svg
6
    color: "#7289da"
7
  environment-variables:
8
    enabled: OAUTH_DISCORD_ENABLED
9
    redirect-uri: OAUTH_DISCORD_REDIRECT_URI
10
    client-id: OAUTH_DISCORD_CLIENT_ID
11
    client-secret: OAUTH_DISCORD_CLIENT_SECRET
12
  oauth:
13
    token-url: https://discordapp.com/api/oauth2/token
14
    authorization-property: Bearer {TOKEN}
15
    user-url: https://discordapp.com/api/users/@me
16
  data-fields:
17
    id: id
18
    email: email
19
    username: username
20
    # Discord doesn't show avatar url instead shows hash, we need the url
21
    avatar: null
22
    email-verified: verified
23
github:
24
  provider-data:
25
    name: GitHub
26
    oauth-link: https://github.com/login/oauth/authorize?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope=read%3Auser%20user%3Aemail&state=
27
    icon: https://static.plajer.xyz/svg/login-github.svg
28
    color: "#333333"
29
  environment-variables:
30
    enabled: OAUTH_GITHUB_ENABLED
31
    redirect-uri: OAUTH_GITHUB_REDIRECT_URI
32
    client-id: OAUTH_GITHUB_CLIENT_ID
33
    client-secret: OAUTH_GITHUB_CLIENT_SECRET
34
  oauth:
35
    token-url: https://github.com/login/oauth/access_token
36
    authorization-property: token {TOKEN}
37
    user-url: https://api.github.com/user
38
  data-fields:
39
    id: id
40
    email: email
41
    username: login
42
    avatar: avatar
43
    email-verified: null
44
google:
45
  provider-data:
46
    name: Google
47
    oauth-link: https://accounts.google.com/o/oauth2/v2/auth?client_id={CLIENT_ID}&response_type=code&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email%20https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.profile&redirect_uri={REDIRECT_URI}&state=
48
    icon: https://static.plajer.xyz/svg/login-google.svg
49
    color: "#db4437"
50
  environment-variables:
51
    enabled: OAUTH_GOOGLE_ENABLED
52
    redirect-uri: OAUTH_GOOGLE_REDIRECT_URI
53
    client-id: OAUTH_GOOGLE_CLIENT_ID
54
    client-secret: OAUTH_GOOGLE_CLIENT_SECRET
55
  oauth:
56
    token-url: https://www.googleapis.com/oauth2/v4/token
57
    authorization-property: Bearer {TOKEN}
58
    user-url: https://www.googleapis.com/oauth2/v1/userinfo?alt=json
59
  data-fields:
60
    id: id
61
    email: email
62
    username: name
63
    avatar: picture
64
    email-verified: email_verified
65
gitlab:
66
  provider-data:
67
    name: GitLab
68
    oauth-link: https://gitlab.com/oauth/authorize?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&response_type=code&scope=read_user%20email&state=
69
    icon: https://static.plajer.xyz/svg/login-gitlab.svg
70
    color: "#fca121"
71
  environment-variables:
72
    enabled: OAUTH_GITLAB_ENABLED
73
    redirect-uri: OAUTH_GITLAB_REDIRECT_URI
74
    client-id: OAUTH_GITLAB_CLIENT_ID
75
    client-secret: OAUTH_GITLAB_CLIENT_SECRET
76
  oauth:
77
    token-url: https://gitlab.com/oauth/token
78
    authorization-property: Bearer {TOKEN}
79
    user-url: https://gitlab.com/api/v4/user
80
  data-fields:
81
    id: id
82
    email: email
83
    username: username
84
    avatar: avatar_url
85
    email-verified: null
Copied!

How To - Previous

Moderate your board

Next - Reference

Upgrading to 0.5.0

Last modified 2mo ago

Copy link