Deploying auto-mcs

Introduction

auto-mcs is an open-source Minecraft server manager that simplifies the process of creating, configuring, and managing Minecraft servers. It provides a user-friendly interface for tasks that typically require command-line expertise, making server administration accessible to everyone.

With auto-mcs, you can set up servers for various Minecraft editions and mod loaders with just a few clicks. The application handles Java installation, server downloads, plugin management, and configuration automatically.

Key highlights of auto-mcs:

Easy Setup: Create servers in minutes without technical knowledge
Multiple Server Types: Support for Vanilla, Spigot, Paper, Forge, Fabric, and more
Version Management: Easy switching between Minecraft versions
Plugin/Mod Management: Browse and install plugins and mods directly
Automatic Backups: Scheduled world backups with restoration
Player Management: Ban lists, whitelists, and operator management
Console Access: Built-in server console for commands
Performance Monitoring: CPU, RAM, and player statistics
Scheduled Tasks: Automate restarts, backups, and commands
Multi-Server: Manage multiple servers from one interface
Remote Access: Web-based management interface

This guide walks through deploying auto-mcs on Klutch.sh using Docker for managing Minecraft servers remotely.

Why Deploy auto-mcs on Klutch.sh

Deploying auto-mcs on Klutch.sh provides several advantages for Minecraft hosting:

Remote Management: Manage your Minecraft servers from any web browser.

Always Available: Your server manager and Minecraft servers run 24/7.

Scalable Resources: Allocate CPU and RAM based on player counts.

Persistent Storage: Reliable storage for worlds, plugins, and configurations.

Automatic Builds: Deploy updates when you push configuration changes.

No Port Forwarding: Klutch.sh handles networking for easy player connections.

Prerequisites

Before deploying auto-mcs on Klutch.sh, ensure you have:

A Klutch.sh account
A GitHub account with a repository for your configuration
Basic understanding of Docker and containerization
Minecraft game client for testing connections
Understanding of Minecraft server requirements

Understanding auto-mcs Architecture

auto-mcs consists of several components:

Management Interface: Web or desktop GUI for server administration.

Server Instances: Individual Minecraft server processes.

Java Runtime: Managed Java installations for different server requirements.

File System: Storage for worlds, plugins, configs, and backups.

Preparing Your Repository

Create a GitHub repository for your auto-mcs deployment.

Repository Structure

auto-mcs-deploy/
├── Dockerfile
├── config/
│   └── auto-mcs.json
└── .dockerignore

Creating the Dockerfile

Create a Dockerfile for auto-mcs:

FROM ubuntu:22.04

