diff options
Diffstat (limited to 'docs/guides')
15 files changed, 215 insertions, 3 deletions
diff --git a/docs/guides/auth.md b/docs/guides/auth.md new file mode 100644 index 00000000..4f9ce445 --- /dev/null +++ b/docs/guides/auth.md @@ -0,0 +1,212 @@ +# 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 + ```` + +### SAML (OneLogin) +1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks) +2. Go to the administration page. +3. Select the **APPS** menu and click on the **Add Apps**. + + + +4. Find "SAML Test Connector (SP)" for template of settings and select it. + + + +5. Edit display name and icons for OneLogin dashboard as you want, and click **SAVE**. + + + +6. After that other tabs will appear, click the **Configuration**, and fill out the below items, and click **SAVE**. + * RelayState: The base URL of your hackmd, which is issuer. (last slash is not needed) + * ACS (Consumer) URL Validator: The callback URL of your hackmd. (serverurl + /auth/saml/callback) + * ACS (Consumer) URL: same as above. + * Login URL: login URL(SAML requester) of your hackmd. (serverurl + /auth/saml) + + + +7. The registration is completed. Next, click **SSO** and copy or download the items below. + * X.509 Certificate: Click **View Details** and **DOWNLOAD** or copy the content of certificate ....(A) + * SAML 2.0 Endpoint (HTTP): Copy the URL ....(B) + + + +8. In your hackmd server, create IdP certificate file from (A) +9. Add the IdP URL (B) and the Idp certificate file path to your config.json file or pass them as environment variables. + * config.json: + ````javascript + { + "production": { + "saml": { + "idpSsoUrl": "https://*******.onelogin.com/trust/saml2/http-post/sso/******", + "idpCert": "/path/to/idp_cert.pem" + } + } + } + ```` + * environment variables + ```` + HMD_SAML_IDPSSOURL=https://*******.onelogin.com/trust/saml2/http-post/sso/****** + HMD_SAML_IDPCERT=/path/to/idp_cert.pem + ```` +10. Try sign-in with SAML from your hackmd sign-in button or OneLogin dashboard (like the screenshot below). + + + +### SAML (Other cases) +The basic procedure is the same as the case of OneLogin which is mentioned above. If you want to match your IdP, you can use more configurations as below. + +* If your IdP accepts metadata XML of the service provider to ease configuraion, use this url to download metadata XML. + * {{your-serverurl}}/auth/saml/metadata + * _Note: If not accessable from IdP, download to local once and upload to IdP._ +* Change the value of `issuer`, `identifierFormat` to match your IdP. + * `issuer`: A unique id to identify the application to the IdP, which is the base URL of your HackMD as default + * `identifierFormat`: A format of unique id to identify the user of IdP, which is the format based on email address as default. It is recommend that you use as below. + * urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress (default) + * urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + * config.json: + ````javascript + { + "production": { + "saml": { + /* omitted */ + "issuer": "myhackmd" + "identifierFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" + } + } + } + ```` + * environment variables + ```` + HMD_SAML_ISSUER=myhackmd + HMD_SAML_IDENTIFIERFORMAT=urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + ```` + +* Change mapping of attribute names to customize the displaying user name and email address to match your IdP. + * `attribute`: A dictionary to map attribute names + * `attribute.id`: A primary key of user table for your HackMD + * `attribute.username`: Attribute name of displaying user name on HackMD + * `attribute.email`: Attribute name of email address, which will be also used for Gravatar + * _Note: Default value of all attributes is NameID of SAML response, which is email address if `idfentifierFormat` is default._ + * config.json: + ````javascript + { + "production": { + "saml": { + /* omitted */ + "attribute": { + "id": "sAMAccountName", + "username": "displayName", + "email": "mail" + } + } + } + } + ```` + * environment variables + ```` + HMD_SAML_ATTRIBUTE_ID=sAMAccountName + HMD_SAML_ATTRIBUTE_USERNAME=nickName + HMD_SAML_ATTRIBUTE_EMAIL=mail + ```` + +* If you want to controll permission by group membership, add group attribute name and required group (allowed) or external group (not allowed). + * `groupAttribute`: An attribute name of group membership + * `requiredGroups`: Group names array for allowed access to HackMD. Use vertical bar to separate for environment variables. + * `externalGroups`: Group names array for not allowed access to HackMD. Use vertical bar to separate for environment variables. + * _Note: Evaluates `externalGroups` first_ + * config.json: + ````javascript + { + "production": { + "saml": { + /* omitted */ + "groupAttribute": "memberOf", + "requiredGroups": [ "hackmd-users", "board-members" ], + "externalGroups": [ "temporary-staff" ] + } + } + } + ```` + * environment variables + ```` + HMD_SAML_GROUPATTRIBUTE=memberOf + HMD_SAML_REQUIREDGROUPS=hackmd-users|board-members + HMD_SAML_EXTERNALGROUPS=temporary-staff + ```` + + 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/onelogin-add-app.png b/docs/guides/images/auth/onelogin-add-app.png Binary files differnew file mode 100644 index 00000000..356bb852 --- /dev/null +++ b/docs/guides/images/auth/onelogin-add-app.png diff --git a/docs/guides/images/auth/onelogin-copy-idp-metadata.png b/docs/guides/images/auth/onelogin-copy-idp-metadata.png Binary files differnew file mode 100644 index 00000000..7185f537 --- /dev/null +++ b/docs/guides/images/auth/onelogin-copy-idp-metadata.png diff --git a/docs/guides/images/auth/onelogin-edit-app-name.png b/docs/guides/images/auth/onelogin-edit-app-name.png Binary files differnew file mode 100644 index 00000000..634d1916 --- /dev/null +++ b/docs/guides/images/auth/onelogin-edit-app-name.png diff --git a/docs/guides/images/auth/onelogin-edit-sp-metadata.png b/docs/guides/images/auth/onelogin-edit-sp-metadata.png Binary files differnew file mode 100644 index 00000000..111580b1 --- /dev/null +++ b/docs/guides/images/auth/onelogin-edit-sp-metadata.png diff --git a/docs/guides/images/auth/onelogin-select-template.png b/docs/guides/images/auth/onelogin-select-template.png Binary files differnew file mode 100644 index 00000000..13401816 --- /dev/null +++ b/docs/guides/images/auth/onelogin-select-template.png diff --git a/docs/guides/images/auth/onelogin-use-dashboard.png b/docs/guides/images/auth/onelogin-use-dashboard.png Binary files differnew file mode 100644 index 00000000..ea9038ff --- /dev/null +++ b/docs/guides/images/auth/onelogin-use-dashboard.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 diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index 3d6259b9..dbbef474 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -67,9 +67,9 @@ "s3": { "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", - "region": "YOUR_S3_REGION", // example: ap-northeast-1 - "bucket": "YOUR_S3_BUCKET_NAME" - } + "region": "YOUR_S3_REGION" // example: ap-northeast-1 + }, + "s3bucket": "YOUR_S3_BUCKET_NAME" } } ``` |
