Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xreatlabs.space/llms.txt

Use this file to discover all available pages before exploring further.

​
Getting Started with NexAuth

Get NexAuth up and running on your Minecraft server in minutes.
1

Prerequisites

Before installing NexAuth, ensure you have:
  • A supported Minecraft server platform (Velocity, Paper)
  • Java 17 or higher
  • Server administrator access
  • A database (MySQL/MariaDB, PostgreSQL, or H2 for testing)
2

Download NexAuth

Download the latest NexAuth release from GitHub Releases.
A single NexAuth.jar works on both Velocity proxies and Paper/Purpur servers - no separate files needed.
3

Install Plugin

Place the downloaded JAR file in your server’s plugins folder.
# For Velocity
cp NexAuth.jar /path/to/velocity/plugins/

# For Paper
cp NexAuth.jar /path/to/paper/plugins/
4

Configure Database

Edit the NexAuth configuration file to set up your database connection.
database {
    type=nexauth-mysql
    properties {
        mysql {
            host=localhost
            database=nexauth
            password="your_password"
            port=3306
            user=nexauth
        }
    }
}
5

Restart Server

Restart your Minecraft server to load NexAuth.
# Stop the server, then start it again
NexAuth will automatically create the necessary database tables on first startup.
6

First Run Setup

When you first join the server, you’ll be prompted to set up your account.
  1. Set a secure password with /register <password> <confirm_password>
  2. Login on future joins with /login <password> or /l <password>
  3. Configure additional security features as needed

​
Next Steps

Installation Guides

Platform-specific installation instructions for Velocity and Paper.

Configuration

Configure premium accounts, offline mode, and security features.

Commands Reference

Complete reference for all NexAuth commands.

Developer Docs

Build custom integrations and contribute to NexAuth.

​
Troubleshooting

Check your server logs for error messages. Common issues:
  • Ensure you’re using Java 17+
  • Verify you downloaded the correct version for your platform
  • Check that the JAR file isn’t corrupted
Verify your database settings:
  • Ensure the database server is running
  • Check the host, port, and credentials in config
  • Confirm the database user has proper permissions
  • Test connectivity with mysql -h host -u user -p
Common authentication issues:
  • Verify the plugin is loaded and enabled
  • Check that database tables were created successfully
  • Ensure players are using the correct command syntax
  • Review server logs for authentication errors

​
Need Help?

Community Support

Join our GitHub Discussions for community support and troubleshooting help.