Skip to content

Commit

Permalink
added small guide for auth
Browse files Browse the repository at this point in the history
  • Loading branch information
devonjs committed Oct 26, 2017
1 parent be5de23 commit 07000a2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/guides/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Guide - Authentication

### Google
* Be sure to enable Google Plus API in your Google account before using Google authentication in this application

### GitLab
* Previous versions required the user to upload a GitLab profile image for GitLab authentication to work correctly, you may need to pull the newest version to skip this issue
* For `baseURL`, use the `https` protocol
* There has been known issues with custom certificates, check that you are running Node v7+ with Hackmd
* For `scope`, GitLab currently asks users to specify `read_user` and / or `api` options, Hackmd defaults to the `api` option, you'll need to specify `read_user` for user authentication ONLY

### OAuth
* If you're using OAuth for third-party integrations (Facebook, Twitter, Github, etc.), you'll need to specify callback URLs according to the patterns [here](https://github.com/hackmdio/hackmd#third-party-integration-oauth-callback-urls)
* Example: `http://hackmd.example.com/auth/gitlab/callback`

0 comments on commit 07000a2

Please sign in to comment.