# Server overview

See whether your city is online, how many players are in, the fivedash resource connection and your organization's servers.

Source: https://fivedash.fivex.gg/docs/en/server/overview

The **Overview** of the **Server** module is the first screen of every server in FiveDash. In one place it shows whether the city is up, how many residents are in right now, how the connection with the `fivedash` resource is doing, and the organization's other servers. It's for owners and staff who want to know at a glance that everything is running.

## Before you start

* **Where it is:** **Server → Overview**, at `/<org>/<server>` (the server's home page in the panel).
* **Access level:** the **Server** area only has the **View** level. Anyone with access to it sees the status, the players and the server list.
* **Game connection:** the **Game connection** card only shows for the organization's **Owner** or **Admin**. Other members don't see or touch the key.
* **Status and players:** for the numbers to show up, the server needs the `fivedash` resource connected or a saved public address (a `cfx.re/join` link or `IP:port`).

## What the page shows

### Server header

| Item             | What it shows                                                                                        |
| ---------------- | ---------------------------------------------------------------------------------------------------- |
| Name and icon    | The server's name and icon in FiveDash                                                               |
| Address          | The `cfx.re/join/<code>` link or the saved `IP:port`. Without either, it shows **No public address** |
| **Copy address** | Copies the address (you see **Address copied**)                                                      |
| Status           | **Online** (green) or **No response** (gray)                                                         |
| **Join**         | Opens `https://cfx.re/join/<code>`. Only shows when the server has a `cfx.re/join` code              |

### Players

| Item               | What it shows                                                                                                                          |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Players online** | Players right now and the maximum (**of 64**, for example). With the server down, it shows **Offline**                                 |
| **Capacity**       | The share of slots taken and a meter. The meter turns amber from 90%. With no response, it shows **Shows up when the server responds** |

### Game connection

The **Game connection** card (**Owner** and **Admin** only) sums up the `fivedash` resource installed in the city.

| Field                      | What it shows                                                                                                                                                                  |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status badge               | **Connected**, **Disconnected** (the resource connected before but stopped syncing) or **Waiting for the server** (the key exists but the resource never connected)            |
| **Framework**              | The framework the resource detected (e.g. **QBCore**, **ESX**, **Creative Network Enchanted**). **None detected** when it recognized none                                      |
| **Whitelist via FiveDash** | **Active** (the bot grants and removes whitelist right in the game), **Unavailable** (the framework has store support, but its whitelist isn't ready) or **Not supported yet** |
| **Last sync**              | How long ago the resource talked to the panel (**just now**, **3 minutes ago**…) or **Never**                                                                                  |
| **Resource**               | The resource version (e.g. `v0.6.0`) and the key's last 4 characters (e.g. `…a1b2`)                                                                                            |

Below the card you may see:

* **New version notice:** "Version X of the resource is available: the server downloads it on its own and it takes effect on the city's next restart (or with `restart fivedash` in the console). config.lua stays as it is."
* **Framework warnings**, in amber: setup problems the resource found in the city (for example, the base's whitelist turned off). They only show while the resource is connected. See the list in [Frameworks](https://fivedash.fivex.gg/docs/en/developers/frameworks).

Card buttons:

| Button               | What it does                                                                                                                    |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| **Connect server**   | Opens **Connect the server**, with the steps to generate the key and install the resource                                       |
| **Generate new key** | Creates another key. The previous one stops working right away                                                                  |
| **Disconnect**       | Asks for confirmation (**Disconnect the server?**). The current key stops working and whitelist unlocks go back to Discord only |

### Organization servers

The **Organization servers** table lists every server, with the count (**3 servers**, for example).

| Column      | What it shows                                                                             |
| ----------- | ----------------------------------------------------------------------------------------- |
| **Server**  | Name, icon and address. The server open right now has the **Open** tag                    |
| **Players** | Players now and the maximum (e.g. `48/64`), with a small bar. `—` when it doesn't respond |
| **Status**  | **Online** or **No response**                                                             |

Click a row to open that server.

### Right column

* **Organization:** the organization's name, the number of **Servers** (with **· 2 online**, for example), the **Team** (faces and total) and the **Pending invites** (or **None**).
* **Modules:** shortcuts to the modules in your plan, each with its state: **Bot set up** / **Set up the bot**, **Store set up** / **Set up the store**, **Website set up** / **Set up the website**, **1 log** / **5 logs** / **Set up logs** and, for the CDN, **Your city's files**. Only modules you can open show up.

## Where the status and players come from

The panel tries two sources, in this order:

1. **The `fivedash` resource:** every sync sends the player count and the maximum (`sv_maxclients`). If the last sync was less than about 75 seconds ago, the panel uses those numbers and shows **Online**.
2. **The public address:** without a recent sync, the panel looks up the address saved on the server (the `cfx.re/join` code through the public Cfx.re list, or the `IP:port` directly on the game server).

With neither, or if the lookup fails, the status is **No response** and players show **Offline**.

> With the resource connected, the numbers arrive even if the city is off the public list or behind a proxy. That's why it's worth keeping `fivedash` installed.

## Save the server's address

The address is used for the status, the players, the **Join** button and Discord's **Connect**. It's optional.

### Open the server manager

In the sidebar's server picker, click **Manage servers** and pick the server.

### Paste the address

Under **Connection**, fill **Address (optional)** with the city's `cfx.re/join/<code>` link or `IP:port`.

### Check it

Click **Check address**. If the city responds, you see **Found · 48/64 players now** (with the current numbers).

### Save

Click **Save changes**.

> Only **Owner** and **Admin** manage servers. Others see "Only owners and admins can manage servers."

## Connect the server to the game

Until the resource connects for the first time, the server's module pages show the **Connect** + server name screen (for example, **Connect Example City**, with "One step before setting up the modules"). The full walkthrough is in [Install the resource](https://fivedash.fivex.gg/docs/en/getting-started/install-resource). In short:

### Generate the key

On the **Game connection** card, click **Connect server**, then **Generate key**. The key starts with `fdk_` and is shown only once.

### Download the resource

Click **Download fivedash.zip**. Its `config.lua` already has this server's key.

### Install it in the city

Extract the `fivedash` folder into `resources` and add `ensure fivedash` to `server.cfg`, after the framework.

### Restart

Restart the server, or type `refresh` and `ensure fivedash` in the console. Once the resource connects, the screen shows **Connected** and the framework's name.

> The key gives access to the server on FiveDash. Don't share `config.lua` or paste the key in chats, screenshots or tickets.

## FAQ

**The city is open, but the panel shows No response. Why?**
The resource hasn't synced in the last 75 seconds and the saved address didn't respond (or there's no address). Run the `fivedash` command in the server console to check the resource is **connected**, and save an address in **Manage servers**.

**The player count differs from the FiveM server list.**
With the resource connected, the panel uses the server's own count, which is fresher than the public list. The difference usually goes away within seconds.

**I don't see the Game connection card.**
It only shows for the organization's **Owner** and **Admin**.

**What happens if I click Generate new key?**
The old key stops working right away. The server stays disconnected until you put the new one in `fivedash/config.lua` and restart the resource.

## Next steps

[Install the resource](https://fivedash.fivex.gg/docs/en/getting-started/install-resource)Download fivedash and connect the city to the panel.
[Console and players](https://fivedash.fivex.gg/docs/en/server/console-and-players)What already exists and what's coming in the Server module.
[Organizations and servers](https://fivedash.fivex.gg/docs/en/dashboard/organizations-and-servers)Add, rename and remove servers.
[FiveM resource](https://fivedash.fivex.gg/docs/en/developers/fivem-resource)How the resource works, options and convars.
