> ## Documentation Index
> Fetch the complete documentation index at: https://help.freakhosting.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Enable and Manage a Whitelist

> > Keep your server private - This guide shows you how to enable a whitelist on your Hytale server, add or remove players, and maintain complete control over ...

## Control Server Access & Restrict Who Can Join

<CardGroup cols={2}>
  <Card title="Difficulty" icon="gauge-low">
    Beginner
  </Card>

  <Card title="Time" icon="clock">
    5 Minutes
  </Card>
</CardGroup>

***

> **Keep your server private** - This guide shows you how to enable a whitelist on your Hytale server, add or remove players, and maintain complete control over who can join.

| Reading Time | Difficulty | Last Updated |
| :----------: | :--------: | :----------: |
|   5 minutes  |  Beginner  | January 2026 |

***

## Quick Navigation

| Section                                     | What You'll Learn      |
| :------------------------------------------ | :--------------------- |
| [What is a Whitelist](#what-is-a-whitelist) | Overview and benefits  |
| [Enable Whitelist](#enable-the-whitelist)   | Turn on access control |
| [Manage Players](#manage-whitelist-players) | Add and remove players |
| [Command Reference](#command-reference)     | All whitelist commands |

***

## What is a Whitelist?

A whitelist restricts server access to **only approved players**. When enabled:

| Access Level             | Can Join? |
| :----------------------- | :-------: |
| Players on the whitelist |    Yes    |
| Server admins/operators  |    Yes    |
| Everyone else            |     No    |

### When to Use a Whitelist

| Use Case         | Description                               |
| :--------------- | :---------------------------------------- |
| Private Server   | Limit access to friends and family only   |
| Community Server | Pre-approve members before they can join  |
| Event Server     | Restrict access during special events     |
| Development      | Keep testing servers closed to the public |

***

## Enable the Whitelist

Whitelisting can be toggled using commands - **no server restart required**.

### Via Control Panel Console

| Step | Action                                       |
| :--: | :------------------------------------------- |
|   1  | Log in to your **Game Server Control Panel** |
|   2  | Navigate to the **Console** tab              |
|   3  | Enter the command: `whitelist on`            |

### Via In-Game (Admin Required)

If you have admin or operator permissions, run the command directly in chat:

```
whitelist on
```

> \[!IMPORTANT]
> Once enabled, only players on the whitelist and admins will be able to join. All other connection attempts will be rejected.

***

## Disable the Whitelist

To make your server public again:

```
whitelist off
```

This immediately allows all players to join without restriction.

***

## Manage Whitelist Players

After enabling the whitelist, you can add or remove players at any time.

### Add a Player

```
whitelist add <playername>
```

**Example:**

```
whitelist add Steve
```

### Remove a Player

```
whitelist remove <playername>
```

**Example:**

```
whitelist remove Steve
```

<Note>
  > Changes apply **immediately**. Players gain or lose access as soon as the command is executed.
</Note>

<Tip>
  ### Save on Your Hosting

  Ready to get a new server? Use code **KB20** at checkout for **20% off** your first month!
</Tip>

***

## Command Reference

| Command                     | Description              |
| :-------------------------- | :----------------------- |
| `whitelist on`              | Enable the whitelist     |
| `whitelist off`             | Disable the whitelist    |
| `whitelist add <player>`    | Grant a player access    |
| `whitelist remove <player>` | Revoke a player's access |

***

## Whitelist File Location

The whitelist is stored in a JSON file on your server:

| File             | Location              |
| :--------------- | :-------------------- |
| `whitelist.json` | Server root directory |

### Manual Editing (Advanced)

You can also edit `whitelist.json` directly via FTP or the file manager:

```json theme={null}
[
  {
    "name": "PlayerOne"
  },
  {
    "name": "PlayerTwo"
  }
]
```

> \[!CAUTION]
> If editing the file manually, **stop the server first** to prevent conflicts. Restart the server after saving changes.

***

## Troubleshooting

### Player Cannot Join Despite Being Whitelisted

| Issue                 | Solution                            |
| :-------------------- | :---------------------------------- |
| Name misspelled       | Check exact spelling in add command |
| Whitelist not enabled | Run `whitelist on`                  |
| Player not on list    | Run `whitelist add <name>` again    |

### Admin Locked Out

Admins and operators can always join, even if not explicitly on the whitelist. If you're locked out:

1. Access the server console via control panel
2. Run `whitelist off` or add yourself with `whitelist add <yourname>`

***

## Additional Resources

| Resource                | Link                                              |
| :---------------------- | :------------------------------------------------ |
| Official Hytale Website | [hytale.com](https://hytale.com/)                 |
| Hytale Support Portal   | [support.hytale.com](https://support.hytale.com/) |

<Note>
  ### Need Extra Help?

  If you encounter any issues, our support team is ready to assist:

  * **Live Chat:** Quick assistance via our website.
  * **Support Ticket:** [Open a Ticket](https://freakhosting.com/clientarea/submitticket.php)
  * **Discord:** [Join our Community](https://discord.gg/freakhosting)
  * **Email:** [support@freakhosting.com](mailto:support@freakhosting.com)
</Note>

<Tip>
  ### Save on Your Hosting

  Ready to get a new server? Use code **KB20** at checkout for **20% off** your first month!
</Tip>

***

<div align="center">
  **Last Updated:** January 2026 | **Need Help?** Contact our 24/7 support team!
</div>