Pup

v1.x

AccountsOAuth Setup

Setting OAuth credentials

In order to use OAuth logins with Pup, you need to register your credentials for each of the supported services (Facebook, GitHub, or Google) that you wish to support. The good news: we've automated this as much as possible for you. In order to configure a supported service, you will need to update your settings-development.json (as well as settings-staging.json and settings-production.json) file in the root of your project.

For each service, you will need to provide:

  • An OAuth clientId (appId for Facebook)
  • An OAuth secret
  • loginStyle for user credential retrieval (popup or redirect)

You can retrieve credentials for each service at the following links:

FAQ

Why does Pup only support Facebook, GitHub, and Google login?

Practicality. These three networks are the most popular for OAuth authentication. Twitter has been excluded because the service does not provide an email address for users which can be prohibitive later and requires extra code to handle.

/settings-development.json
{
  "public": {},
  "private": {
    "MAIL_URL": "",
    "OAuth": {
      "facebook": {
        "appId": "",
        "secret": ""
      },
      "google": {
        "clientId": "",
        "secret": ""
      },
      "github": {
        "clientId": "",
        "secret": ""
      }
    }
  }
}