Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 5.48 KB

README.md

File metadata and controls

77 lines (46 loc) · 5.48 KB
Raw

Discord Ban Appeals

This is a form that allows users to appeal their bans from a Discord server.

By using OAuth2, it ensures users can't forge or fake appeals.

How do I use this?

  1. Create an application on the Discord Developer Portal.

  2. In the Bot section of the newly created application's dashboard, create a bot account and invite it to your server with the Ban Members permission.

    Pro tip: Use a permissions calculator to generate the invite link!

  3. In your server, create a channel dedicated to ban appeals. Ensure only mods and the bot can view the channel, and that the bot has the Send Messages and Embed Links permissions for this channel.

  4. In Discord's settings, go to the Advanced section and enable Developer Mode. You will need it soon.

  5. Click this button:
    Deploy to Netlify

  6. In the web page that shows, login to your GitHub or GitLab account. You will be presented with fields to fill:

    Field name Instructions
    Client ID You can get this from the General Information section for the application you created in step 1.
    Client secret You can get this from the General Information section for the application you created in step 1.
    Bot token Get this in the Bot section that you used in step 2.
    Guild ID This is where the developer mode you enabled in step 4 comes in handy. Right-click your server icon and press Copy ID.
    Channel ID Same deal than the guild ID, but with the channel you created in step 3.
    JSON Web Token secret Use a password manager to generate a password with ~50 characters, or mash your keyboard.

  7. Login to the Netlify dashboard and go to the settings for your site.

  8. Click Change site name and give it an appropriate name, or setup a custom domain.

  9. Click Deploys, and then Trigger deploy. In the menu that shows up, hit Deploy site. This is important so that the new site name is propagated.

  10. Go back to the Discord Developer Portal, open the dashboard for the application you created in step 1, and click on OAuth2.

  11. Click on Add Redirect and enter https://[site-name].netlify.app/.netlify/functions/oauth-callback, replacing [site-name] by the name you picked in step 8 (or the entire Netlify domain by your own domain, if you opted for that).

  12. Hit the green Save Changes button.

  13. You should be good to go! You might want to test if it works as intended with an alt account, and if you encounter any problems feel free to create an issue on GitHub.

Blocking users

Users that spam requests can be blocked by creating an environment variable called BLOCKED_USERS, which should contain a comma-separated list of quoted user IDs. To do this:

  1. On your Netlify dashboard, click Deploys and navigate to Deploy settings, and then to the Environment option.

  2. Under Environment variables, click Edit variables.

  3. Right-click on any mention of the user you want to block, and click Copy ID. You need developer mode enabled for this option to show up, see instructions above.

  4. Click New variable, and create an environment variable with BLOCKED_USERS as its key. For the value, paste the user ID you copied in the previous step.

  5. To add more IDs, add a comma after the first quoted ID, and then repeat these steps starting from step 3.

  6. Redeploy the site with Deploys -> Trigger deploy -> Deploy site.

Using webhooks

When you use the DISCORD_WEBHOOK_URL, you don't need to specify the DISCORD_BOT_TOKEN, GUILD_ID, and APPEALS_CHANNEL in the environment variables. The message will be sent using the webhook without an unban button. To do this:

  1. On your Netlify dashboard, click Deploys and navigate to Deploy settings, and then to the Environment option.

  2. Under Environment variables, click Edit variables.

  3. Right-click on any channel and click Edit Channel -> Integrations -> Webhooks -> Copy Webhook URL.

  4. Click New variable, and create an environment variable with DISCORD_WEBHOOK_URL as its key. For the value, paste the Webhook URL you copied in the previous step.

  5. Redeploy the site with Deploys -> Trigger deploy -> Deploy site.