# Install dependencies
RUN apt-get update && apt-get install -y \
    wget \
    curl \
    openjdk-17-jre-headless \
    openjdk-21-jre-headless \
    python3 \
    python3-pip \
    screen \
    && rm -rf /var/lib/apt/lists/*

# Create directories
WORKDIR /opt/auto-mcs
RUN mkdir -p /opt/auto-mcs/servers \
    && mkdir -p /opt/auto-mcs/backups

# Download auto-mcs
RUN wget -q https://github.com/macarooni-man/auto-mcs/releases/latest/download/auto-mcs-linux.tar.gz \
    && tar -xzf auto-mcs-linux.tar.gz \
    && rm auto-mcs-linux.tar.gz

# Environment variables
ENV JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64
ENV AUTO_MCS_PORT=${AUTO_MCS_PORT:-8080}
ENV AUTO_MCS_PASSWORD=${AUTO_MCS_PASSWORD}

# Expose ports
# Management interface
EXPOSE 8080
# Minecraft server port
EXPOSE 25565

# Volumes
VOLUME ["/opt/auto-mcs/servers", "/opt/auto-mcs/backups"]

# Start auto-mcs
CMD ["./auto-mcs", "--headless"]

Environment Variables Reference

Variable	Required	Default	Description
`AUTO_MCS_PORT`	No	8080	Web interface port
`AUTO_MCS_PASSWORD`	Yes	-	Admin password for web interface
`JAVA_HOME`	No	-	Default Java installation path
`MAX_MEMORY`	No	4G	Maximum memory for Minecraft servers

Deploying auto-mcs on Klutch.sh

Generate Admin Password

Create a secure password for the management interface.

Push Your Repository to GitHub

Initialize and push your configuration to GitHub.

Create a New Project on Klutch.sh

Navigate to the Klutch.sh dashboard and create a new project named “auto-mcs” or “minecraft”.

Create a New App

Within your project, create a new app and connect your GitHub repository.

Configure HTTP Traffic

Set up HTTP for the management interface:

Select HTTP as the traffic type
Set the internal port to 8080

Note: Minecraft game connections require TCP on port 25565, which may need additional configuration.

Set Environment Variables

Configure the following:

Variable	Value
`AUTO_MCS_PASSWORD`	Your admin password
`MAX_MEMORY`	4G (adjust based on resources)

Attach Persistent Volumes

Add storage for servers and backups:

Mount Path	Recommended Size	Purpose
`/opt/auto-mcs/servers`	50+ GB	Minecraft server files and worlds
`/opt/auto-mcs/backups`	50+ GB	World backups

Deploy Your Application

Click Deploy to build and start auto-mcs.

Access Management Interface

Once deployment completes, access auto-mcs at https://your-app-name.klutch.sh.

Creating Your First Server

Using the Web Interface

Log in to the auto-mcs web interface
Click “Create New Server”
Configure:
- Server name
- Minecraft version
- Server type (Paper, Spigot, Vanilla, etc.)
- Memory allocation
Click “Create”
Wait for server files to download

Server Types

auto-mcs supports multiple server types:

Vanilla: Official Minecraft server
Paper: High-performance Spigot fork
Spigot: Popular plugin-compatible server
Forge: Mod loader for Java Edition
Fabric: Lightweight mod loader
Purpur: Paper fork with extra features

Starting the Server

Select your server from the list
Click “Start Server”
Monitor the console for startup progress
Server is ready when you see “Done” message

Plugin and Mod Management

Installing Plugins (Paper/Spigot)

Select your server
Navigate to the Plugins tab
Search for plugins from Modrinth or SpigotMC
Click “Install” on desired plugins
Restart server to apply

Installing Mods (Forge/Fabric)

Select your server
Navigate to the Mods tab
Browse or search for mods
Install compatible mods
Restart server

Manual Installation

Upload plugins/mods manually:

Navigate to Files tab
Upload to plugins/ or mods/ folder
Restart server

Server Configuration

Server Properties

Configure server settings:

Select server
Navigate to Settings tab
Modify common options:
- Game mode
- Difficulty
- Max players
- View distance
- PVP settings

Whitelist Management

Control who can join:

Navigate to Players tab
Enable whitelist in settings
Add players by username
Remove players as needed

Operator Permissions

Grant admin privileges:

Navigate to Players tab
Click “Make Operator” on a player
Set permission level (1-4)

Backup and Restore

Configuring Backups

Set up automatic backups:

Navigate to Backups tab
Configure schedule (hourly, daily, weekly)
Set retention policy
Enable automatic backups

Manual Backups

Create immediate backups:

Navigate to Backups tab
Click “Backup Now”
Wait for completion
Backup appears in list

Restoring from Backup

Restore a previous state:

Stop the server
Navigate to Backups tab
Select backup to restore
Click “Restore”
Start server

Troubleshooting Common Issues

Server Won’t Start

Solutions:

Check console for error messages
Verify Java version is compatible
Ensure sufficient memory is allocated
Review server logs for specific errors

Players Can’t Connect

Solutions:

Verify server is running and port is correct
Check Klutch.sh network configuration
Ensure whitelist settings if enabled
Confirm Minecraft version matches client

Performance Issues

Solutions:

Allocate more memory to server
Reduce view distance in settings
Install optimization mods/plugins
Monitor resource usage

Additional Resources

Conclusion

Deploying auto-mcs on Klutch.sh gives you a powerful, user-friendly Minecraft server management platform. With support for multiple server types, easy plugin management, and automated backups, auto-mcs simplifies running Minecraft servers while Klutch.sh handles the infrastructure, giving you more time to focus on gameplay and community.