Tinyauth

GitHub

Tinyauthから GitHub OAuth ログインの設定

GitHub OAuthを使用すると、ユーザー GitHub アカウントで tinyauthにログインできます。このガイドは GitHubから OAuth アプリを作成して tinyauthに連動する方法を説明します。

1. GitHub OAuth アプリ設定

  1. GitHub Developer Settingsに接続します。
  2. OAuth Apps > New OAuth Appをクリックしてください。
  3. 次の情報を入力してください。
    • Application name：ユーザーに表示されるアプリ名
    • Homepage URL: https://내_도메인.com
    • Authorization callback URL: 
      https://내_도메인.com/api/oauth/github/callback
  4. Register applicationをクリックしてください。
  5. 生成されたアプリページから Client IDを確認し、 Generate a new client secretをクリックして Client Secretを生成します。この値を安全に保管してください。
Caution

Client Secretは作成直後にのみ表示されます。ページを離れるとまた見えないので、必ず安全な場所に保存しておいてください。

2. Tinyauth 設定

GitHubから発行された資格証明 config.yamlに設定します。

# config.yaml
identity_providers:
  - id: github
    type: github
    enabled: true
    client_id: ${GITHUB_CLIENT_ID}
    client_secret: ${GITHUB_CLIENT_SECRET}
  • id：これはプロバイダの一意の識別子です。コールバック URLに使われます。
  • type: githubで指定します。
  • client_id: GitHubから発行されたクライアントIDです。
  • client_secret: GitHubから発行されたClient Secretです。
Note

GitHub OAuthは基本的に user:email スコープをリクエストしてユーザーのメールアドレスを取得します。

例

tinyauthを https://auth.example.comで運営する場合の全体設定例です。

# config.yaml
server:
  public_origin: https://auth.example.com

identity_providers:
  - id: github
    type: github
    enabled: true
    client_id: Iv1.a1b2c3d4e5f6g7h8
    client_secret: abcdef1234567890abcdef1234567890abcdef12

この場合 GitHub OAuth アプリのAuthorization callback URLは、次のように設定する必要があります。

https://auth.example.com/api/oauth/github/callback