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

# LeaderOS Connect

> Connect your Rust server to LeaderOS, enabling you to execute commands on your server directly from the website.

## Download

[https://www.leaderos.net/plugin/rust](https://www.leaderos.net/plugin/rust)

## Source Code

[https://github.com/leaderos-net/rust-leaderos-connect](https://github.com/leaderos-net/rust-leaderos-connect)

## Installation

1. [Download](https://www.leaderos.net/plugin/rust) the `LeaderosConnect.cs` file.
2. Upload the `LeaderosConnect.cs` file to the `plugins` folder in your server directory.
3. Restart your Rust server to initialize the plugin.
4. Configure the plugin by editing the `LeaderosConnect.json` file located in the `/config` directory.
   * **Website Url**: The URL of your LeaderOS website (e.g., `https://yourwebsite.com`).
   * **Api Key**: Your LeaderOS API key. You can find this under `Dashboard > Settings > API`.
   * **Server Token**: Your server token. You can find this under `Dashboard > Store > Servers > Your Server > Server Token`.
   * **Debug Mode**: Set to `true` to enable debug logs, or `false` to disable them.
   * **Check Player Online**: Set to `true` to verify if players are online before sending commands, or `false` to skip this check.
5. Restart your Rust server again to apply the configuration changes.

## Admin Commands

* `/leaderos.status` - Displays the current LeaderOS connection status.
* `/leaderos.reconnect` - Reconnects to the LeaderOS socket server.
* `/leaderos.debug` - Toggles debug mode on or off.