Ticket Transcript

Configuring Ticket Transcripts

Configuration Options

Basic Configuration

Option	Description	Example
Type	Set to TXT or WEB.	"TXT"
Save	Enable or disable saving transcripts.	true
MinMessages	Minimum number of messages in a ticket required to save a transcript.	1
ArchiveChannelID	Channel ID where transcripts will be posted to.	"CHANNEL_ID"
SavePath	Path to save the transcripts.	"./transcripts/"

Web Server Configuration

If using a web server, additional details are required:

Option	Description	Example
ClientID	The Client ID for your web server application.	"CLIENT_ID"
ClientSecret	The Client Secret for your web server application.	"CLIENT_SECRET"
CallbackURL	The callback URL for authentication.	"http://IP:PORT/auth/discord/callback"
Port	The port your web server will run on. Ensure the port is open, if it isn't then it won't be accessible.	3000

Getting Client ID and Client Secret

To obtain the Client ID and Client Secret, you need to register an application with your web server provider (e.g., Discord):

1. Go to the Discord Developer Portal.

2. Navigate to your bot app.

3. Navigate to the "OAuth2" section to find your Client ID and generate a Client Secret.

4. Set the Redirect URI to match your CallbackURL defined in the config.

5. If you get Invalid OAuth2 redirect_uri then the above details are incorrect.

Example Configuration

TicketTranscript:
  Type: "TXT" # Or WEB
  Save: true
  MinMessages: "1"
  ArchiveChannelID: "CHANNEL_ID"
  SavePath: "./transcripts/"

  WebServer: # Only required if using Type WEB
    ClientID: "CLIENT_ID"
    ClientSecret: "CLIENT_SECRET"
    CallbackURL: "http://IP:PORT/auth/discord/callback"
    Port: 3000