diff options
| author | Claudius | 2019-03-31 16:02:05 +0200 |
|---|---|---|
| committer | Claudius | 2019-04-01 01:03:36 +0200 |
| commit | edf301cfa320cce48eaf055a57f416bc1aa6ee1e (patch) | |
| tree | 34e583fedcbce75bb3d4409cc5e21b3c18226b9f /docs/guides | |
| parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
splitting README.md into files in /docs for better readability
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to 'docs/guides')
44 files changed, 104 insertions, 34 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index d6a1095e..482bca31 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -7,17 +7,17 @@ Authentication guide - GitHub 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: diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/guides/auth/gitlab-self-hosted.md index 60f62616..d19caf76 100644 --- a/docs/guides/auth/gitlab-self-hosted.md +++ b/docs/guides/auth/gitlab-self-hosted.md @@ -7,12 +7,12 @@ 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) 3. Click **New application** to create a new application and fill out the registration form: - + 4. Click **Submit** 5. In the list of applications select **HackMD**. Leave that site open to copy the application ID and secret in the next step. - + 6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:` @@ -29,4 +29,4 @@ 7. Run `docker-compose up -d` to apply your settings. 8. Sign in to your HackMD using your GitLab ID: - + diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/guides/auth/mattermost-self-hosted.md index 631aabd3..e3050595 100644 --- a/docs/guides/auth/mattermost-self-hosted.md +++ b/docs/guides/auth/mattermost-self-hosted.md @@ -8,22 +8,22 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers 1. Sign-in with an administrator account to your Mattermost instance 2. Make sure **OAuth 2.0 Service Provider** is enabled in the Main Menu (menu button next to your username in the top left corner) --> System Console --> Custom Integrations menu, which you can find at `https://your.mattermost.domain/admin_console/integrations/custom` - + 3. Navigate to the OAuth integration settings through Main Menu --> Integrations --> OAuth 2.0 Applications, at `https://your.mattermost.domain/yourteam/integrations/oauth2-apps` 4. Click on the **Add OAuth 2.0 Application** button to add a new OAuth application - + 5. Fill out the form and click **Save** - + *Note: The callback URL is \<your-codimd-url\>/auth/oauth2/callback* 6. After saving the application, you'll receive the Client ID and Client Secret - + 7. Add the Client ID and Client Secret to your config.json file or pass them as environment variables * config.json: diff --git a/docs/guides/auth/nextcloud.md b/docs/guides/auth/nextcloud.md index 108772dd..42db8b42 100644 --- a/docs/guides/auth/nextcloud.md +++ b/docs/guides/auth/nextcloud.md @@ -10,14 +10,14 @@ This guide uses the generic OAuth2 module for compatibility with Nextcloud 13 an 2. Navigate to the OAuth integration settings: Profile Icon (top right) --> Settings Then choose Security Settings from the *Administration* part of the list - Don't confuse this with Personal Security Settings, where you would change your personal password! At the top there's OAuth 2.0-Clients. -  +  3. Add your CodiMD instance by giving it a *name* (perhaps CodiMD, but could be anything) and a *Redirection-URI*. The Redirection-URI will be `\<your-codimd-url\>/auth/oauth2/callback`. Click <kbd>Add</kbd>. -  +  4. You'll now see a line containing a *client identifier* and a *Secret*. -  +  5. That's it for Nextcloud, the rest is configured in your CodiMD `config.json` or via the `CMD_` environment variables! diff --git a/docs/guides/auth/oauth.md b/docs/guides/auth/oauth.md new file mode 100644 index 00000000..46314e26 --- /dev/null +++ b/docs/guides/auth/oauth.md @@ -0,0 +1,12 @@ +# OAuth general information + +| service | callback URL (after the server URL) | +| ------- | --------- | +| facebook | `/auth/facebook/callback` | +| twitter | `/auth/twitter/callback` | +| github | `/auth/github/callback` | +| gitlab | `/auth/gitlab/callback` | +| mattermost | `/auth/mattermost/callback` | +| dropbox | `/auth/dropbox/callback` | +| google | `/auth/google/callback` | +| saml | `/auth/saml/callback` | diff --git a/docs/guides/auth/saml-onelogin.md b/docs/guides/auth/saml-onelogin.md index 02a5ffac..14ce61a5 100644 --- a/docs/guides/auth/saml-onelogin.md +++ b/docs/guides/auth/saml-onelogin.md @@ -7,15 +7,15 @@ Authentication guide - SAML (OneLogin) 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) @@ -23,13 +23,13 @@ Authentication guide - SAML (OneLogin) * 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. @@ -51,4 +51,4 @@ Authentication guide - SAML (OneLogin) ```` 10. Try sign-in with SAML from your hackmd sign-in button or OneLogin dashboard (like the screenshot below). - + diff --git a/docs/guides/auth/twitter.md b/docs/guides/auth/twitter.md index 1b96288f..da35a4e3 100644 --- a/docs/guides/auth/twitter.md +++ b/docs/guides/auth/twitter.md @@ -7,11 +7,11 @@ Authentication guide - Twitter 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* @@ -19,11 +19,11 @@ To do this Click your profile icon --> Settings and privacy --> Mobile --> Sele 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: diff --git a/docs/guides/images/auth/application-page.png b/docs/guides/images/auth/application-page.png Binary files differdeleted file mode 100644 index a57da017..00000000 --- a/docs/guides/images/auth/application-page.png +++ /dev/null diff --git a/docs/guides/images/auth/create-oauth-app.png b/docs/guides/images/auth/create-oauth-app.png Binary files differdeleted file mode 100644 index 07d0b511..00000000 --- a/docs/guides/images/auth/create-oauth-app.png +++ /dev/null diff --git a/docs/guides/images/auth/create-twitter-app.png b/docs/guides/images/auth/create-twitter-app.png Binary files differdeleted file mode 100644 index c555464e..00000000 --- a/docs/guides/images/auth/create-twitter-app.png +++ /dev/null diff --git a/docs/guides/images/auth/gitlab-application-details.png b/docs/guides/images/auth/gitlab-application-details.png Binary files differdeleted file mode 100644 index 6e042886..00000000 --- a/docs/guides/images/auth/gitlab-application-details.png +++ /dev/null diff --git a/docs/guides/images/auth/gitlab-new-application.png b/docs/guides/images/auth/gitlab-new-application.png Binary files differdeleted file mode 100644 index be9e4446..00000000 --- a/docs/guides/images/auth/gitlab-new-application.png +++ /dev/null diff --git a/docs/guides/images/auth/gitlab-sign-in.png b/docs/guides/images/auth/gitlab-sign-in.png Binary files differdeleted file mode 100644 index 27aaf6dd..00000000 --- a/docs/guides/images/auth/gitlab-sign-in.png +++ /dev/null diff --git a/docs/guides/images/auth/mattermost-enable-oauth2.png b/docs/guides/images/auth/mattermost-enable-oauth2.png Binary files differdeleted file mode 100644 index af5cdbe2..00000000 --- a/docs/guides/images/auth/mattermost-enable-oauth2.png +++ /dev/null diff --git a/docs/guides/images/auth/mattermost-oauth-app-add.png b/docs/guides/images/auth/mattermost-oauth-app-add.png Binary files differdeleted file mode 100644 index 4a8cdfa7..00000000 --- a/docs/guides/images/auth/mattermost-oauth-app-add.png +++ /dev/null diff --git a/docs/guides/images/auth/mattermost-oauth-app-done.png b/docs/guides/images/auth/mattermost-oauth-app-done.png Binary files differdeleted file mode 100644 index fcf1beaf..00000000 --- a/docs/guides/images/auth/mattermost-oauth-app-done.png +++ /dev/null diff --git a/docs/guides/images/auth/mattermost-oauth-app-form.png b/docs/guides/images/auth/mattermost-oauth-app-form.png Binary files differdeleted file mode 100644 index 215947bf..00000000 --- a/docs/guides/images/auth/mattermost-oauth-app-form.png +++ /dev/null diff --git a/docs/guides/images/auth/nextcloud-oauth2-1-settings.png b/docs/guides/images/auth/nextcloud-oauth2-1-settings.png Binary files differdeleted file mode 100644 index 82652a54..00000000 --- a/docs/guides/images/auth/nextcloud-oauth2-1-settings.png +++ /dev/null diff --git a/docs/guides/images/auth/nextcloud-oauth2-2-client-add.png b/docs/guides/images/auth/nextcloud-oauth2-2-client-add.png Binary files differdeleted file mode 100644 index 7909fa62..00000000 --- a/docs/guides/images/auth/nextcloud-oauth2-2-client-add.png +++ /dev/null diff --git a/docs/guides/images/auth/nextcloud-oauth2-3-clientid-secret.png b/docs/guides/images/auth/nextcloud-oauth2-3-clientid-secret.png Binary files differdeleted file mode 100644 index b05513d1..00000000 --- a/docs/guides/images/auth/nextcloud-oauth2-3-clientid-secret.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-add-app.png b/docs/guides/images/auth/onelogin-add-app.png Binary files differdeleted file mode 100644 index 356bb852..00000000 --- a/docs/guides/images/auth/onelogin-add-app.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-copy-idp-metadata.png b/docs/guides/images/auth/onelogin-copy-idp-metadata.png Binary files differdeleted file mode 100644 index 7185f537..00000000 --- a/docs/guides/images/auth/onelogin-copy-idp-metadata.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-edit-app-name.png b/docs/guides/images/auth/onelogin-edit-app-name.png Binary files differdeleted file mode 100644 index 634d1916..00000000 --- a/docs/guides/images/auth/onelogin-edit-app-name.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-edit-sp-metadata.png b/docs/guides/images/auth/onelogin-edit-sp-metadata.png Binary files differdeleted file mode 100644 index 111580b1..00000000 --- a/docs/guides/images/auth/onelogin-edit-sp-metadata.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-select-template.png b/docs/guides/images/auth/onelogin-select-template.png Binary files differdeleted file mode 100644 index 13401816..00000000 --- a/docs/guides/images/auth/onelogin-select-template.png +++ /dev/null diff --git a/docs/guides/images/auth/onelogin-use-dashboard.png b/docs/guides/images/auth/onelogin-use-dashboard.png Binary files differdeleted file mode 100644 index ea9038ff..00000000 --- a/docs/guides/images/auth/onelogin-use-dashboard.png +++ /dev/null diff --git a/docs/guides/images/auth/register-oauth-application-form.png b/docs/guides/images/auth/register-oauth-application-form.png Binary files differdeleted file mode 100644 index bd27fd70..00000000 --- a/docs/guides/images/auth/register-oauth-application-form.png +++ /dev/null diff --git a/docs/guides/images/auth/register-twitter-application.png b/docs/guides/images/auth/register-twitter-application.png Binary files differdeleted file mode 100644 index 442eb680..00000000 --- a/docs/guides/images/auth/register-twitter-application.png +++ /dev/null diff --git a/docs/guides/images/auth/twitter-app-confirmation.png b/docs/guides/images/auth/twitter-app-confirmation.png Binary files differdeleted file mode 100644 index e24e9d56..00000000 --- a/docs/guides/images/auth/twitter-app-confirmation.png +++ /dev/null diff --git a/docs/guides/images/auth/twitter-app-keys.png b/docs/guides/images/auth/twitter-app-keys.png Binary files differdeleted file mode 100644 index e13be110..00000000 --- a/docs/guides/images/auth/twitter-app-keys.png +++ /dev/null diff --git a/docs/guides/images/minio-image-upload/create-bucket.png b/docs/guides/images/minio-image-upload/create-bucket.png Binary files differdeleted file mode 100644 index ccfb6715..00000000 --- a/docs/guides/images/minio-image-upload/create-bucket.png +++ /dev/null diff --git a/docs/guides/images/minio-image-upload/create-policy.png b/docs/guides/images/minio-image-upload/create-policy.png Binary files differdeleted file mode 100644 index f9cbd3bf..00000000 --- a/docs/guides/images/minio-image-upload/create-policy.png +++ /dev/null diff --git a/docs/guides/images/minio-image-upload/default-view.png b/docs/guides/images/minio-image-upload/default-view.png Binary files differdeleted file mode 100644 index fadb50a4..00000000 --- a/docs/guides/images/minio-image-upload/default-view.png +++ /dev/null diff --git a/docs/guides/images/minio-image-upload/docker-logs.png b/docs/guides/images/minio-image-upload/docker-logs.png Binary files differdeleted file mode 100644 index a25f349a..00000000 --- a/docs/guides/images/minio-image-upload/docker-logs.png +++ /dev/null diff --git a/docs/guides/images/minio-image-upload/open-edit-policy.png b/docs/guides/images/minio-image-upload/open-edit-policy.png Binary files differdeleted file mode 100644 index 1dac7bea..00000000 --- a/docs/guides/images/minio-image-upload/open-edit-policy.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/bucket-policy-editor.png b/docs/guides/images/s3-image-upload/bucket-policy-editor.png Binary files differdeleted file mode 100644 index d5f4427f..00000000 --- a/docs/guides/images/s3-image-upload/bucket-policy-editor.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/bucket-property.png b/docs/guides/images/s3-image-upload/bucket-property.png Binary files differdeleted file mode 100644 index 9f4dc828..00000000 --- a/docs/guides/images/s3-image-upload/bucket-property.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/create-bucket.png b/docs/guides/images/s3-image-upload/create-bucket.png Binary files differdeleted file mode 100644 index 925f0926..00000000 --- a/docs/guides/images/s3-image-upload/create-bucket.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/custom-policy.png b/docs/guides/images/s3-image-upload/custom-policy.png Binary files differdeleted file mode 100644 index 01c570cd..00000000 --- a/docs/guides/images/s3-image-upload/custom-policy.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/iam-user.png b/docs/guides/images/s3-image-upload/iam-user.png Binary files differdeleted file mode 100644 index b26be122..00000000 --- a/docs/guides/images/s3-image-upload/iam-user.png +++ /dev/null diff --git a/docs/guides/images/s3-image-upload/review-policy.png b/docs/guides/images/s3-image-upload/review-policy.png Binary files differdeleted file mode 100644 index 7173788a..00000000 --- a/docs/guides/images/s3-image-upload/review-policy.png +++ /dev/null diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/guides/migrations-and-breaking-changes.md new file mode 100644 index 00000000..f5a416f6 --- /dev/null +++ b/docs/guides/migrations-and-breaking-changes.md @@ -0,0 +1,58 @@ +# Migrations and Notable Changes + +## Migrating to 1.3.2 + +This is not a breaking change, but to stay up to date with the community +repository, you may need to update a few urls. This is not a breaking change. + +See more at [issue #10](https://github.com/codimd/server/issues/10) + +**Native setup using git:** + +Change the upstream remote using `git remote set-url origin https://github.com/codimd/server.git`. + +**Docker:** + +When you use our [container repository](https://github.com/codimd/container) +(which was previously `codimd-container`) all you can simply run `git pull` and +your `docker-compose.yml` will be updated. + +When you setup things yourself, make sure you use the new image: +[`quay.io/codimd/server`](https://quay.io/repository/codimd/server?tab=tags). + +**Heroku:** + +All you need to do is [disconnect GitHub](https://devcenter.heroku.com/articles/github-integration#disconnecting-from-github) +and [reconnect it](https://devcenter.heroku.com/articles/github-integration#enabling-github-integration) +with this new repository. + +Or you can use our Heroku button and redeploy your instance and link the old +database again. + +## Migrating to 1.1.0 + +We deprecated the older lower case config style and moved on to camel case style. Please have a look at the current `config.json.example` and check the warnings on startup. + +*Notice: This is not a breaking change right now but will be in the future* + +## Migrating to 0.5.0 + +[**migration-to-0.5.0**](https://github.com/hackmdio/migration-to-0.5.0) + +We don't use LZString to compress socket.io data and DB data after version 0.5.0. +Please run the migration tool if you're upgrading from the old version. + +## Migrating to 0.4.0 + +[**migration-to-0.4.0**](https://github.com/hackmdio/migration-to-0.4.0) + +We've dropped MongoDB after version 0.4.0. +So here is the migration tool for you to transfer the old DB data to the new DB. +This tool is also used for official service. + +## Operational Transformation in 0.3.2 + +From 0.3.2, we started supporting operational transformation. +It makes concurrent editing safe and will not break up other users' operations. +Additionally, now can show other clients' selections. +See more at [http://operational-transformation.github.io/](http://operational-transformation.github.io/) diff --git a/docs/guides/minio-image-upload.md b/docs/guides/minio-image-upload.md index 7f5796ca..1544e249 100644 --- a/docs/guides/minio-image-upload.md +++ b/docs/guides/minio-image-upload.md @@ -22,22 +22,22 @@ Minio Guide for CodiMD docker logs test-minio ``` -  +  3. Open http://localhost:9000 and login with the shown credentials. -  +  4. Create a bucket for HackMD -  +  5. Add a policy for the prefix `uploads` and make it read-only. -  +  *Open policy editor* -  +  *Add policy for uploads* 6. Set credentials and configs for Minio in HackMD's `config.json` diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index 40ab868a..29437019 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -4,15 +4,15 @@ 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket. -  +  2. Click on bucket, select **Properties** on the side panel, and find **Permission** section. Click **Edit bucket policy**. -  +  3. Enter the following policy, replace `bucket_name` with your bucket name: -  +  ```json { @@ -32,15 +32,15 @@ 5. Enter user page, select **Permission** tab, look at **Inline Policies** section, and click **Create User Policy** -  +  6. Select **Custom Policy** -  +  7. Enter the following policy, replace `bucket_name` with your bucket name: -  +  ```json { |
