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

# Introduction

> The three parts of Kuro and what you need to install it.

Kuro is an open source panel to host game servers on your own machines. It has three parts:

* **the API**: the decision center. It holds accounts, permissions, nodes, servers and the
  audit log, and serves the panel;
* **the daemon**: installed on every machine that runs servers (a **node**), it drives Docker,
  enforces limits and reports state, stats and the console;
* **the panel**: the web admin interface, served by the API.

## Requirements

| For | You need |
| - | - |
| The API and panel | A Linux machine (x86\_64 or arm64) with systemd, a domain name or public IP, a TLS reverse proxy (Caddy recommended). PostgreSQL: your own, or a local container installed by the script (Docker required). |
| A node | A Linux machine (x86\_64 or arm64) with systemd and Docker. It can be the same machine as the API. |
| Players | Reach the node's game ports (port forwarding if the node is behind a home router). |

## Where to start

1. [Install the API and panel](https://docs.kuroctl.com/en/install-api.md).
2. Create the first admin account.
3. [Add a node](https://docs.kuroctl.com/en/add-a-node.md).
4. Deploy a first server from the panel: **Servers › New server**.

> [!NOTE]
>
> Without a domain or any extra setup, players join a server with `IP:port`. [DNS](https://docs.kuroctl.com/en/dns.md)
> and [AI agents](https://docs.kuroctl.com/en/mcp.md) are optional.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.