search

paviliondev / discourse-discord-widget

Display a discord widget on your Discourse forum
GNU General Public License v2.0
0 stars 2 forks source link

readme

Discourse Discord Widget

🔍 Overview

This theme component allows you to add a Discord Widget as a dropdown to your Discourse site header.

Banner Image

⚙️ Configuration & Setup

How to Setup the Component

Add your Server

To find your Server ID navigate to:

  1. Server Settings
    • Server Settings
  2. Widget Settings
    • Widget Settings
  3. Enable Server Widget
    • Enable Widget
  4. Copy Server ID
    • Server ID
  5. Paste it in your theme settings:
    • Server ID Theme

Add your Invite URL

On mobile, the Discord widget is replaced with an invite link so that users can open the server in the Discord app itself. This requires the invite url.

To generate an invite url:

  1. Edit a specific channel setting
    • Edit Channel
  2. Select Invites on the Left Sidebar
    • Invite Sidebar
  3. Select "Create One"
    • Edit Invite Link
  4. Set Invite to Expire After: "Never":
    • Edit Invite Expiration
  5. Select Generate New Link Button
  6. Copy the generated new link to the theme setting entitled: discord_invite_url

Settings

The theme allows for a variety of settings. Below are some details on each setting.

require_login

Select to only shows the widget to logged in users.

minimum_trust_level

Based on Discourse's Trust Level System (more info). Enter a number value representing the trust level a user must be at in order to see the widget.

require_staff

Select to only show the widget to staff members (moderators and admins).

required_groups

Use the dropdown to select one or more groups. Users in any of the groups listed will be able to see the widget.

theme

Toggle the theme of the Discord widget. Select either light/dark to force set a theme or select 'auto' to have the theme automatically be chosen based on Discourse scheme.