Logo
tiny server
PluginMIT

tiny server

Simple web server for minecraft

137
Downloads
5
Followers
8 months ago
Updated
📦
3
Versions
utilitybukkitpaperpurpurspigot
Download Latestv1.2-RC.1View on Modrinth

📖About tiny server

Tiny Server

A lightweight Paper plugin that starts a built-in HTTP server directly from your Minecraft server. Perfect for custom dashboards, status pages, APIs, and simple resource hosting — all from inside your plugin folder!

Available on:

🔧 Features

  • 📡 Built-in HTTP server with no external dependencies (no NGINX or Apache)

  • 🌍 Configurable IP and port via config.yml

  • 📁 Serves static files from plugins/TinyServer/web/

  • 📄 Supports default index.html and custom file paths

  • 🛠 Lightweight and easy to use — perfect for monitoring, mini dashboards, simple APIs, and more

  • 🔐 REST API protected by a unique secret key passed via HTTP header X-API-Key

  • 🔑 When API is enabled, the plugin generates a 12-character secret key (Latin letters and digits) with the prefix tiny_. The key is saved to a file named as per the secret config value

  • 📊 API provides player online stats: current online and min/avg/max for 1, 6, 12, and 24 hours

🚀 Quick Start

  1. Install the plugin on your Paper server.

  2. Edit plugins/TinyServer/config.yml to enable API and set parameters:

ip: 0.0.0.0
port: 25984
language: en

api:
  enabled: false
  secret: secret.tserv

  1. If api.enabled: true, the plugin will generate a secret key file (e.g., plugins/TinyServer/secret.tserv) on first run.

  2. Place your static files (like index.html) into plugins/TinyServer/web/.

  3. Start your server — HTTP is available at http://your-server-ip:port.

  4. To access the API, send requests to http://your-server-ip:port/api with header:

X-API-Key: tiny_XXXXXXXXXXXX

(where tiny_XXXXXXXXXXXX is your generated key from the file)

⚙️ Example config.yml

ip: 0.0.0.0
port: 25984
language: en

api:
  enabled: true
  secret: secret.tserv

💡 Use Cases

  • Live server status and statistics display

  • Hosting local resources (images, scripts, pages)

  • imple API for external dashboards and apps

  • Local web control panel for your server

🛠 Plugin Commands

  • /tinyserver reload — reload config and language files

  • /tinyserver on — start the HTTP server

  • /tinyserver off — stop the HTTP server

If you need help with setup or integration, feel free to ask!