====== oauthdiscordserver Plugin ======

---- plugin ----
description: Discord Service for use with the oAuth2 Plugin, while requiring membership within a particular server, and optionally a particular server role
author     : GeorgeTR1
email      : 
type       : action
lastupdate : 2025-04-04
compatible : Kaos
depends    : oauth
conflicts  : oauthdiscord
similar    : oauthdiscord
tags       : oauth, authentication

downloadurl: https://github.com/GeorgeTR1/dokuwiki-plugin-oauthdiscordserver/zipball/master
bugtracker : https://github.com/GeorgeTR1/dokuwiki-plugin-oauthdiscordserver/issues
sourcerepo : https://github.com/GeorgeTR1/dokuwiki-plugin-oauthdiscordserver/
donationurl: 

screenshot_img : # URL to a screenshot of the plugin in action
----

===== Installation =====

:!: **External requirements:** This plugin requires the [[plugin:oauth|oAuth Plugin]].

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Usage =====

Based on the [[plugin:oauthdiscord|oauthdiscord Plugin]], this plugin allows only Discord users who are members of a particular Discord server to login, and optionally only users with a particular role on that server. Install this plugin instead of the oauthdiscord plugin, not both.

==== Implementation Details ====

Unlike the oauthdiscord plugin, this plugin doesn't request the email address associated with a Discord user account, which is better in my opinion, since there really isn't a reason why DokuWiki needs to know this, and it therefore increases user privacy. The only reason to have your email on DokuWiki is to reset your password, which is no longer necessary if all users are authenticating with Discord; or to manage subscriptions to certain pages, but that ability is turned off by default, and is not something I think is necessary in most cases. Instead, a fake email address is created for each user, in the format <Discord User id>@discord.com. This ensures that every user has a unique email address.

Usernames and real names are set to be the same, although since usernames must be all lowercase and have no whitespace, they will be appropriately modified. The preferred source of a user's name is their server nickname on the server that is required to log in, and if they don't have one, their Discord display name is used, and if they don't have one of those, their Discord username is used.

===== Configuration and Settings =====

  * You must select ''oauth'' in the [[config:authtype]] config option, as shown in the [[plugin:oauth#installation|installation instructions]] for the oAuth Plugin.
  * You need to set the Client ID and Secret of your Discord oAuth2 application from the [[https://discord.com/developers/|Developer Portal]].
  * You also need to set the Server ID of the server that all users must be members of in order to login. To get this, you will need to first turn on developer mode in your Discord user settings, and then right clicking a server will give you the option to copy its ID to the clipboard.
  * You can also set a role within that server that users are required to have in order to login; to do this set the Role ID, which can be retrieved by right clicking like the Server ID.

For a wiki where all users must login with Discord as a means to restrict access to the wiki, which is the typically intended use case, it is highly recommended that you set the following other configuration settings:
  * Enable the ''singleService'' option in the [[plugin:oauth#configuration|Oauth configuration]]
    * This forces all users to login through Discord, instead of the standard login
  * Disable the ''Update Profile'' action in the [[config:disableactions]] config option
    * If there is expected to be a one-to-one correspondence between the names of people on the wiki and their names in a Discord server, as is the case initially, allowing users to change their name would create confusion. Also, changing passwords serves no purpose, and changing email breaks the system.
  * Set the [[config:showuseras]] config option to either ''username'' or ''username_link'' (shown in the Configuration Manager as "User's full name" or "User's full name as interwiki user link")
    * Full names are the same as login names, except that they preserve the capitalization and whitespace of the original Discord names, so they are preferred. Select ''username_link'' if you expect people to want to create their own user pages. In this case, installing a plugin like the [[plugin:userpage|Userpage Plugin]] would be advised.
  * Ensure that [[:subscription|subscribing]] to email notifications to pages is disabled (this is the case by default)
    * Since all emails are fake, subscription notifications won't work