Adding documentation for Twitter
This commit is contained in:
parent
1932a2cdcf
commit
8449863fb7
|
@ -4,8 +4,6 @@ Google's OAuth integration allows us to specify multiple callback URLs, so we wi
|
|||
|
||||
### Register an application with Google
|
||||
|
||||
<!-- Notes: Based on Auth0 docs - see https://auth0.com/docs/connections/social/google -->
|
||||
|
||||
* While logged onto your Google account, goto the [API Manager](https://console.developers.google.com/)
|
||||
* From the project dropdown at the top of the page, select **Create a project...**
|
||||
|
||||
|
|
|
@ -1,5 +1,37 @@
|
|||
## Twitter
|
||||
|
||||
### Step 1
|
||||
|
||||
### Step 2
|
||||
|
||||
### Register an application with Twitter
|
||||
|
||||
* Login to [Twitter Application Management](https://apps.twitter.com/).
|
||||
* Create a new Twitter App, by clicking on **Create New App**.
|
||||
![Twitter Create New App](./images/twitter-new-app.png)
|
||||
* Provide your application details. You can either leave the **Callback URL** blank, or if you are only protecting a single wiki domain enter `https://example.wiki/auth/twitter/callback`.
|
||||
![Twitter App Details](./images/twitter-app-details.png)
|
||||
* Agree to the *Developer Agreement* and click **Create your Twitter application**.
|
||||
* Once the app has been created, go to the **Settings** tab and check that the **Allow this application to be used to Sign in with Twitter** option is selected.
|
||||
* If you are only protecting a single wiki domain you can **Enable Callback Locking**.
|
||||
* You can also change the **Application Icon**.
|
||||
* If you have changed anything press **Update Settings**.
|
||||
* Next go to the **Permissions** tab, change *Access* to *Read only*, and **Update Settings**
|
||||
![Twitter Access](./images/twitter-access.png)
|
||||
* Your application's **Consumer Key** and **Consumer Secret** will be displayed on the **Keys and Access Tokens** tab.
|
||||
![Twitter Secrets](./images/twitter-secrets.png)
|
||||
|
||||
|
||||
### Configure Wiki
|
||||
|
||||
The Wiki is configured by adding the `Consumer Key` and `Consumer Secret` to the configuration. As long as we have not selected `Enable Callback Locking` these can be added outside the `wikiDomains` definition, so they apply to the entire farm. The `wikiDomains` definition is required so that the security plugin knows what is required.
|
||||
|
||||
```JSON
|
||||
{
|
||||
"farm": true,
|
||||
"security_type": "passportjs",
|
||||
"twitter_consumerKey": "CLIENT ID",
|
||||
"twitter_consumerSecret": "CLIENT SECRET",
|
||||
"wikiDomains": {
|
||||
"example.wiki": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 101 KiB |
Binary file not shown.
After Width: | Height: | Size: 130 KiB |
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
After Width: | Height: | Size: 84 KiB |
Loading…
Reference in New Issue