Documentation

ServerList guides

ServerList Documentation

Everything you need to install, configure and maintain ServerList.

ServerList

ServerList is a self-hosted Minecraft server-list platform from Viwosi Labs. It lets an operator run a public directory with server listings, status scanning, voting, owner verification, moderation, Votifier reward forwarding and optional Premium listings.

ServerList is free to download, install and use for the ServerList websites you operate. It is proprietary software, not open source: no license key, activation, telemetry or installation limit applies. The visible Powered by Viwosi Labs attribution must remain, and resale or paid redistribution is not permitted. See LICENSE.md for the complete license terms.

Production requirements

The reference deployment is a single Debian 13 or Ubuntu 24.04 VPS, but other Linux environments with equivalent services can be used. ServerList requires:

  • PHP 8.4.1 or newer for PHP-FPM and the command line, with the extensions listed in the installation guide;
  • PostgreSQL;
  • Redis;
  • Nginx, Apache, or another secure PHP-compatible web server; and
  • HTTPS for a public production site.

Official production releases include PHP dependencies and compiled frontend assets. Node.js and npm are not required for a normal production installation or update. Do not run frontend builds on a release installation.

Documentation

Start here when installing a downloaded ServerList release:

  • Installation — fresh production installation, installer, Nginx example and prerequisites.
  • Production deployment — queue worker, scheduler, HTTPS, backup preparation and operational checks.
  • Updating — the mandatory-backup updater, maintenance behavior and supported recovery principles.
  • Administration — mail, server ownership claims, Votifier, Premium listings and PayPal.
  • Premium PayPal verification — Sandbox testing, webhook setup and payment recovery details.

The supplied web installer creates the application key, database schema, default data, public-storage link and first Super Admin account. Afterward, complete the production deployment guide before treating the site as live.

Ownership verification

Server owners can prove control through a temporary Minecraft MOTD token or, for hostnames, a DNS TXT record. MOTD tokens expire after 30 minutes; DNS TXT tokens expire after 24 hours. The full administrator-facing instructions and endpoint-change behavior are in Administration.

Keep independent backups of your application data and PostgreSQL database. Viwosi Labs may provide support and future updates, but neither is guaranteed.