# How to Configure Your BeamMP Server (ServerConfig.toml) (/docs/beammp/server-config)



import { File, Folder, Files } from 'fumadocs-ui/components/files';
import { Step, Steps } from 'fumadocs-ui/components/steps';

All BeamMP server settings live in `ServerConfig.toml` (TOML format). Auto-generated on first run.

File Structure [#file-structure]

<Files>
  <Folder name="BeamMP Server" defaultOpen>
    <File name="ServerConfig.toml" />

    <File name="Server.log" />

    <Folder name="Resources" defaultOpen>
      <Folder name="Client">
        <File name="vehicle_mod.zip" />

        <File name="custom_map.zip" />
      </Folder>

      <Folder name="Server">
        <Folder name="MyPlugin">
          <File name="main.lua" />
        </Folder>
      </Folder>
    </Folder>
  </Folder>
</Files>

How to Edit ServerConfig.toml [#how-to-edit-serverconfigtoml]

<Steps>
  <Step>
    Stop the server [#stop-the-server]

    In the [XGamingServer Panel](https://panel.xgamingserver.com), go to **Console** and stop your server.
  </Step>

  <Step>
    Open ServerConfig.toml [#open-serverconfigtoml]

    Click **Files** in the sidebar and open `ServerConfig.toml` in the server root.
  </Step>

  <Step>
    Edit and save [#edit-and-save]

    Make your changes, click **Save Content**, then start the server from **Console**.
  </Step>
</Steps>

***

All Settings [#all-settings]

Under `[General]`:

Server Identity [#server-identity]

| Setting       | Default                         | Max Length | Description                                                                    |
| ------------- | ------------------------------- | :--------: | ------------------------------------------------------------------------------ |
| `Name`        | `"Test Server"`                 |     250    | Server browser display name (supports [color codes](/docs/beammp/color-codes)) |
| `Description` | `"Total Random Beam MP Server"` |    1000    | Description shown in browser                                                   |
| `Tags`        | `"Freeroam"`                    |     100    | Comma-separated filter tags                                                    |
| `Private`     | `true`                          |      —     | `false` = listed in public browser                                             |

Authentication [#authentication]

| Setting       | Default | Description                                                       |
| ------------- | ------- | ----------------------------------------------------------------- |
| `AuthKey`     | `""`    | **Required** — get from [BeamMP Keymaster](/docs/beammp/auth-key) |
| `AllowGuests` | `false` | Allow players without BeamMP accounts                             |

Players & Vehicles [#players--vehicles]

| Setting      | Default | Description             |
| ------------ | ------- | ----------------------- |
| `MaxPlayers` | `10`    | Max concurrent players  |
| `MaxCars`    | `2`     | Max vehicles per player |

Map [#map]

| Setting | Default                          | Description                                               |
| ------- | -------------------------------- | --------------------------------------------------------- |
| `Map`   | `"/levels/gridmap_v2/info.json"` | Active map path — see [Map Guide](/docs/beammp/map-guide) |

Network [#network]

| Setting | Default | Description                            |
| ------- | ------- | -------------------------------------- |
| `Port`  | `30814` | Listening port (1024–65535, TCP + UDP) |
| `IP`    | `"::"`  | Bind IP address                        |

Other [#other]

| Setting          | Default       | Description                     |
| ---------------- | ------------- | ------------------------------- |
| `LogChat`        | `false`       | Log chat messages to Server.log |
| `Debug`          | `false`       | Enable debug logging            |
| `ResourceFolder` | `"Resources"` | Path to mod directory           |

Environment Variable Overrides (v3.2.0+) [#environment-variable-overrides-v320]

Settings can be overridden via env vars using the `BEAMMP_` prefix:

| Env Var              | Overrides    |
| -------------------- | ------------ |
| `BEAMMP_AUTH_KEY`    | `AuthKey`    |
| `BEAMMP_MAX_PLAYERS` | `MaxPlayers` |
| `BEAMMP_MAP`         | `Map`        |
| `BEAMMP_PORT`        | `Port`       |
| `BEAMMP_NAME`        | `Name`       |

Example Config [#example-config]

```toml
[General]
AuthKey = "your-key-here"
Name = "^4XGaming ^fBeamMP Server"
Description = "Freeroam with mods! All welcome."
Tags = "Freeroam,Modded,Lang:English"
Map = "/levels/west_coast_usa/info.json"
MaxPlayers = 20
MaxCars = 2
Port = 30814
Private = false
AllowGuests = false
LogChat = true
Debug = false
ResourceFolder = "Resources"
```

Related Guides [#related-guides]

* [Get an Auth Key](/docs/beammp/auth-key)
* [Change the Map](/docs/beammp/map-guide)
* [Install Mods](/docs/beammp/mod-setup)
* [Color Codes](/docs/beammp/color-codes)