MSK Ticket Bot – Service Setup (English)

This guide explains how to set up the MSK Transcript Service for your self-hosted bot instance.
The service stores ticket transcripts online and makes them accessible via a public link.
Optionally, Premium users can serve transcripts under their own custom domain.

---

1. What is the Transcript Service?

When a ticket is closed, the bot generates a complete HTML transcript of all messages.
Without a configured API key, the transcript is sent as a file attachment via DM — as before.

With the MSK Transcript Service, the transcript is uploaded to www.msk-scripts.de instead
and a public link is returned. Users can open the transcript directly in their browser.

Premium users additionally get downloadable file attachments in the transcript and can
configure a custom domain so transcripts are served under their own URL.

---

2. Subscription Tiers

Feature	Basic (free)	Premium (€5/month)	Premium+ (€10/month)
Transcript as link	✅	✅	✅
Max. transcript size	10 MB	100 MB	250 MB
File attachments in transcript	❌	✅	✅
Max. attachment size per ticket	—	150 MB	500 MB
Custom domain	❌	✅	✅
Storage duration	30 days	60 days	90 days

Premium and Premium+ are unlocked via GitHub Sponsors.
Sponsor here: github.com/sponsors/MSK-Scripts

---

3. Step 1 – Create a GitHub OAuth App

Purpose: The website verifies your GitHub account to check your sponsorship status
and link it to your Discord server.

Instructions

1. Open github.com/settings/developers

2. Click "OAuth Apps" in the left sidebar

3. Click "New OAuth App"

4. Fill in the fields:

   Field	Value
   Application name	MSK Ticket Bot (or any name you like)
   Homepage URL	https://www.msk-scripts.de
   Authorization callback URL	https://www.msk-scripts.de/api/auth/github/callback
   Enable Device Flow	Leave unchecked

5. Click "Register application"

6. Copy the Client ID

7. Click "Generate a new client secret" and copy the Client Secret

Where to add these

These values go into .env.local on the web server (not the bot's .env):

GITHUB_CLIENT_ID=your_client_id_here
GITHUB_CLIENT_SECRET=your_client_secret_here

---

4. Step 2 – Create a Discord OAuth App

Purpose: The website reads your Discord server list so you can select
which server the API key should apply to.

Instructions

1. Open discord.com/developers/applications
2. Click "New Application"
3. Give it a name, e.g. MSK Ticket Verify
4. Click "OAuth2" in the left sidebar
5. Under "Redirects", click "Add Redirect" and enter:

   https://www.msk-scripts.de/api/auth/discord-verify/callback

6. Click "Save Changes"
7. Copy the Client ID shown on the OAuth2 page
8. Click "Reset Secret" and copy the Client Secret

Where to add these

DISCORD_VERIFY_CLIENT_ID=your_client_id_here
DISCORD_VERIFY_CLIENT_SECRET=your_client_secret_here

⚠️ This is a separate application from the Discord bot itself.
Do not use the bot token here — only Client ID and Secret.

---

5. Step 3 – Verify on the Website

This process must be completed once per server by a server administrator.

5.1 Open the website

Go to www.msk-scripts.de/verify in your browser.

---

5.2 Connect GitHub

Click "Sign in with GitHub".
You will be redirected to GitHub and asked to authorize the application.
You will be automatically redirected back afterwards.

ℹ️ If you are using GitHub Sponsors for Premium or Premium+, you must use the same GitHub account
you sponsor with. This is how your tier is verified automatically.

---

5.3 Connect Discord

Click "Sign in with Discord".
You will be redirected to Discord — click "Authorize".

The app requests two permissions:

• identify — to recognize your Discord account
• guilds — to display the list of your servers

---

5.4 Select your server

You will see a list of all Discord servers where you have Administrator permissions.
Select the server you want the API key for and click "Generate API Key".

ℹ️ Each server requires its own separate API key.
If you manage multiple servers, repeat the process for each one.

---

5.5 Save your API Key

After generation, your personal API key is displayed.
Copy it immediately — it will not be shown again.

MSK_API_KEY=a1b2c3d4e5f6...

⚠️ Important: If you run the verify process again for the same server,
a new API key is generated and the old one becomes invalid immediately.
You will need to update the key in your bot's .env and restart the bot.

🔒 Never share this key. Anyone who has it can upload transcripts on your behalf.

✅ You can close this page once you have safely copied the key.

---

6. Step 4 – Add the API Key to the Bot

Open the .env file in your bot folder and add:

MSK_API_KEY="your_api_key_here"
MSK_API_URL="https://www.msk-scripts.de"

Then restart the bot.

---

7. Step 5 – Set up a Custom Domain (Premium)

This step is only available for Premium and Premium+ subscribers.
Basic users can skip this step.

A custom domain lets your users access transcripts under your own URL,
e.g. https://tickets.yourserver.com/... instead of https://www.msk-scripts.de/...

7.1 Open the Dashboard

After completing the verify process, click "Go to Dashboard",
or visit www.msk-scripts.de/dashboard directly.

---

7.2 Enter your domain

In the "Custom Domain" section, enter your desired domain, e.g.:

tickets.yourserver.com

Click "Set". If the DNS is not yet pointing to the server, you will see the DNS instructions.

---

7.3 Set the DNS A-Record

Log in to your domain registrar (e.g. Cloudflare, Namecheap, IONOS) and create an A-Record:

Type	Name	Target (IP)
A	tickets (or @ for root)	The IP address shown in the dashboard

⏱ DNS propagation can take up to 24 hours.
Most providers process changes within a few minutes to an hour.

---

7.4 Validate DNS and activate

Once DNS has propagated, click "Check DNS" in the dashboard.
If the domain points correctly to the server, it will be activated automatically:

• An Apache2 VirtualHost is created on the server
• A free SSL certificate (Let's Encrypt) is obtained via Certbot
• Your transcripts are immediately accessible under your domain

---

7.5 Remove a domain

To remove a custom domain, click the trash icon next to the active domain in the dashboard.
The VirtualHost will be removed from the server and transcripts revert to the default URL.

---

8. Console Output on Startup

When the bot starts you will see the following in the terminal:

                        ███╗   ███╗███████╗██╗  ██╗
                        ████╗ ████║██╔════╝██║ ██╔╝
                        ██╔████╔██║███████╗█████╔╝
                        ██║╚██╔╝██║╚════██║██╔═██╗
                        ██║ ╚═╝ ██║███████║██║  ██╗
                        ╚═╝     ╚═╝╚══════╝╚═╝  ╚═╝
████████╗██╗ ██████╗██╗  ██╗███████╗████████╗    ██████╗  ██████╗ ████████╗
...
                 https://github.com/MSK-Scripts/discord_ticketbot

Checking API Key... [result]

Connecting to Discord...

  ✔ MSK Ticket Bot successfully started!
  ──────────────────────────────────────────
  Bot       BotName#1234
  Guilds    3
  Commands  17

Possible API Key results

Output	Meaning
Kein API Key konfiguriert → Basic	No MSK_API_KEY set in .env
API Key ungültig → Basic	The key is incorrect or has been regenerated
MSK-Server nicht erreichbar → Basic	www.msk-scripts.de is temporarily unreachable
API Key gültig → Premium	✅ Premium active
API Key gültig → Premium+	✅ Premium+ active