From b28839484d120c04c5a06e7f8318650c78ab195b Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Thu, 2 Jul 2020 17:22:52 +0200 Subject: Replace CodiMD with HedgeDoc Signed-off-by: Erik Michelson Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in public/views Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in README Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in SECURITY.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in LICENSE Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/configuration.md Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in bin/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/dev Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/guides/auth Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update various links in code to the new GitHub org. Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js Signed-off-by: David Mehren Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: References in docs/setup/yunohost Signed-off-by: Tilman Vatteroth Rebrand to HedgeDoc: Add banner and logo Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Remove note in docs/guides/auth/github Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace links in public/docs/features Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add todo placeholder in docs/history Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in public/views/index/body Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Replace github link in README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add logo to README Signed-off-by: Tilman Vatteroth Rename to HedgeDoc: Add note about the renaming to the front page Signed-off-by: Tilman Vatteroth Removed Travis from README.md and change CodiMD to HedgeDoc in some places Signed-off-by: Yannick Bungers Some more renaming to HedgeDoc - Fixed capitalization of HedgeDoc - Added renaming for etherpad migration doc Signed-off-by: Yannick Bungers Changed Repo name to hedgedoc Signed-off-by: Yannick Bungers --- docs/guides/auth/github.md | 4 +-- docs/guides/auth/gitlab-self-hosted.md | 6 ++-- docs/guides/auth/keycloak.md | 10 +++--- docs/guides/auth/ldap-ad.md | 2 +- docs/guides/auth/mattermost-self-hosted.md | 2 +- docs/guides/auth/nextcloud.md | 4 +-- docs/guides/auth/saml-keycloak.md | 38 ++++++++++---------- docs/guides/auth/saml-onelogin.md | 10 +++--- docs/guides/auth/saml.md | 20 +++++------ docs/guides/auth/twitter.md | 2 +- docs/guides/migrate-etherpad.md | 50 +++++++++++++------------- docs/guides/migrations-and-breaking-changes.md | 10 +++--- docs/guides/minio-image-upload.md | 12 +++---- docs/guides/providing-terms.md | 4 +-- docs/guides/s3-image-upload.md | 4 +-- 15 files changed, 88 insertions(+), 90 deletions(-) (limited to 'docs/guides') diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index dc46f74c..f540a530 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -1,7 +1,5 @@ # Authentication guide - GitHub -*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! - 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 @@ -12,7 +10,7 @@ 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 /auth/github/callback* + **Note:** *The callback URL is /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) diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/guides/auth/gitlab-self-hosted.md index 62ce1122..fc655ac5 100644 --- a/docs/guides/auth/gitlab-self-hosted.md +++ b/docs/guides/auth/gitlab-self-hosted.md @@ -1,6 +1,6 @@ # GitLab (self-hosted) -*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! +*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks! 1. Sign in to your GitLab 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) @@ -16,7 +16,7 @@ 6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:` ```Dockerfile -- CMD_DOMAIN=your.codimd.domain +- CMD_DOMAIN=your.hedgedoc.domain - CMD_URL_ADDPORT=true - CMD_PROTOCOL_USESSL=true - CMD_GITLAB_BASEURL=https://your.gitlab.domain @@ -25,6 +25,6 @@ ``` 7. Run `docker-compose up -d` to apply your settings. -8. Sign in to your CodiMD using your GitLab ID: +8. Sign in to your HedgeDoc using your GitLab ID: ![Sign in via GitLab](../../images/auth/gitlab-sign-in.png) diff --git a/docs/guides/auth/keycloak.md b/docs/guides/auth/keycloak.md index 16e24bc5..6bb3ce7d 100644 --- a/docs/guides/auth/keycloak.md +++ b/docs/guides/auth/keycloak.md @@ -1,4 +1,4 @@ -OAuth with Keycloak/Red Hat SSO (self-hosted) +# OAuth with Keycloak/Red Hat SSO (self-hosted) ## Prerequisites @@ -13,7 +13,7 @@ Where HTTPS is specified throughout, use HTTP instead. You may also have to spec You may note that a separate realm is specified throughout this tutorial. It is best practice not to use the master realm, as it normally contains the realm-management client that federates access using the policies and permissions you can create. 2. Navigate to the client management page at `https://keycloak.example.com/auth/admin/master/console/#/realms/your-realm/clients` (admin permissions required) -3. Click **Create** to create a new client and fill out the registration form. You should set the Root URL to the fully qualified public URL of your CodiMD instance. +3. Click **Create** to create a new client and fill out the registration form. You should set the Root URL to the fully qualified public URL of your HedgeDoc instance. 4. Click **Save** 5. Set the **Access Type** of the client to `confidential`. This will make your client require a client secret upon authentication. @@ -24,7 +24,7 @@ You may note that a separate realm is specified throughout this tutorial. It is 1. Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button. 2. Ensure that the **Name** field is set to `id`. 3. Create a new mapper under the Mappers tab. This should reference the User Property `id`. `Claim JSON Type` should be String and all switches below should be enabled. Save the mapper. -4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [codimd/server#56](https://github.com/codimd/server/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. +4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/server/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. --- @@ -40,10 +40,10 @@ CMD_OAUTH2_AUTHORIZATION_URL=https://keycloak.example.com/auth/realms/your-realm CMD_OAUTH2_CLIENT_ID= CMD_OAUTH2_CLIENT_SECRET= CMD_OAUTH2_PROVIDERNAME=Keycloak -CMD_DOMAIN= +CMD_DOMAIN= CMD_PROTOCOL_USESSL=true CMD_URL_ADDPORT=false ``` 6. Run `docker-compose up -d` to apply your settings. -7. Sign in to your CodiMD using your Keycloak ID +7. Sign in to your HedgeDoc using your Keycloak ID diff --git a/docs/guides/auth/ldap-ad.md b/docs/guides/auth/ldap-ad.md index fa41346e..b7d0284e 100644 --- a/docs/guides/auth/ldap-ad.md +++ b/docs/guides/auth/ldap-ad.md @@ -1,6 +1,6 @@ # AD LDAP auth -To setup your CodiMD instance with Active Directory you need the following configs: +To setup your HedgeDoc instance with Active Directory you need the following configs: ```env CMD_LDAP_URL=ldap://internal.example.com diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/guides/auth/mattermost-self-hosted.md index 5085b4e7..2ad2afd7 100644 --- a/docs/guides/auth/mattermost-self-hosted.md +++ b/docs/guides/auth/mattermost-self-hosted.md @@ -17,7 +17,7 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers 5. Fill out the form and click **Save** ![mattermost-oauth-app-form](../../images/auth/mattermost-oauth-app-form.png) -*Note: The callback URL is \/auth/oauth2/callback* +*Note: The callback URL is \/auth/oauth2/callback* 6. After saving the application, you'll receive the Client ID and Client Secret ![mattermost-oauth-app-done](../../images/auth/mattermost-oauth-app-done.png) diff --git a/docs/guides/auth/nextcloud.md b/docs/guides/auth/nextcloud.md index 8ce90ca9..e0eb28d1 100644 --- a/docs/guides/auth/nextcloud.md +++ b/docs/guides/auth/nextcloud.md @@ -11,14 +11,14 @@ This guide uses the generic OAuth2 module for compatibility with Nextcloud 13 an At the top there's OAuth 2.0-Clients. ![Where to find OAuth2 in Nextcloud](../../images/auth/nextcloud-oauth2-1-settings.png) -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 `\/auth/oauth2/callback`. Click Add. +3. Add your HedgeDoc instance by giving it a *name* (perhaps HedgeDoc, but could be anything) and a *Redirection-URI*. The Redirection-URI will be `\/auth/oauth2/callback`. Click Add. ![Adding a client to Nextcloud](../../images/auth/nextcloud-oauth2-2-client-add.png) 4. You'll now see a line containing a *client identifier* and a *Secret*. ![Successfully added OAuth2-client](../../images/auth/nextcloud-oauth2-3-clientid-secret.png) -5. That's it for Nextcloud, the rest is configured in your CodiMD `config.json` or via the `CMD_` environment variables! +5. That's it for Nextcloud, the rest is configured in your HedgeDoc `config.json` or via the `CMD_` environment variables! 6. Add the Client ID and Client Secret to your `config.json` file or pass them as environment variables. Make sure you also replace `` with the right domain name. - `config.json`: diff --git a/docs/guides/auth/saml-keycloak.md b/docs/guides/auth/saml-keycloak.md index 5caf3766..1bc3b363 100644 --- a/docs/guides/auth/saml-keycloak.md +++ b/docs/guides/auth/saml-keycloak.md @@ -1,34 +1,34 @@ -# How to setup CodiMD SAML with Keycloak +# How to setup HedgeDoc SAML with Keycloak ## Configuring Keycloak ### Get the public certificate -1. Select the Realm you want to use for your CodiMD SAML +1. Select the Realm you want to use for your HedgeDoc SAML 2. Select "Realm Settings" in left sidebar 3. Select the "Keys" tab 4. Click the button "Certificate" at `RS256` algorithm ![keycloak_idp_cert](../../images/auth/keycloak_idp_cert.png) -5. Copy this key and save it to the file specified in `saml.idpCert` property of the CodiMD configuration or `CMD_SAML_IDPCERT` environment variable +5. Copy this key and save it to the file specified in `saml.idpCert` property of the HedgeDoc configuration or `CMD_SAML_IDPCERT` environment variable ### Create a new client 1. Select "Client" in left sidebar ![keycloak_clients_overview](../../images/auth/keycloak_clients_overview.png) 2. Click on the "Create" button -3. Set a Client ID and specify this in `saml.issuer` property of the CodiMD configuration or `CMD_SAML_ISSUER` environment variable +3. Set a Client ID and specify this in `saml.issuer` property of the HedgeDoc configuration or `CMD_SAML_ISSUER` environment variable 4. Select `SAML` as Client Protocol -5. Set Client SAML Endpoint to `https://codimd.example.com/auth/saml` (replace `https://codimd.example.com` with the base URL of your CodiMD installation) +5. Set Client SAML Endpoint to `https://hedgedoc.example.com/auth/saml` (replace `https://hedgedoc.example.com` with the base URL of your HedgeDoc installation) ![keycloak_add_client](../../images/auth/keycloak_add_client.png) 6. Leave "Client Signature Required" enabled -7. Set Root URL to `https://codimd.example.com` (replace it here also with the base URL of your CodiMD installation) -8. Set Valid Redirect URIs to `https://codimd.example.com/auth/saml/callback` (you should also define all other domains of your CodiMD installtion with the suffix `/auth/saml/callback`) +7. Set Root URL to `https://hedgedoc.example.com` (replace it here also with the base URL of your HedgeDoc installation) +8. Set Valid Redirect URIs to `https://hedgedoc.example.com/auth/saml/callback` (you should also define all other domains of your HedgeDoc installtion with the suffix `/auth/saml/callback`) 9. Set Base URL to `/` ![keycloak_client_overview](../../images/auth/keycloak_client_overview.png) 10. _(optional)_ You can set which Name ID Format should be used -## Configure CodiMD +## Configure HedgeDoc ### Config file You have to put the following block inside your `config.json`: ```json "saml": { - "issuer": "codimd", // Change to the "Client ID" specified in the Keycloak Client + "issuer": "hedgedoc", // Change to the "Client ID" specified in the Keycloak Client "identifierFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", "idpSsoUrl": "https://keycloak.example.org/auth/realms/test/protocol/saml", // replace keycloak.example.org with the url of your keycloak server "idpCert": "/path/to/the/cert.pem", @@ -40,12 +40,12 @@ You have to put the following block inside your `config.json`: - `CMD_SAML_IDPSSOURL`: `https://keycloak.example.org/auth/realms/test/protocol/saml` (replace keycloak.example.org with the url of your keycloak server) - `CMD_SAML_IDPCERT`: `/path/to/the/cert.pem` - *(optional, see below)* `CMD_SAML_CLIENTCERT`: `/path/to/the/key.pem` -- `CMD_SAML_ISSUER`: `codimd` (Change to the "Client ID" specified in the Keycloak Client) +- `CMD_SAML_ISSUER`: `hedgedoc` (Change to the "Client ID" specified in the Keycloak Client) - `CMD_SAML_IDENTIFIERFORMAT`: `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` ## Client certificate *(optional)* -If you want keycloak to be able to verify CodiMD, you hava to create a client certificate. There are two options for this: +If you want keycloak to be able to verify HedgeDoc, you hava to create a client certificate. There are two options for this: ### Create Private Keys for Signing 1. Generate the private key and certificate with the following commands: @@ -56,7 +56,7 @@ openssl req -new -x509 -key priv.pem -out cert.pem *execute the following steps in keycloak* 2. Select "Client" in left sidebar -3. Go to your CodiMD-Client +3. Go to your HedgeDoc-Client 4. Select the "SAML Keys" tab ![keycloak_saml_import_cert](../../images/auth/keycloak_saml_import_cert.png) 5. Click on "Import" @@ -64,14 +64,14 @@ openssl req -new -x509 -key priv.pem -out cert.pem 7. Now upload the generated cert.pem (in this case named `cert.pem`) ![keycloak_saml_import_cert_details](../../images/auth/keycloak_saml_import_cert_details.png) 8. Click on "Import" -9. Move or copy this key (in this case named `key.pem`) and save it to the file specified in `saml.clientCert` property of the CodiMD configuration or in the enviroment-variable `CMD_SAML_CLIENTCERT` +9. Move or copy this key (in this case named `key.pem`) and save it to the file specified in `saml.clientCert` property of the HedgeDoc configuration or in the enviroment-variable `CMD_SAML_CLIENTCERT` ### Convert Private Certificate generated by KeyCloak Instead if generating you own certificate, you can also use the one generated by keycloak. 1. Select "Client" in left sidebar -2. Go to your CodiMD-Client +2. Go to your HedgeDoc-Client 3. Select the "SAML Keys" tab ![keycloak_saml_export_cert](../../images/auth/keycloak_saml_export_cert.png) @@ -83,14 +83,14 @@ Instead if generating you own certificate, you can also use the one generated by ```shell openssl pkcs12 -in keystore.p12 -out key.pem -nocerts -nodes ``` -8. Move or copy this key (in this case named `key.pem`) and save it to the file specified in `saml.idpCert` property of the CodiMD configuration or in the enviroment-variable `CMD_SAML_CLIENTCERT` +8. Move or copy this key (in this case named `key.pem`) and save it to the file specified in `saml.idpCert` property of the HedgeDoc configuration or in the enviroment-variable `CMD_SAML_CLIENTCERT` ## Use Persistent Identifiers -Instead of using the username as the owner-key in the CodiMD database, you can also use a persistent identifier. This allows to change the username, without them loosing access to their notes. +Instead of using the username as the owner-key in the HedgeDoc database, you can also use a persistent identifier. This allows to change the username, without them loosing access to their notes. -1. Go to the CodiMD-Client in keycloak. Now enable the option "Force Name ID Format" and select "persistent" as the "Name ID Format". +1. Go to the HedgeDoc-Client in keycloak. Now enable the option "Force Name ID Format" and select "persistent" as the "Name ID Format". ![keycloak_force_idformat](../../images/auth/keycloak_force_idformat.png) -2. For codimd to be able to use the username and email configured in keycloak, you have to create the following SAML protocol mappers: +2. For HedgeDoc to be able to use the username and email configured in keycloak, you have to create the following SAML protocol mappers: 2.1. Create a mapper with the type `User Property`. Set the Name, Property and SAML Attribute Name to `username`. Now you can specify a friendly name (for example `Username`) ![keycloak_mapper_username](../../images/auth/keycloak_mapper_username.png) 2.2 Create a mapper with the type `User Property`. Set the Name, Property and SAML Attribute Name to `email`. Now you can specify a friendly name (for example `E-Mail`) @@ -106,7 +106,7 @@ The configured mappers should look like this: "email": "email", } ``` -It you configure CodiMD with enviroment variables, these are the ones you have to set: +It you configure HedgeDoc with enviroment variables, these are the ones you have to set: ```bash CMD_SAML_ATTRIBUTE_USERNAME=username CMD_SAML_ATTRIBUTE_EMAIL=email diff --git a/docs/guides/auth/saml-onelogin.md b/docs/guides/auth/saml-onelogin.md index 46134e60..8b897c82 100644 --- a/docs/guides/auth/saml-onelogin.md +++ b/docs/guides/auth/saml-onelogin.md @@ -1,6 +1,6 @@ # Authentication guide - SAML (OneLogin) -**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks!* 1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks) @@ -16,9 +16,9 @@ ![onelogin-edit-app-name](../../images/auth/onelogin-edit-app-name.png) 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 CodiMD, which is issuer. (last slash is not needed) + - RelayState: The base URL of your HedgeDoc, which is issuer. (last slash is not needed) - - ACS (Consumer) URL Validator: The callback URL of your CodiMD. (serverurl + /auth/saml/callback) + - ACS (Consumer) URL Validator: The callback URL of your HedgeDoc. (serverurl + /auth/saml/callback) - ACS (Consumer) URL: same as above. @@ -31,7 +31,7 @@ - SAML 2.0 Endpoint (HTTP): Copy the URL ....(B) ![onelogin-copy-idp-metadata](../../images/auth/onelogin-copy-idp-metadata.png) -8. In your CodiMD server, create IdP certificate file from (A) +8. In your HedgeDoc 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 @@ -51,5 +51,5 @@ CMD_SAML_IDPCERT=/path/to/idp_cert.pem ``` -10. Try sign-in with SAML from your CodiMD sign-in button or OneLogin dashboard (like the screenshot below). +10. Try sign-in with SAML from your HedgeDoc sign-in button or OneLogin dashboard (like the screenshot below). ![onelogin-use-dashboard](../../images/auth/onelogin-use-dashboard.png) diff --git a/docs/guides/auth/saml.md b/docs/guides/auth/saml.md index 3b8291b7..58a2ae45 100644 --- a/docs/guides/auth/saml.md +++ b/docs/guides/auth/saml.md @@ -1,6 +1,6 @@ # Authentication guide - SAML -*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! +*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks! The basic procedure is the same as the case of OneLogin which is mentioned in [OneLogin-Guide](./saml-onelogin.md). If you want to match your IdP, you can use more configurations as below. @@ -9,7 +9,7 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O - *Note:* If not accessible 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 CodiMD as default + - `issuer`: A unique id to identify the application to the IdP, which is the base URL of your HedgeDoc 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) @@ -21,7 +21,7 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O "production": { "saml": { /* omitted */ - "issuer": "mycodimd" + "issuer": "myhedgedoc" "identifierFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" } } @@ -30,16 +30,16 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O - environment variables ```env - CMD_SAML_ISSUER=mycodimd + CMD_SAML_ISSUER=myhedgedoc CMD_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 CodiMD + - `attribute.id`: A primary key of user table for your HedgeDoc - - `attribute.username`: Attribute name of displaying user name on CodiMD + - `attribute.username`: Attribute name of displaying user name on HedgeDoc - `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 `identifierFormat` is default. @@ -70,9 +70,9 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O - If you want to control 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 CodiMD. Use vertical bar to separate for environment variables. + - `requiredGroups`: Group names array for allowed access to HedgeDoc. Use vertical bar to separate for environment variables. - - `externalGroups`: Group names array for not allowed access to CodiMD. Use vertical bar to separate for environment variables. + - `externalGroups`: Group names array for not allowed access to HedgeDoc. Use vertical bar to separate for environment variables. - *Note:* Evaluates `externalGroups` first - `config.json`: @@ -82,7 +82,7 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O "saml": { /* omitted */ "groupAttribute": "memberOf", - "requiredGroups": [ "codimd-users", "board-members" ], + "requiredGroups": [ "hedgedoc-users", "board-members" ], "externalGroups": [ "temporary-staff" ] } } @@ -92,6 +92,6 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O - environment variables ```sh CMD_SAML_GROUPATTRIBUTE=memberOf - CMD_SAML_REQUIREDGROUPS=codimd-users|board-members + CMD_SAML_REQUIREDGROUPS=hedgedoc-users|board-members CMD_SAML_EXTERNALGROUPS=temporary-staff ``` diff --git a/docs/guides/auth/twitter.md b/docs/guides/auth/twitter.md index 5e709bb4..cbb8c865 100644 --- a/docs/guides/auth/twitter.md +++ b/docs/guides/auth/twitter.md @@ -1,6 +1,6 @@ # Authentication guide - Twitter -*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! +*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks! 1. Sign-in or sign-up for a Twitter account diff --git a/docs/guides/migrate-etherpad.md b/docs/guides/migrate-etherpad.md index b501d9ac..00a48d2f 100644 --- a/docs/guides/migrate-etherpad.md +++ b/docs/guides/migrate-etherpad.md @@ -1,11 +1,11 @@ # Pad migration guide from etherpad-lite The goal of this migration is to do a "dumb" import from all the pads in Etherpad, to notes in -CodiMD. In particular, the url locations of the pads in Etherpad will be lost. Furthermore, any +HedgeDoc. In particular, the url locations of the pads in Etherpad will be lost. Furthermore, any metadata in Etherpad, such as revisions, author data and also formatted text will not be migrated -to CodiMD (only the plain text contents). +to HedgeDoc (only the plain text contents). -Note that this guide is not really meant as a support guide. I migrated my own Etherpad to CodiMD, +Note that this guide is not really meant as a support guide. I migrated my own Etherpad to HedgeDoc, and it turned out to be quite easy in my opinion. In this guide I share my experience. Stuff may require some creativity to work properly in your case. When I wrote this guide, I was using [etherpad 1.7.0][] and [codimd 1.2.1][]. Good luck! @@ -14,8 +14,8 @@ require some creativity to work properly in your case. When I wrote this guide, - `curl` - running Etherpad server -- running CodiMD server -- [codimd-cli][] +- running HedgeDoc server +- [hedgedoc-cli][] ## 1. Retrieve the list of pads @@ -36,26 +36,26 @@ weddingchecklist ## 2. Run the migration -Download [codimd-cli][] and put the script in the same directory as the file containing the pad names. +Download [hedgedoc-cli][] and put the script in the same directory as the file containing the pad names. Add to this directory the file listed below, I called it `migrate-etherpad.sh`. Modify at least the -configuration settings `ETHERPAD_SERVER` and `CODIMD_SERVER`. +configuration settings `ETHERPAD_SERVER` and `HEDGEDOC_SERVER`. ```shell #!/bin/sh # migrate-etherpad.sh # -# Description: Migrate pads from etherpad to codimd +# Description: Migrate pads from etherpad to HedgeDoc # Author: Daan Sprenkels -# This script uses the codimd command line script[1] to import a list of pads from -# [1]: https://github.com/codimd/cli/blob/master/bin/codimd +# This script uses the HedgeDoc command line script[1] to import a list of pads from +# [1]: https://github.com/hedgedoc/cli/blob/master/bin/hedgedoc # The base url to where etherpad is hosted ETHERPAD_SERVER="https://etherpad.example.com" -# The base url where codimd is hosted -CODIMD_SERVER="https://codimd.example.com" +# The base url where HedgeDoc is hosted +HEDGEDOC_SERVER="https://hedgedoc.example.com" # Write a list of pads and the urls which they were migrated to REDIRECTS_FILE="redirects.txt" @@ -73,8 +73,8 @@ for PAD_NAME in $1; do PAD_FILE="$(mktemp)" curl "$ETHERPAD_SERVER/p/$PAD_NAME/export/txt" >"$PAD_FILE" - # Import the pad into codimd - OUTPUT="$(./codimd import "$PAD_FILE")" + # Import the pad into HedgeDoc + OUTPUT="$(./hedgedoc import "$PAD_FILE")" echo "$PAD_NAME -> $OUTPUT" >>"$REDIRECTS_FILE" done ``` @@ -85,7 +85,7 @@ Call this file like this: ./migrate-etherpad.sh pad_names.txt ``` -This will download all the pads in `pad_names.txt` and put them on CodiMD. They will get assigned +This will download all the pads in `pad_names.txt` and put them on HedgeDoc. They will get assigned random ids, so you won't be able to find them. The script will save the mappings to a file though (in my case `redirects.txt`). You can use this file to redirect your users when they visit your etherpad using a `301 Permanent Redirect` status code (see the next section). @@ -95,10 +95,10 @@ etherpad using a `301 Permanent Redirect` status code (see the next section). I got a `redirects.txt` file that looked a bit like this: ```log -date-ideas -> Found. Redirecting to https://codimd.example.com/mPt0KfiKSBOTQ3mNcdfn -groceries -> Found. Redirecting to https://codimd.example.com/UukqgwLfhYyUUtARlcJ2_y -london -> Found. Redirecting to https://codimd.example.com/_d3wa-BE8t4Swv5w7O2_9R -weddingchecklist -> Found. Redirecting to https://codimd.example.com/XcQGqlBjl0u40wfT0N8TzQ +date-ideas -> Found. Redirecting to https://hedgedoc.example.com/mPt0KfiKSBOTQ3mNcdfn +groceries -> Found. Redirecting to https://hedgedoc.example.com/UukqgwLfhYyUUtARlcJ2_y +london -> Found. Redirecting to https://hedgedoc.example.com/_d3wa-BE8t4Swv5w7O2_9R +weddingchecklist -> Found. Redirecting to https://hedgedoc.example.com/XcQGqlBjl0u40wfT0N8TzQ (...) ``` @@ -106,16 +106,16 @@ Using some `sed` magic, I changed it to an nginx config snippet: ```nginx location = /p/date-ideas { - return 301 https://codimd.example.com/mPt0M1KfiKSBOTQ3mNcdfn; + return 301 https://hedgedoc.example.com/mPt0M1KfiKSBOTQ3mNcdfn; } location = /p/groceries { - return 301 https://codimd.example.com/UukqgwLfhYyUUtARlcJ2_y; + return 301 https://hedgedoc.example.com/UukqgwLfhYyUUtARlcJ2_y; } location = /p/london { - return 301 https://codimd.example.com/_d3wa-BE8t4Swv5w7O2_9R; + return 301 https://hedgedoc.example.com/_d3wa-BE8t4Swv5w7O2_9R; } location = /p/weddingchecklist { - return 301 https://codimd.example.com/XcQGqlBjl0u40wfT0N8TzQ; + return 301 https://hedgedoc.example.com/XcQGqlBjl0u40wfT0N8TzQ; } ``` @@ -123,6 +123,6 @@ I put this file into my `etherpad.example.com` nginx config, such that all the u redirected accordingly. [etherpad 1.7.0]: https://github.com/ether/etherpad-lite/tree/1.7.0 -[codimd 1.2.1]: https://github.com/codimd/server/tree/1.2.1 -[codimd-cli]: https://github.com/codimd/cli/blob/master/bin/codimd +[codimd 1.2.1]: https://github.com/hedgedoc/server/tree/1.2.1 +[hedgedoc-cli]: https://github.com/hedgedoc/cli/blob/master/bin/hedgedoc [howtolistallpads]: https://github.com/ether/etherpad-lite/wiki/How-to-list-all-pads/49701ecdcbe07aea7ad27ffa23aed0d99c2e17db diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/guides/migrations-and-breaking-changes.md index 593af446..20fa40f5 100644 --- a/docs/guides/migrations-and-breaking-changes.md +++ b/docs/guides/migrations-and-breaking-changes.md @@ -9,20 +9,20 @@ We dropped support for node 6 with this version. If you have any trouble running 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) +See more at [issue #10](https://github.com/hedgedoc/server/issues/10) ### Native setup using git -Change the upstream remote using `git remote set-url origin https://github.com/codimd/server.git`. +Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/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 +When you use our [container repository](https://github.com/hedgedoc/container) +(which was previously `hedgedoc-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). +[`quay.io/hedgedoc/server`](https://quay.io/repository/hedgedoc/server?tab=tags). ### Heroku diff --git a/docs/guides/minio-image-upload.md b/docs/guides/minio-image-upload.md index 78ddd6ec..41d9b14e 100644 --- a/docs/guides/minio-image-upload.md +++ b/docs/guides/minio-image-upload.md @@ -1,6 +1,6 @@ -# Minio Guide for CodiMD +# Minio Guide for HedgeDoc -*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! +*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks! 1. First of all you need to setup Minio itself. @@ -27,7 +27,7 @@ ![minio default view](../images/minio-image-upload/default-view.png) -4. Create a bucket for CodiMD +4. Create a bucket for HedgeDoc ![minio create bucket](../images/minio-image-upload/create-bucket.png) @@ -39,7 +39,7 @@ ![minio policy adding](../images/minio-image-upload/create-policy.png) *Add policy for uploads* -6. Set credentials and configs for Minio in CodiMD's `config.json` +6. Set credentials and configs for Minio in HedgeDoc's `config.json` ```JSON "minio": { @@ -57,7 +57,7 @@ 7. Set bucket name ```JSON - "s3bucket": "codimd" + "s3bucket": "hedgedoc" ``` 8. Set upload type. @@ -78,7 +78,7 @@ "port": 9000, "secure": false }, - "s3bucket": "codimd", + "s3bucket": "hedgedoc", "imageuploadtype": "minio" } ``` diff --git a/docs/guides/providing-terms.md b/docs/guides/providing-terms.md index c9330735..54a792f6 100644 --- a/docs/guides/providing-terms.md +++ b/docs/guides/providing-terms.md @@ -4,7 +4,7 @@ To setup your terms of use, you need to provide a document called `terms-of-use.md` which contains them. Of course written in Markdown. -It has to be provided under `./public/docs/` and will be automatically turned into a CodiMD document. It will also automatically updated as soon as you change the document on disk. +It has to be provided under `./public/docs/` and will be automatically turned into a HedgeDoc document. It will also automatically updated as soon as you change the document on disk. As soon as the file exists a link will show up in the bottom part along with the release notes and link to them. @@ -20,6 +20,6 @@ As with the terms of use, a link to the privacy notices will show up in the area To add an imprint you can use the same technique as for the terms of use. The main difference is that the document is called `imprint.md`. -It has to be provided under `./public/docs/` and will be automatically turned into a CodiMD document. It will also automatically updated as soon as you change the document on disk. +It has to be provided under `./public/docs/` and will be automatically turned into a HedgeDoc document. It will also automatically updated as soon as you change the document on disk. As with the terms of use, a link to the imprint will show up in the area where the release notes are provided on the index page. diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index cb3ae79f..740dec53 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -1,6 +1,6 @@ -# Guide - Setup CodiMD S3 image upload +# Guide - Setup HedgeDoc S3 image upload -**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks!* 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket. ![create-bucket](../images/s3-image-upload/create-bucket.png) -- cgit v1.3.1 From 978538c0de5afcf6cf4a21c0782a6b1e7fa57d9d Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Sat, 14 Nov 2020 22:24:44 +0100 Subject: Correct repo name Signed-off-by: Tilman Vatteroth --- bin/setup | 2 +- docs/configuration.md | 2 +- docs/dev/getting-started.md | 2 +- docs/dev/openapi.yml | 8 ++++---- docs/guides/auth/keycloak.md | 2 +- docs/guides/migrate-etherpad.md | 2 +- docs/guides/migrations-and-breaking-changes.md | 4 ++-- docs/history.md | 7 +++++-- docs/setup/heroku.md | 2 +- docs/setup/manual-setup.md | 2 +- lib/config/index.js | 2 +- public/views/index/body.ejs | 2 +- public/views/shared/help-modal.ejs | 2 +- 13 files changed, 21 insertions(+), 18 deletions(-) (limited to 'docs/guides') diff --git a/bin/setup b/bin/setup index 776a0a95..2fcc65d6 100755 --- a/bin/setup +++ b/bin/setup @@ -36,7 +36,7 @@ cat << EOF Edit the following config file to setup HedgeDoc server and client. -Read more info at https://github.com/hedgedoc/server#configuration-files +Read more info at https://github.com/hedgedoc/hedgedoc#configuration-files * config.json -- HedgeDoc config * .sequelizerc -- db config diff --git a/docs/configuration.md b/docs/configuration.md index 8f2d6263..528e8675 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -29,7 +29,7 @@ to `config.json` before filling in your own details. | `loglevel` | `CMD_LOGLEVEL` | **`info`**, `debug` ... | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` | | `forbiddenNoteIDs` | `CMD_FORBIDDEN_NOTE_IDS` | **`['robots.txt', 'favicon.ico', 'api', 'build', 'css', 'docs', 'fonts', 'js', 'uploads', 'vendor', 'views']`**, `['robots.txt']` or `'robots.txt'` | disallow creation of notes, even if `allowFreeUrl` or `CMD_ALLOW_FREEURL` is `true` | | `imageUploadType` | `CMD_IMAGE_UPLOAD_TYPE` | **`filesystem`**, `imgur`, `s3`, `minio`, `azure`, `lutim` | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md), also there's a whole section on their respective env vars below. | -| `sourceURL` | `CMD_SOURCE_URL` | **no default**, `https://github.com/hedgedoc/server/tree/` | Provides the link to the source code of HedgeDoc on the entry page (Please, make sure you change this when you run a modified version) | +| `sourceURL` | `CMD_SOURCE_URL` | **no default**, `https://github.com/hedgedoc/hedgedoc/tree/` | Provides the link to the source code of HedgeDoc on the entry page (Please, make sure you change this when you run a modified version) | | `tooBusyLag` | `CMD_TOOBUSY_LAG` | **`70`** | CPU time for one event loop tick until node throttles connections. (milliseconds) | | `staticCacheTime` | | **`1 * 24 * 60 * 60 * 1000`** | static file cache time | | `heartbeatInterval` | | **`5000`** | socket.io heartbeat interval | diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 9169ea4d..b0623926 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -4,7 +4,7 @@ **Notice:** *There's [specialised instructions for docker](../setup/docker.md) or [heroku](../setup/heroku.md), if you prefer running code this way!* -1. Clone the repository with `git clone https://github.com/hedgedoc/server.git hedgedoc-server` +1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc-server` (cloning is the preferred way, but you can also download and unzip a release) 2. Enter the directory and run `bin/setup`, which will install npm dependencies diff --git a/docs/dev/openapi.yml b/docs/dev/openapi.yml index d32a7ef4..aafaddc3 100644 --- a/docs/dev/openapi.yml +++ b/docs/dev/openapi.yml @@ -6,13 +6,13 @@ info: version: 1.6.0 contact: name: HedgeDoc on GitHub - url: https://github.com/hedgedoc/server + url: https://github.com/hedgedoc/hedgedoc license: name: AGPLv3 - url: https://github.com/hedgedoc/server/blob/master/LICENSE + url: https://github.com/hedgedoc/hedgedoc/blob/master/LICENSE externalDocs: - url: https://github.com/hedgedoc/server/blob/master/docs/dev/api.md + url: https://github.com/hedgedoc/hedgedoc/blob/master/docs/dev/api.md paths: @@ -281,7 +281,7 @@ paths: tags: - note summary: Creates a new GitHub Gist with the note's content. - description: 'If [GitHub integration](https://github.com/hedgedoc/server/blob/master/docs/configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created.' + description: 'If [GitHub integration](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created.' responses: default: description: Redirect to the created gist (or the GitHub authentication before) diff --git a/docs/guides/auth/keycloak.md b/docs/guides/auth/keycloak.md index 6bb3ce7d..8f85d721 100644 --- a/docs/guides/auth/keycloak.md +++ b/docs/guides/auth/keycloak.md @@ -24,7 +24,7 @@ You may note that a separate realm is specified throughout this tutorial. It is 1. Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button. 2. Ensure that the **Name** field is set to `id`. 3. Create a new mapper under the Mappers tab. This should reference the User Property `id`. `Claim JSON Type` should be String and all switches below should be enabled. Save the mapper. -4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/server/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. +4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/hedgedoc/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. --- diff --git a/docs/guides/migrate-etherpad.md b/docs/guides/migrate-etherpad.md index 00a48d2f..79784ef7 100644 --- a/docs/guides/migrate-etherpad.md +++ b/docs/guides/migrate-etherpad.md @@ -123,6 +123,6 @@ I put this file into my `etherpad.example.com` nginx config, such that all the u redirected accordingly. [etherpad 1.7.0]: https://github.com/ether/etherpad-lite/tree/1.7.0 -[codimd 1.2.1]: https://github.com/hedgedoc/server/tree/1.2.1 +[codimd 1.2.1]: https://github.com/hedgedoc/hedgedoc/tree/1.2.1 [hedgedoc-cli]: https://github.com/hedgedoc/cli/blob/master/bin/hedgedoc [howtolistallpads]: https://github.com/ether/etherpad-lite/wiki/How-to-list-all-pads/49701ecdcbe07aea7ad27ffa23aed0d99c2e17db diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/guides/migrations-and-breaking-changes.md index 20fa40f5..4c4be1f8 100644 --- a/docs/guides/migrations-and-breaking-changes.md +++ b/docs/guides/migrations-and-breaking-changes.md @@ -9,11 +9,11 @@ We dropped support for node 6 with this version. If you have any trouble running 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/hedgedoc/server/issues/10) +See more at [issue #10](https://github.com/hedgedoc/hedgedoc/issues/10) ### Native setup using git -Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/server.git`. +Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/hedgedoc.git`. ### Docker diff --git a/docs/history.md b/docs/history.md index 47792e3b..0c90b626 100644 --- a/docs/history.md +++ b/docs/history.md @@ -34,8 +34,11 @@ move the repository, so we simply forked it. We still welcome the HackMD team as part of our community, especially since a large portion of this code base originated with them. -*For the debate that lead to this step, please refer to the [governance debate](https://github.com/hackmdio/hackmd/issues/1170) and [the announcement of the new repository](https://github.com/hedgedoc/server/issues/10).* +*For the debate that lead to this step, please refer to the [governance debate](https://github.com/hackmdio/hackmd/issues/1170) and [the announcement of the new repository](https://github.com/hedgedoc/hedgedoc/issues/10).* ## CodiMD became HedgeDoc - +Many people were confused about the differences between the hackmd codimd and our codimd. +They asked us about features and bugs, that they found in the HackMD version. +That's why we decided, that we need a unique, new name and in March 2020 we started a [call to participation](https://community.codimd.org/t/renaming-yet-another-time/102). + diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md index ea1356d1..e6280051 100644 --- a/docs/setup/heroku.md +++ b/docs/setup/heroku.md @@ -3,4 +3,4 @@ You can quickly setup a sample Heroku HedgeDoc application by clicking the button below. -[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/server/tree/master) +[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hedgedoc/hedgedoc/tree/master) diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md index f197e477..4900093d 100644 --- a/docs/setup/manual-setup.md +++ b/docs/setup/manual-setup.md @@ -27,7 +27,7 @@ 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs. -4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/server/blob/master/docs/configuration.md). +4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md). 5. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development) diff --git a/lib/config/index.js b/lib/config/index.js index 495b5485..ecd25d96 100644 --- a/lib/config/index.js +++ b/lib/config/index.js @@ -157,7 +157,7 @@ for (let i = keys.length; i--;) { // Notify users about the prefix change and inform them they use legacy prefix for environment variables if (Object.keys(process.env).toString().indexOf('HMD_') !== -1) { - logger.warn('Using legacy HMD prefix for environment variables. Please change your variables in future. For details see: https://github.com/hedgedoc/server#environment-variables-will-overwrite-other-server-configs') + logger.warn('Using legacy HMD prefix for environment variables. Please change your variables in future. For details see: https://github.com/hedgedoc/hedgedoc#environment-variables-will-overwrite-other-server-configs') } // Generate session secret if it stays on default values diff --git a/public/views/index/body.ejs b/public/views/index/body.ejs index 9a76f89f..cb96e628 100644 --- a/public/views/index/body.ejs +++ b/public/views/index/body.ejs @@ -162,7 +162,7 @@ <%- __('Powered by %s', 'HedgeDoc') %> | <%= __('Releases') %> | <%= __('Source Code') %><% if(imprint) { %> | <%= __('Imprint') %><% } %><% if(privacyStatement) { %> | <%= __('Privacy') %><% } %><% if(termsOfUse) { %> | <%= __('Terms of Use') %><% } %>

