Skip to content

Latest commit

 

History

History
146 lines (117 loc) · 11.5 KB

README.md

File metadata and controls

146 lines (117 loc) · 11.5 KB
Raw

Project Status: Netlify Status

Inspired by sylveon

Demo

Support Discord Server

Table of Contents
  1. Deploy on Netlify
  2. Deploy on your own web server
  3. How to block users
  4. How to create your own custom questions
  5. Adding Email Functionality to appeals form
  6. Generating a Personal Access Token
  7. Deny and Block Feature
  8. Differences between this repo and sylveon's
  9. Feature Roadmap

Home page webhook in action user blocked

How to use this project:

REQUIREMENTS

  • Have a server where you are able to:
    • Make channels
    • Create Webhooks
    • Invite bots

Easy Way: Deploy on Netlify

NOTE: If you already have a custom bot in your server and access to its credentials, skip the first step

  • Create a custom bot inside your server. You can register/invite one here. Keep that window handy.
  • Click the "Deploy to Netlify" button.
    • You will be asked to link your GitHub account then enter values for all the environment variables. (See Environment Variable Information Table)
  • Set the environment variables from your Discord bot application page (REACT_APP_CLIENT_ID, REACT_APP_CLIENT_SECRET, REACT_APP_DISCORD_BOT_TOKEN)
  • Choose a channel (or create a new one) where you want all the ban appeals to appear and copy its ID into APPEALS_CHANNEL
  • Copy your server's ID into REACT_APP_GUILD_ID
  • Make a random JWT Secret or generator one here and set inside REACT_APP_JWT_SECRET
  • Set REACT_APP_ENABLE_HCAPTCHA to false unless you intend to add hCaptcha
  • Set REACT_APP_ENABLE_SENDGRID to false unless you intend to use Sendgrid for unban notifications.
  • Make and set the GITHUB_PAT (see table for information on how)
  • Deploy your application
  • Lastly we'll want to make sure users can login using Discord
    • First make any changes to the netlify.app deployment URL you wish, or set up your own custom one!
    • From the Discord Developer Application page Select the OAuth tab
    • Click on Add Redirect and enter https://[site-url]/callback where [site-url] is the site name netlify assigned you, or the one you changed it to.

Environment Variable Information

Environment Variable Description Optional?
REACT_APP_CLIENT_ID Client ID of a Discord Application No
REACT_APP_CLIENT_SECRET Client Secret of a Discord Application No
REACT_APP_DISCORD_BOT_TOKEN The Bot token of a Discord Application No
REACT_APP_GUILD_ID The Server/Guild ID where you are accepting ban appeals No
REACT_APP_JWT_SECRET A really long string of characters used to establish
a secure line of communication with the API of this app.
I would recommend using a password generator to create this.
You don't have to remember what its set to		 No
REACT_APP_SKIP_BAN_CHECK If set to "true" the application will not check if
a user is banned before allowing them to fill out
an appeal form		 Yes
REACT_APP_BANNER_URL Add a custom banner behind your server icon.
Must be a direct link to an image
(usually ends in .jpeg or .png etc.)		 Yes
REACT_APP_SITE_TITLE Use a custom title for your site (defaults to {server_name}'s Discord Ban Appeal Application if none is set) Yes
REACT_APP_SITE_DESCRIPTION Use a custom SEO description for your site (defaults to {server_name}'s Discord Ban Appeal Application if none is set) Yes
APPEALS_CHANNEL The channel where you want appeals to appear in No
REACT_APP_ENABLE_HCAPTCHA Do you want to use hCaptcha in the form? (true/false) Yes
REACT_APP_HCAPTCHA_SITE_KEY The hCaptcha site key generated by hCaptcha Yes
REACT_APP_HCAPTCHA_SECRET_KEY The secret on your hCaptcha profile Yes
REACT_APP_GOOGLE_ANALYTICS_ID Google Analytics Tracking ID like UA-000000-01. Yes
REACT_APP_ENABLE_SENDGRID Sends users an email when they are unbanned (true/false) See Wiki if you don't know how to set this up No
SENDGRID_API_KEY API Key for Sendgrid Yes
SENDGRID_SENDER_EMAIL Single Sender Verification Email Yes
INVITE_URL Discord invite that can be used in email template to unbanned users Yes
GITHUB_PAT Github Personal Access Token for Deny and Block feature to work. Make sure it never expires and to select the repo scope No

Hard Way: Deploy on your own web server

This if by far not the prettiest way to do this which is why I recommend you use netlify, but if you're smart enough to deploy this on your own then go for it!

Requirements:

Be aware this project uses serverless functions as its API layer. All the API requests are directed at /.netlify/functions because support issues with netlify's redirect rules. To deploy this yourself you will need to create a serverless API using AWS Lambda or an equivalent from Azure or GCP. I will go into specifics below.

Web frontend

  • Fork this repo
  • Copy .env.example to .env and fill in each value
  • Run yarn install to install the dependencies
  • Run yarn build to compile a production build
  • Direct your webserver to serve the ./build/ directory

Serverless backend

  • Create a new serverless API in your cloud provider with 4 endpoints.
    • Each File in /functions will be an endpoint, and most of them will require both the files in the /functions/helpers folder
  • Make sure all the packages from package.json are installed and available for each function
  • Find and replace all occurrences of /.netlify/functions/ with your endpoint for each function

I've oversimplified a lot of the serverless portion here since it will vary based on your cloud provider but this covers the jist of things.

Adding hCaptcha (like reCaptcha)

See Wiki article

How to block users from abusing your ban appeal form.

See Wiki article

How to create your own custom questions.

See Wiki article

Adding Email Functionality to appeals form

See Wiki article

How to generate a Personal Access Token

See Wiki article

Differences between this repo and sylveon's

  • Server icon and custom banner on landing page
  • Only allow users who are actually banned to submit an appeal
    • Ability to disable this check
  • Custom meta tags for better SEO and visibility.
  • IMO a cleaner approach to custom questions.
  • Email integration for unban notification
  • Deny and block users from discord embed

Feature roadmap

  • Allow users to be blocked from submitting a ban appeal
  • Add better meta tag support
  • Custom Questions defined by the user
  • add hCaptcha/reCaptcha
  • Integrate some means of alerting users who are unbanned
  • Additional Actions such as "Deny Ban appeal".
  • Optional Google Analytics tracking