summaryrefslogtreecommitdiff
path: root/docs/guides
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/auth.md77
-rw-r--r--docs/guides/images/auth/application-page.pngbin0 -> 123152 bytes
-rw-r--r--docs/guides/images/auth/create-oauth-app.pngbin0 -> 27920 bytes
-rw-r--r--docs/guides/images/auth/create-twitter-app.pngbin0 -> 115406 bytes
-rw-r--r--docs/guides/images/auth/register-oauth-application-form.pngbin0 -> 61453 bytes
-rw-r--r--docs/guides/images/auth/register-twitter-application.pngbin0 -> 202414 bytes
-rw-r--r--docs/guides/images/auth/twitter-app-confirmation.pngbin0 -> 191064 bytes
-rw-r--r--docs/guides/images/auth/twitter-app-keys.pngbin0 -> 162703 bytes
8 files changed, 77 insertions, 0 deletions
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:
+
+![create-twitter-app](images/auth/create-twitter-app.png)
+
+4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application**
+
+![register-twitter-application](images/auth/register-twitter-application.png)
+
+*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**
+
+![twitter-app-confirmation](images/auth/twitter-app-confirmation.png)
+
+6. Obtain your Twitter Consumer Key and Consumer Secret
+
+![twitter-app-keys](images/auth/twitter-app-keys.png)
+
+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:
+
+![create-oauth-app](images/auth/create-oauth-app.png)
+
+4. Fill out the new OAuth application registration form, and click **Register Application**
+
+![register-oauth-application-form](images/auth/register-oauth-application-form.png)
+
+*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
+
+![application-page](images/auth/application-page.png)
+
+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
new file mode 100644
index 00000000..a57da017
--- /dev/null
+++ b/docs/guides/images/auth/application-page.png
Binary files differ
diff --git a/docs/guides/images/auth/create-oauth-app.png b/docs/guides/images/auth/create-oauth-app.png
new file mode 100644
index 00000000..07d0b511
--- /dev/null
+++ b/docs/guides/images/auth/create-oauth-app.png
Binary files differ
diff --git a/docs/guides/images/auth/create-twitter-app.png b/docs/guides/images/auth/create-twitter-app.png
new file mode 100644
index 00000000..c555464e
--- /dev/null
+++ b/docs/guides/images/auth/create-twitter-app.png
Binary files differ
diff --git a/docs/guides/images/auth/register-oauth-application-form.png b/docs/guides/images/auth/register-oauth-application-form.png
new file mode 100644
index 00000000..bd27fd70
--- /dev/null
+++ b/docs/guides/images/auth/register-oauth-application-form.png
Binary files differ
diff --git a/docs/guides/images/auth/register-twitter-application.png b/docs/guides/images/auth/register-twitter-application.png
new file mode 100644
index 00000000..442eb680
--- /dev/null
+++ b/docs/guides/images/auth/register-twitter-application.png
Binary files differ
diff --git a/docs/guides/images/auth/twitter-app-confirmation.png b/docs/guides/images/auth/twitter-app-confirmation.png
new file mode 100644
index 00000000..e24e9d56
--- /dev/null
+++ b/docs/guides/images/auth/twitter-app-confirmation.png
Binary files differ
diff --git a/docs/guides/images/auth/twitter-app-keys.png b/docs/guides/images/auth/twitter-app-keys.png
new file mode 100644
index 00000000..e13be110
--- /dev/null
+++ b/docs/guides/images/auth/twitter-app-keys.png
Binary files differ