Skip to content

installation.md

Latest commit

 

History

History
139 lines (100 loc) · 4.99 KB

installation.md

File metadata and controls

139 lines (100 loc) · 4.99 KB
Raw

Installation Guide

This guide will walk you through installing and configuring the CS2 Egg for Pterodactyl.

Prerequisites

  • A working Pterodactyl Panel installation
  • Admin access to the panel
  • Docker support on your nodes

Installing the Egg

Step 1: Download the Egg

Download the egg:

Step 2: Import the Egg

  1. Log into your Pterodactyl Panel as an administrator
  2. Navigate to Admin → Nests (under Service Management)
  3. Select the nest where you want to add the egg (or create a new one)
  4. Click Import Egg
  5. Upload the downloaded JSON file
  6. Click Import

Applying to an Existing Server

If you have an existing CS2 server and want to switch to this egg:

Important: Backup First!

Always backup your server files before changing eggs.

Steps

  1. Go to Admin → Servers
  2. Select your server
  3. Navigate to the Startup tab
  4. Change the Nest to the one containing the KitsuneLab egg
  5. Change the Egg to KitsuneLab CS2 Egg @ K4ryuu
  6. Check the box for Skip Egg Install Script (important to preserve your files!)
  7. Select the Docker Image (see Docker Image Registries below):
    • Docker Hub (Limited pulls):
      • docker.io/sples1/k4ryuu-cs2:latest (Stable)
      • docker.io/sples1/k4ryuu-cs2:beta (Beta)
    • GitHub Container Registry (Unlimited pulls):
      • ghcr.io/k4ryuu/cs2-egg:latest (Stable)
      • ghcr.io/k4ryuu/cs2-egg:beta (Beta)
  8. Click Save Modifications
  9. Restart your server

Creating a New Server

  1. Navigate to Admin → Servers
  2. Click Create New
  3. Fill in the basic server details (name, owner, etc.)
  4. Scroll down to Nest Configuration
  5. Select the nest containing the KitsuneLab egg
  6. Select KitsuneLab CS2 Egg @ K4ryuu as the egg
  7. Choose your Docker Image (see Docker Image Registries below):
    • Docker Hub (Limited pulls):
      • docker.io/sples1/k4ryuu-cs2:latest (Stable)
      • docker.io/sples1/k4ryuu-cs2:beta (Beta)
    • GitHub Container Registry (Unlimited pulls - Recommended):
      • ghcr.io/k4ryuu/cs2-egg:latest (Stable)
      • ghcr.io/k4ryuu/cs2-egg:beta (Beta)
  8. Configure allocation (ports)
  9. Set resource limits (CPU, RAM, Disk)
  10. Click Create Server

First Startup

When you start your server for the first time:

  1. The Docker container will download and install SteamCMD
  2. CS2 server files will be downloaded (~30GB)
  3. This process may take 10-30 minutes depending on your connection
  4. You can watch the progress in the console

Next Steps

Docker Image Registries

The CS2 Egg is available from two container registries with different pull rate limits:

Docker Hub (Limited)

Images:

  • docker.io/sples1/k4ryuu-cs2:latest (Stable)
  • docker.io/sples1/k4ryuu-cs2:beta (Beta)

Pull Rate Limits:

  • Anonymous users: 100 pulls per 6 hours per IP address
  • Authenticated users (free): 200 pulls per 6 hours
  • Pro/Team/Business: Higher limits based on plan

Important: Docker Hub enforces strict rate limits which may affect server restarts or updates if you frequently pull images. If you hit the limit, you'll see errors like toomanyrequests: You have reached your pull rate limit.

GitHub Container Registry (Unlimited - Recommended)

Images:

  • ghcr.io/k4ryuu/cs2-egg:latest (Stable)
  • ghcr.io/k4ryuu/cs2-egg:beta (Beta)

Pull Rate Limits:

  • Public images: Unlimited anonymous pulls
  • No authentication required for public images
  • No rate limit restrictions

Recommendation: Use GitHub Container Registry (ghcr.io) images to avoid any pull rate limit issues, especially if you:

  • Run multiple servers on the same IP
  • Frequently restart or update servers
  • Use shared hosting or VPS services
  • Want guaranteed availability without authentication

Both registries contain identical images - the only difference is the pull rate limits. Switch between them anytime by changing the Docker image in your server's Startup settings.

Troubleshooting

If you encounter issues during installation:

  • Check the Troubleshooting Guide
  • Ensure your node has enough disk space (40GB+ recommended)
  • Verify Docker is working properly on your node
  • Check the console for error messages

Support

Need help?