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

# Getting Started

> How to install and set up the R5R Tracker plugin for your server.

# Installation

To enable tracking and advanced features on your R5Reloaded server, you need to install the Tracker plugin.

1. **Download**: Get the latest files from [r5r.dev/download](https://r5r.dev/download).
2. **Install**: Extract and place all files into your game's root directory.

## Initial Setup

<Info>
  Verification is not required to run the tracker plugin. Unverified hosts still post matches publicly, but those matches are not aggregated or recorded globally.
</Info>

To enable global aggregation and full control panel features, verify your account and generate an API key.

1. **Verify Account** (recommended): Submit a host verification request at [r5r.dev/account](https://r5r.dev/account?tab=requests#host-verification).
2. **Generate Key**: Once verified, log in to the [Host Control Panel](https://r5r.dev/cp) and navigate to the **Settings** tab to generate your Host API Key.
3. **Setup a Server**: Proceed to configure at least one server in [Servers tab](https://r5r.dev/cp/?tab=servers)
4. **Configure**: Configure settings in the control panel and download the file directly from [r5r.dev/cp/?tab=config](https://r5r.dev/cp/?tab=config).

<Note>
  Your API key is automatically updated in your config after generated. If you change your API key, you will have to manually place the r5rdev\_config.json file into `/platform/` folder.
</Note>

## SSL Certificates

If you are using `tracker_ws_lax_ssl` set to `0` (Strict SSL), you must ensure the certificate bundle is present.

* **File**: `Sectigobundle.pem`
* **Location**: `platform/` folder.
* **Download**: If missing, download from [r5r.dev/cp/certs/Sectigobundle.pem](https://r5r.dev/cp/certs/Sectigobundle.pem).

<Info>
  Sectigobundle.pem is already included in the correct directory hierarchy `/platform/Sectigobundle.pem` within the prepackaged release found at [r5r.dev/download](https://r5r.dev/download)
</Info>

## Script configuration

<Note>
  If you downloaded the pre-compiled release from GitHub, you can skip this.
</Note>

Majority of tracker services are shipped by default with the core R5Reloaded game. However, these scripts are not enabled by default.
The tracker scripts are not compiled unless the compile-time guard constants `TRACKER` and `HAS_TRACKER_DLL` are set to `true` in: `\platform\scripts\vscripts\sh_consts.gnut`.
If you downloaded the pre-compiled release from GitHub, these are already toggled for you. In the event that you want to disable tracker at a script level, you can keep `HAS_TRACKER_DLL` set to true,
and set `TRACKER` to false. This can be especially usful for users who only want to use a subset feature, such as the Host Control Panel.

<Warning>
  If `TRACKER` is set to false, the scripts will behave like stock R5Reloaded, but still possess internal engine tracker code. Internal tracker code calls script functions for various aspects, and those functions will not exist, so expect some functionality to not work, such as updating admins/whitelists in realtime. The engine has checks in place to ensure no crashes will happen in the event of this setup.
</Warning>

## Next Steps

Once installed, proceed to [Configuration](/hosting/configuration) to set up your ConVars and options.