diff --git a/public/views/shared/help-modal.ejs b/public/views/shared/help-modal.ejs index 88c2d9de..29872ee7 100644 --- a/public/views/shared/help-modal.ejs +++ b/public/views/shared/help-modal.ejs @@ -19,7 +19,7 @@
<%= __('Meet us on %s', 'Matrix') %>
- <%= __('Report an issue') %> + <%= __('Report an issue') %>
<%= __('Help us translating') %> -- cgit v1.3.1 From 8b8f8b458208789e0bab2b04286e793bfc9303bd Mon Sep 17 00:00:00 2001 From: mrdrogdrog Date: Sun, 15 Nov 2020 12:34:08 +0100 Subject: Update docs/guides/migrations-and-breaking-changes.md Co-authored-by: Philip Molares --- docs/guides/migrations-and-breaking-changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guides') diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/guides/migrations-and-breaking-changes.md index 4c4be1f8..bbc320b1 100644 --- a/docs/guides/migrations-and-breaking-changes.md +++ b/docs/guides/migrations-and-breaking-changes.md @@ -22,7 +22,7 @@ When you use our [container repository](https://github.com/hedgedoc/container) your `docker-compose.yml` will be updated. When you setup things yourself, make sure you use the new image: -[`quay.io/hedgedoc/server`](https://quay.io/repository/hedgedoc/server?tab=tags). +[`quay.io/hedgedoc/hedgedoc`](https://quay.io/repository/hedgedoc/hedgedoc?tab=tags). ### Heroku -- cgit v1.3.1 From 03795cbf7ba5809751da1e2366abd5a3a653c9f2 Mon Sep 17 00:00:00 2001 From: mrdrogdrog Date: Sun, 15 Nov 2020 13:19:39 +0100 Subject: Update docs/guides/auth/keycloak.md Co-authored-by: Philip Molares --- docs/guides/auth/keycloak.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guides') diff --git a/docs/guides/auth/keycloak.md b/docs/guides/auth/keycloak.md index 8f85d721..82f6d321 100644 --- a/docs/guides/auth/keycloak.md +++ b/docs/guides/auth/keycloak.md @@ -24,7 +24,7 @@ You may note that a separate realm is specified throughout this tutorial. It is 1. Select Client Scopes from the sidebar, and begin to create a new client scope using the Create button. 2. Ensure that the **Name** field is set to `id`. 3. Create a new mapper under the Mappers tab. This should reference the User Property `id`. `Claim JSON Type` should be String and all switches below should be enabled. Save the mapper. -4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/server#56](https://github.com/hedgedoc/hedgedoc/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. +4. Go to the client you set up in the previous steps using the Clients page, then choose the Client Scopes tab. Apply the scope you've created. This should mitigate errors as seen in [hedgedoc/hedgedoc#56](https://github.com/hedgedoc/hedgedoc/issues/56), as the `/userinfo` endpoint should now bring back the user's ID under the `id` key as well as `sub`. --- -- cgit v1.3.1