> For the complete documentation index, see [llms.txt](https://impoo.gitbook.io/authenticationsystem/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://impoo.gitbook.io/authenticationsystem/installation.md).

# Installation

Follow these steps to install AuthSystem on your Paper server.

## Requirements

Before installing, make sure you have:

* A running **Paper 1.21.8** server
* **Java 21** installed
* A **MySQL or MariaDB** database (with a database and user created for AuthSystem)

## Step 1: Download the plugin

Download the latest `AuthSystem.jar` from the Modrinth page or your preferred source, and place it in your server's `plugins/` folder.

## Step 2: Start the server to generate config

Start your server once. AuthSystem will generate a default `config.yml` in the `plugins/AuthSystem/` folder. Then stop the server.

## Step 3: Configure the database

Open `plugins/AuthSystem/config.yml` and edit the database section:

```yaml
database:
  host: "localhost"
  port: 3306
  username: "authsystem"
  password: "your_secure_password"
  name: "authsystem_db"
  ssl: false
```

Replace the values with your database connection details.

## Step 4: Restart the server

Start your server again. AuthSystem will connect to the database and create the `auth_players` table automatically.

## Step 5: Verify installation

Join the server and run:

```
/auth reload
```

If you receive a success message, AuthSystem is installed and working.

***

## Verification checklist

* [ ] `AuthSystem.jar` is in `plugins/`
* [ ] `plugins/AuthSystem/config.yml` exists with your database details
* [ ] The `auth_players` table was created in your database
* [ ] `/auth reload` returns a success message
* [ ] New players are prompted to register on first join

***

> :bulb: **Tip**: If the plugin fails to connect to the database, check your firewall settings and make sure your MySQL/MariaDB server allows connections from your Minecraft server's IP address.