> For the complete documentation index, see [llms.txt](https://amirreza-gholami.gitbook.io/ktor-admin/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://amirreza-gholami.gitbook.io/ktor-admin/start/quick-start-ktoradmin.md).

# Quick Start: KtorAdmin

#### **Getting Started**

Setting up **KtorAdmin** is straightforward and follows the same installation process as any other Ktor plugin. With just a few simple steps, you can integrate an admin panel into your Ktor application effortlessly.

**Step 1: Add Dependency**

First, add KtorAdmin to your `build.gradle.kts`: 

![Maven Central](https://img.shields.io/maven-central/v/io.github.amirroid/KtorAdmin) 

```kotlin
plugins {
    id("com.google.devtools.ksp") version "2.1.0-1.0.29"
}

repositories {
    mavenCentral()
}

dependencies {
    // KtorAdmin library
    implementation("io.github.amirroid:KtorAdmin:lastate_version")
    ksp("io.github.amirroid:KtorAdmin:lastate_version")
}
```

**Step 2: Install KtorAdmin Plugin**

Next, install the **KtorAdmin** plugin in your Ktor application by adding the following code:

```kotlin
fun Application.configureAdmin() {
    install(KtorAdmin)
}
```

**Step 3: Enable KtorAdmin in Your Application Module**

Finally, integrate `configureAdmin()` into your application's main module:

```kotlin
fun Application.module() {
    ...
    configureAdmin()
}
```

Now, you can access the **admin panel** by navigating to:

```
http://localhost:8080/admin
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://amirreza-gholami.gitbook.io/ktor-admin/start/quick-start-ktoradmin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.