docs: add Holly's guide for adding new servers to website
WHAT WAS DONE: Created quick-reference guide for Holly explaining how to add new Minecraft servers to the dynamic website status display. FILE CREATED: docs/guides/holly-new-server-guide.md COVERS: - Why: Automatic live status on website - What: Add website-api@firefrostgaming.com as subuser - How: 6-step process with exact permission (ACTIVITY → Read) - Why that permission: Safest read-only option - What if forgotten: No big deal, add anytime CONTEXT: Every new Minecraft server needs website-api added as subuser with ACTIVITY → Read permission for it to appear on the live status page. Takes 30 seconds, appears on website within 60 seconds. This is a non-technical guide written for Holly's reference when creating new servers. Signed-off-by: Claude (Chronicler #56) <claude@firefrostgaming.com>
This commit is contained in:
71
docs/guides/holly-new-server-guide.md
Normal file
71
docs/guides/holly-new-server-guide.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Quick Guide: Adding New Servers to the Website
|
||||
|
||||
**For:** Holly (unicorn20089)
|
||||
**When:** Every time you create a new Minecraft server in Pterodactyl
|
||||
**Takes:** 30 seconds
|
||||
|
||||
---
|
||||
|
||||
## Why This Matters
|
||||
|
||||
The website now shows **live server status** automatically! When you add a new server to Pterodactyl, it will appear on firefrostgaming.com/servers within 60 seconds—but only if you give the website permission to see it.
|
||||
|
||||
**What visitors see:**
|
||||
- Server name
|
||||
- Online/Offline status (with cool pulse animation!)
|
||||
- Player count
|
||||
- Real-time updates every 60 seconds
|
||||
|
||||
**What visitors DON'T see:**
|
||||
- Server IPs (those are Discord-only for Awakened+ members)
|
||||
|
||||
---
|
||||
|
||||
## What to Do (Every New Server)
|
||||
|
||||
After you create a new Minecraft server in Pterodactyl, add the website account as a viewer:
|
||||
|
||||
### Step-by-Step:
|
||||
|
||||
1. **Go to the server** in Pterodactyl (the **Client** view, not Admin)
|
||||
2. Click **"Users"** in the left sidebar
|
||||
3. Click **"Create New User"**
|
||||
4. Enter email: **`website-api@firefrostgaming.com`**
|
||||
5. Check **ONLY** this permission:
|
||||
- ✅ **ACTIVITY → Read**
|
||||
- ❌ Leave everything else unchecked!
|
||||
6. Click **"INVITE USER"**
|
||||
|
||||
**That's it!** Within 60 seconds, the server appears on the website with live status.
|
||||
|
||||
---
|
||||
|
||||
## Why Just "ACTIVITY → Read"?
|
||||
|
||||
This is the safest permission that satisfies Pterodactyl's requirement. It lets the website see:
|
||||
- ✅ Server name
|
||||
- ✅ Online/Offline status
|
||||
- ✅ Player count
|
||||
|
||||
But **NOT:**
|
||||
- ❌ Server IPs (those stay private!)
|
||||
- ❌ Control access (can't start/stop servers)
|
||||
- ❌ Files or settings
|
||||
|
||||
It's read-only status checking. Perfect for the website!
|
||||
|
||||
---
|
||||
|
||||
## What Happens If You Forget?
|
||||
|
||||
**No worries!** The server still works fine for players. It just won't show up on the website's live status page. You can add the website account anytime and it'll appear within 60 seconds.
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
Ask Michael or Meg in Discord! This is a new system we just built (April 2026) and it's pretty awesome—completely automated once the permission is set! 🔥⚡❄️
|
||||
|
||||
---
|
||||
|
||||
**Fire + Frost + Foundation = Where Love Builds Legacy** 💙
|
||||
Reference in New Issue
Block a user