# Dashboard

URL: https://zerodev.ca/docs/kora/dashboard

> Sign in, find your way around, set up roles and invite your staff.



The dashboard is part of Kora and runs on port `3000`. There is nothing extra to install or build.

## Signing In

Open the dashboard and click **Continue with Discord**. Kora checks the Discord account against its records:

| Account                           | What happens                                                                         |
| --------------------------------- | ------------------------------------------------------------------------------------ |
| The license owner                 | Signs in with full access.                                                           |
| A member under **Team > Members** | Signs in with the permissions of their role.                                         |
| A customer with that Discord ID   | Signs in to the [Client Dashboard](/docs/kora/client-dashboard), if it is turned on. |
| Anyone else                       | Turned away.                                                                         |

Discord sign-in is set up by the [setup wizard](/docs/kora/setup#discord-application). To change the client ID or secret later, go to **Settings > Discord Sign In**.

## Pages

| Group     | Page            | What it is for                                                                                                         |
| --------- | --------------- | ---------------------------------------------------------------------------------------------------------------------- |
|           | Overview        | Active licenses, keys expiring within 7 days, flagged leaks and a 30-day chart of new licenses.                        |
| Licensing | Licenses        | Every key, its product, policy, customer, addons, seats, status and expiry.                                            |
|           | Products        | What you sell, its price, how long licenses last and which whitelists it uses.                                         |
|           | Addons          | Extras sold on top of a product.                                                                                       |
|           | Policies        | Named variants of a product, such as "Pro", and the type, max machines, duration and addons their licenses start with. |
|           | Customers       | Everyone who owns a key.                                                                                               |
|           | Whitelists      | IP, header and body groups that limit where a key can be used.                                                         |
|           | Validation Logs | Every validation request and its result.                                                                               |
|           | Integration     | Code samples and a test tool for checking keys from your product.                                                      |
| Team      | Members         | Everyone who can sign in to the dashboard.                                                                             |
|           | Roles           | Sets of permissions you give to members.                                                                               |
|           | Audit Log       | Every change made in the dashboard, by API tokens and by Kora itself.                                                  |
| System    | Settings        | Language, appearance, server URLs, sign-in and updates.                                                                |
|           | Modules         | Turn modules on and off.                                                                                               |
|           | Configs         | Settings for each module.                                                                                              |
|           | Lang            | Edit any text a module shows.                                                                                          |
|           | Logs            | The live console.                                                                                                      |
|           | API Tokens      | Tokens for the management API.                                                                                         |

Modules add their own pages. BuiltByBit adds **Resources** and **Purchases**. Press `Ctrl K` or `⌘K` to search licenses, products, customers and members from anywhere.

## Your First License

1. Under **Products**, click **Create** and enter a name, version, price and duration. A duration of `0` means lifetime.
2. Under **Customers**, add the buyer. Add their Discord ID if they should use the client dashboard.
3. Under **Licenses**, click **Create**, pick the product and customer, and save. Kora generates the key.

Check it from your product with the [validation API](/docs/kora/extensions/core/api-reference).

## Roles

Kora creates these roles the first time it starts:

| Role          | Access                                                                     |
| ------------- | -------------------------------------------------------------------------- |
| License Owner | Everything. Given to the owner of your Kora license and cannot be deleted. |
| Administrator | Everything.                                                                |
| Manager       | Licenses, products, customers and whitelists.                              |
| Support       | View and edit licenses and customers, view products and whitelists.        |
| Viewer        | View licenses, products, customers and whitelists.                         |

Edit them or make your own under **Roles**. Permissions come in groups such as `licenses.view`, `licenses.create`, `licenses.edit` and `licenses.delete`. Modules add their own.

To add staff, go to **Members**, click **Create** and enter their name, Discord ID and role. To find a Discord ID, turn on **Developer Mode** in Discord under **Settings > Advanced**, then right-click the user and click **Copy User ID**.

The license owner cannot be disabled or removed.

## Appearance

Everything under **Settings** applies to everyone who signs in and saves without a restart.

| Section                 | What you can change                                                                   |
| ----------------------- | ------------------------------------------------------------------------------------- |
| Appearance              | Light, dark or system mode and the accent colour.                                     |
| Dashboard Customization | Sidebar position, background image or video, tint, blur, glass panels and custom CSS. |
| Branding                | Dashboard name and a custom icon.                                                     |
| Login Screen            | Which side the sign-in form sits on and the background behind it.                     |
| Language                | The dashboard language and a second language to fall back to.                         |

## Updates

**Settings > Updates** shows your version and the newest one. Click **Check for Updates**, then **Update** to install it. Turn on **Automatic Updates** to install new versions when Kora restarts.

## Moving Settings

**Settings > Transfer Options** exports your settings to a file and imports them on another install. You pick the categories: modules, branding, general, server URLs and sign-in. Sign-in credentials are marked as sensitive.
