From e5ae07b1c22c352705f4c9ebff8c3898710c241a Mon Sep 17 00:00:00 2001 From: Mrigank Badola Date: Wed, 9 Oct 2024 09:45:10 +0530 Subject: [PATCH] chore: add cid and csec in readmes and backend docker compose yml --- README.md | 2 +- compose-dev-backend.yml | 2 ++ site/src/docs/configuration/authorization/index.md | 7 +++++++ site/src/docs/configuration/parameters/index.md | 2 ++ 4 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d37390b6..3ea32b9e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Remark42 is a self-hosted, lightweight and simple (yet functional) comment engine, which doesn't spy on users. It can be embedded into blogs, articles, or any other place where readers add comments. -* Social login via Google, Twitter, Facebook, Microsoft, GitHub, Yandex, Patreon and Telegram +* Social login via Google, Twitter, Facebook, Microsoft, GitHub, Yandex, Patreon, Discord and Telegram * Login via email * Optional anonymous access * Multi-level nested comments with both tree and plain presentations diff --git a/compose-dev-backend.yml b/compose-dev-backend.yml index 2a14fa86..055cce01 100644 --- a/compose-dev-backend.yml +++ b/compose-dev-backend.yml @@ -70,5 +70,7 @@ services: - AUTH_TWITTER_CSEC=1111 - AUTH_PATREON_CID=1111 - AUTH_PATREON_CSEC=1111 + - AUTH_DISCORD_CID=1111 + - AUTH_DISCORD_CSEC=1111 volumes: - ./var:/srv/var diff --git a/site/src/docs/configuration/authorization/index.md b/site/src/docs/configuration/authorization/index.md index abe34f0a..c148ab31 100644 --- a/site/src/docs/configuration/authorization/index.md +++ b/site/src/docs/configuration/authorization/index.md @@ -114,6 +114,13 @@ For more details refer to [Yandex OAuth](https://yandex.com/dev/oauth/doc/dg/con 3. In the field **Redirect URIs** enter the correct URI constructed as domain + `/auth/patreon/callback`, i.e., `https://example.mysite.com/auth/patreon/callback` 4. Expand client details and note the **Client ID** and **Client Secret**. Those will be used as `AUTH_PATREON_CID` and `AUTH_PATREON_CSEC` +### Discord Auth Provider + +1. Click on **New Application** to create Oauth client https://discord.com/developers/applications +2. After filling **"NAME"**, navigate to **"OAuth2"** option on the left sidebar +3. Under **"Redirects"** enter the correct url constructed as domain + `/auth/discord/callback`. ie `https://remark42.mysite.com/auth/discord/callback` +4. Take note of the **CLIENT ID** and **CLIENT SECRET**, as they are values for `AUTH_DISCORD_CID` and `AUTH_DISCORD_CSEC` respectively + ### Telegram 1. Contact [@BotFather](https://t.me/botfather) and follow his instructions to create your bot (call it, for example, "My site auth bot") diff --git a/site/src/docs/configuration/parameters/index.md b/site/src/docs/configuration/parameters/index.md index 6e36fbf8..d95d055b 100644 --- a/site/src/docs/configuration/parameters/index.md +++ b/site/src/docs/configuration/parameters/index.md @@ -97,6 +97,8 @@ services: | auth.twitter.csec | AUTH_TWITTER_CSEC | | Twitter Consumer API Secret key | | auth.patreon.cid | AUTH_PATREON_CID | | Patreon OAuth Client ID | | auth.patreon.csec | AUTH_PATREON_CSEC | | Patreon OAuth Client Secret | +| auth.discord.cid | AUTH_DISCORD_CID | | Discord OAuth Client ID | +| auth.discord.csec | AUTH_DISCORD_CSEC | | Discord OAuth Client Secret | | auth.telegram | AUTH_TELEGRAM | `false` | Enable Telegram auth (telegram.token must be present) | | auth.yandex.cid | AUTH_YANDEX_CID | | Yandex OAuth client ID | | auth.yandex.csec | AUTH_YANDEX_CSEC | | Yandex OAuth client secret |