A Self-Hosted Ban Appeal Form for a Discord Server.
This repository has been archived on 2023-04-20. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Chase c0ce839d09
Bump Deps
2023-04-03 09:41:16 -05:00
.github Initial Commit 2023-04-03 09:39:31 -05:00
.vscode Initial Commit 2023-04-03 09:39:31 -05:00
src Initial Commit 2023-04-03 09:39:31 -05:00
.dockerignore Initial Commit 2023-04-03 09:39:31 -05:00
.editorconfig Initial Commit 2023-04-03 09:39:31 -05:00
.eslintrc.json Initial Commit 2023-04-03 09:39:31 -05:00
.gitattributes Initial Commit 2023-04-03 09:39:31 -05:00
.gitignore Initial Commit 2023-04-03 09:39:31 -05:00
Dockerfile Initial Commit 2023-04-03 09:39:31 -05:00
LICENSE.md Initial Commit 2023-04-03 09:39:31 -05:00
README.md Initial Commit 2023-04-03 09:39:31 -05:00
docker-compose.yml Initial Commit 2023-04-03 09:39:31 -05:00
package-lock.json Bump Deps 2023-04-03 09:41:16 -05:00
package.json Bump Deps 2023-04-03 09:41:16 -05:00

README.md

Discord Ban Appeals Website
GitHub Actions Status GitHub stars GitHub issues GitHub Pull Requests GitHub forks GitHub license

A Self-Hosted Ban Appeal Form for a Discord Server.

Fork & re-design of sylveon/discord-ban-appeals

Table of Contents

Screenshots

Screenshots

Index Page:

index

Appeal Form:

form

Success Page:

success

Error Page:

error

Revoke Permissions Page:

revoke-perms

Installation

Setup

  1. Create a new Discord Application.
  2. Make it a Bot account.
  3. Under the OAuth2 tab, add a new redirect of https://your-domain.here/validate.
  4. Proceed with the installation.
  5. Reverse Proxy http://localhost:port to your (sub)domain with HTTPS.

Installation

Requirements

Installation

git clone https://github.com/chxseh/discord-web-appeals.git
cd appeals
npm i

For the initial setup, use npm start. After initial setup is completed you can use pm2 start npm --name "ban-appeals" -- start to keep the web server running.

Configuration Explanation

Key Description
discordBotToken Your Discord Application's Bot Token.
clientId Your Discord Bot's Client ID.
clientSecret Your Discord Bot's Client Secret.
port The port to run this application on.
websiteUrl The URL of this site.
jwtSecret Should not be modified.
guildId The ID of the server to appeal bans on.
channelId The ID of the channel to send ban appeals to.
auditChannelID The ID of the channel to send startup messages to. (Optional)
serverName The name of your server. Used in page titles / descriptions.

Customization

Favicon

To change the favicon, simply replace ./public/img/logo.png with your own.

Sister Repositories