diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | config.json.example | 8 | ||||
| -rw-r--r-- | docs/guides/auth.md | 77 | ||||
| -rw-r--r-- | docs/guides/images/auth/application-page.png | bin | 0 -> 123152 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/create-oauth-app.png | bin | 0 -> 27920 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/create-twitter-app.png | bin | 0 -> 115406 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/register-oauth-application-form.png | bin | 0 -> 61453 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/register-twitter-application.png | bin | 0 -> 202414 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/twitter-app-confirmation.png | bin | 0 -> 191064 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/twitter-app-keys.png | bin | 0 -> 162703 bytes |
10 files changed, 85 insertions, 2 deletions
@@ -235,7 +235,7 @@ There are some configs you need to change in the files below | service | settings location | description | | ------- | --------- | ----------- | | facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap | environment variables or `config.json` | for signin | -| imgur | environment variables or `config.json` | for image upload | +| imgur, s3 | environment variables or `config.json` | for image upload | | google drive(`google/apiKey`, `google/clientID`), dropbox(`dropbox/appKey`) | `config.json` | for export and import | ## Third-party integration oauth callback urls diff --git a/config.json.example b/config.json.example index 6dd20b79..bd7ab043 100644 --- a/config.json.example +++ b/config.json.example @@ -77,6 +77,12 @@ }, "imgur": { "clientID": "change this" - } + }, + "s3": { + "accessKeyId": "change this", + "secretAccessKey": "change this", + "region": "change this" + }, + "s3bucket": "change this" } } diff --git a/docs/guides/auth.md b/docs/guides/auth.md new file mode 100644 index 00000000..37b89004 --- /dev/null +++ b/docs/guides/auth.md @@ -0,0 +1,77 @@ +# Guide - Authentication + +### Twitter +1. Sign-in or sign-up for a Twitter account +2. Go to the Twitter Application management page [here](https://apps.twitter.com/) +3. Click on the **Create New App** button to create a new Twitter app: + + + +4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application** + + + +*Note: you may have to register your phone number with Twitter to create a Twitter application* + +To do this Click your profile icon --> Settings and privacy --> Mobile --> Select Country/region --> Enter phone number --> Click Continue + +5. After you receive confirmation that the Twitter application was created, click **Keys and Access Tokens** + + + +6. Obtain your Twitter Consumer Key and Consumer Secret + + + +7. Add your Consumer Key and Consumer Secret to your config.json file or pass them as environment variables: + * config.json: + ````javascript + { + "production": { + "twitter": { + "consumerKey": "esTCJFXXXXXXXXXXXXXXXXXXX", + "consumerSecret": "zpCs4tU86pRVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + } + ```` + * environment variables: + ```` + HMD_TWITTER_CONSUMERKEY=esTCJFXXXXXXXXXXXXXXXXXXX + HMD_TWITTER_CONSUMERSECRET=zpCs4tU86pRVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + ```` + +### GitHub +1. Sign-in or sign-up for a GitHub account +2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab +3. Click on the **New OAuth App** button, to create a new OAuth App: + + + +4. Fill out the new OAuth application registration form, and click **Register Application** + + + +*Note: The callback URL is <your-hackmd-url>/auth/github/callback* + +5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application + + + +6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables + * config.json: + ````javascript + { + "production": { + "github": { + "clientID": "3747d30eaccXXXXXXXXX", + "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX" + } + } + } + ```` + * environment variables: + ```` + HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX + HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX + ```` diff --git a/docs/guides/images/auth/application-page.png b/docs/guides/images/auth/application-page.png Binary files differnew file mode 100644 index 00000000..a57da017 --- /dev/null +++ b/docs/guides/images/auth/application-page.png diff --git a/docs/guides/images/auth/create-oauth-app.png b/docs/guides/images/auth/create-oauth-app.png Binary files differnew file mode 100644 index 00000000..07d0b511 --- /dev/null +++ b/docs/guides/images/auth/create-oauth-app.png diff --git a/docs/guides/images/auth/create-twitter-app.png b/docs/guides/images/auth/create-twitter-app.png Binary files differnew file mode 100644 index 00000000..c555464e --- /dev/null +++ b/docs/guides/images/auth/create-twitter-app.png diff --git a/docs/guides/images/auth/register-oauth-application-form.png b/docs/guides/images/auth/register-oauth-application-form.png Binary files differnew file mode 100644 index 00000000..bd27fd70 --- /dev/null +++ b/docs/guides/images/auth/register-oauth-application-form.png diff --git a/docs/guides/images/auth/register-twitter-application.png b/docs/guides/images/auth/register-twitter-application.png Binary files differnew file mode 100644 index 00000000..442eb680 --- /dev/null +++ b/docs/guides/images/auth/register-twitter-application.png diff --git a/docs/guides/images/auth/twitter-app-confirmation.png b/docs/guides/images/auth/twitter-app-confirmation.png Binary files differnew file mode 100644 index 00000000..e24e9d56 --- /dev/null +++ b/docs/guides/images/auth/twitter-app-confirmation.png diff --git a/docs/guides/images/auth/twitter-app-keys.png b/docs/guides/images/auth/twitter-app-keys.png Binary files differnew file mode 100644 index 00000000..e13be110 --- /dev/null +++ b/docs/guides/images/auth/twitter-app-keys.png |
