HomeDocumentation

Documentation

Everything you need to know about Quickpaper

Contents

Quick Start

The fastest way to start a Minecraft server:

Linux / macOS / FreeBSD

bash

curl -fsSL https://quickpaper.nicompter.de/install | bash

Windows (PowerShell)

PowerShell

irm https://quickpaper.nicompter.de/install?os=win | iex

Supported Platforms

Quickpaper supports a variety of operating systems and package managers:

Linux

Ubuntu/Debian (apt)
Fedora/RHEL (dnf)
Arch Linux (pacman)
Alpine (apk)
openSUSE (zypper)
Gentoo (emerge)

macOS

macOS 10.15+ (Homebrew)

Windows

Windows 10/11 (PowerShell 5.1+)
Windows Server 2016+

FreeBSD

FreeBSD 12+ (pkg)

Bash Parameters (Linux/macOS/FreeBSD)

These parameters can be used with the Bash script:

Parameter	Type	Default	Description
`--dir`	PATH	~/paper-server	Installation directory for the server
`--version`	VERSION	latest	Minecraft version (e.g. 1.21.4, 1.20.4)
`--min-ram`	SIZE	2G	Minimum RAM for JVM (-Xms)
`--max-ram`	SIZE	4G	Maximum RAM for JVM (-Xmx)
`--port`	PORT	25565	Server port for Minecraft
`--op`	PLAYER	-	Player name that will automatically become operator
`--auto-update`	FLAG	false	Enables automatic updates to the latest Paper version
`--dashboard`	FLAG	false	Installs TheDashboard web panel plugin (1.21+ only)
`--accept-eula`	FLAG	false	Automatically accepts the Minecraft EULA (required for non-interactive)
`--yes`	FLAG	false	Automatically installs missing dependencies without prompting
`--non-interactive`	FLAG	false	No prompts, uses default values
`--lang`	LANG	auto	Language for output (de or en)
`-h, --help`	FLAG	-	Shows help

PowerShell Parameters (Windows)

These parameters can be used with the PowerShell script:

Parameter	Type	Default	Description
`-Dir`	String	~\paper-server	Installation directory for the server
`-MCVersion`	String	latest	Minecraft version (e.g. 1.21.4, 1.20.4)
`-MinRam`	String	2G	Minimum RAM for JVM (-Xms)
`-MaxRam`	String	4G	Maximum RAM for JVM (-Xmx)
`-Port`	Int	25565	Server port for Minecraft
`-Op`	String	-	Player name that will automatically become operator
`-AutoUpdate`	Switch	false	Enables automatic updates to the latest Paper version
`-Dashboard`	Switch	false	Installs TheDashboard web panel plugin (1.21+ only)
`-AcceptEula`	Switch	false	Automatically accepts the Minecraft EULA
`-Yes`	Switch	false	Automatically installs missing dependencies
`-NonInteractive`	Switch	false	No prompts, uses default values
`-Lang`	String	auto	Language for output (de or en)
`-Help`	Switch	-	Shows help

Examples

Quick installation without prompts (Linux/macOS)

bash

curl -fsSL https://quickpaper.nicompter.de/install | bash -s -- \
  --non-interactive \
  --yes \
  --accept-eula \
  --auto-update

Custom installation (Linux/macOS)

bash

curl -fsSL https://quickpaper.nicompter.de/install | bash -s -- \
  --dir /opt/minecraft \
  --version 1.21.4 \
  --min-ram 4G \
  --max-ram 8G \
  --port 25566 \
  --op MyUsername \
  --accept-eula \
  --auto-update

Windows PowerShell Installation

PowerShell

# Download und Ausführen
irm https://quickpaper.nicompter.de/install?os=win | iex

# Oder mit Parametern
irm https://quickpaper.nicompter.de/install?os=win -OutFile install.ps1
.\install.ps1 -MCVersion 1.21.4 -MinRam 4G -MaxRam 8G -Port 25566 -AcceptEula -AutoUpdate

Force language

bash

# Deutsch
curl -fsSL "https://quickpaper.nicompter.de/install?lang=de" | bash

# English
curl -fsSL "https://quickpaper.nicompter.de/install?lang=en" | bash

Auto-Update

When Auto-Update is enabled, the server checks for new Paper versions on every start and automatically updates to the latest version.

Note: Auto-Update always updates to the latest Paper version, even if you installed a specific version. This may lead to incompatible plugin versions.

TheDashboard Plugin

TheDashboard is a web panel that runs directly as a plugin. Manage your server conveniently via browser - no external software required.

Features

View and manage online players (Kick, Ban, OP)
Live console and server logs in browser
Stop and restart server
Manage whitelist
Live TPS display

After Installation

Start the server
Open in browser: http://<server-ip>:4646/
Set password on first start
Log in and start managing!

→ More info on Modrinth

tmux Session

The server runs in a tmux session, so it keeps running even after closing the terminal.

Important Commands

tmux attach -t minecraftAttach to server console
Ctrl+B, then DDetach from console (server keeps running)
tmux kill-session -t minecraftForce stop server (use "stop" in-game instead)
tmux lsList all active sessions

Why tmux?

Server keeps running after SSH disconnect
Console can be reopened anytime
Logs and outputs are preserved
Multiple sessions can run in parallel

API

The install endpoint automatically detects your operating system:

GET

/install

Automatic OS detection

GET

/install?os=win

Windows PowerShell script

GET

/install?os=linux

Bash script (Linux/macOS/FreeBSD)

GET

/install?lang=de

Force language (de/en)