-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Guide - Authentication | ||
|
||
* 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` | ||
|