Repository navigation
Expand file tree
/
Copy pathdev.html
More file actions
55 lines (51 loc) · 20.8 KB
/
Copy pathdev.html
File metadata and controls
55 lines (51 loc) · 20.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<!doctype html>
<html lang="en-US">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="generator" content="VuePress 2.0.0-rc.31" />
<style>
:root {
--vp-c-bg: #fff;
}
[data-theme='dark'] {
--vp-c-bg: #1b1b1f;
}
html,
body {
background-color: var(--vp-c-bg);
}
</style>
<script>
const useChoice = localStorage.getItem('vuepress-color-scheme')
const systemStatus =
'matchMedia' in window
? window.matchMedia('(prefers-color-scheme: dark)').matches
: false
if (useChoice === 'light') {
document.documentElement.dataset.theme = 'light'
} else if (useChoice === 'dark' || systemStatus) {
document.documentElement.dataset.theme = 'dark'
}
</script>
<title>Development Environment | AKHQ</title><meta name="description" content="Get all the insight of your Apache Kafka clusters, see topics, browse data inside topics, see consumer groups and their lag, manage your schema registry, see and manage your Kafka Connect cluster status, and more...">
<link rel="preload" href="/assets/style-cdNf-OCz.css" as="style"><link rel="stylesheet" href="/assets/style-cdNf-OCz.css">
<link rel="modulepreload" href="/assets/app-CJcco6Ta.js"><link rel="modulepreload" href="/assets/dev-BuUxRRQE.js">
</head>
<body>
<div id="app"><!--[--><div class="vp-theme-container" vp-container><!--[--><header class="vp-navbar" vp-navbar><div class="vp-toggle-sidebar-button" title="toggle sidebar" aria-expanded="false" role="button" tabindex="0"><div class="icon" aria-hidden="true"><span></span><span></span><span></span></div></div><span><a class="route-link" href="/"><!----><span class="vp-site-name vp-hide-mobile" aria-hidden="true">AKHQ</span></a></span><div class="vp-navbar-items-wrapper" style=""><!--[--><!--]--><nav class="vp-navbar-items vp-hide-mobile" aria-label="site navigation"><!--[--><div class="vp-navbar-item"><a class="route-link route-link-active auto-link" href="/docs/" aria-label="Documentation"><!--[--><!--[--><!--]--><!--]-->Documentation<!--[--><!--[--><!--]--><!--]--></a></div><div class="vp-navbar-item"><a class="auto-link external-link" href="https://github.com/tchiotludo/akhq" aria-label="GitHub" rel="noopener noreferrer" target="_blank"><!--[--><!--[--><!--]--><!--]-->GitHub<!--[--><!--[--><!--]--><!--]--></a></div><!--]--></nav><!--[--><!--]--><button type="button" class="vp-toggle-color-mode-button" title="toggle color mode"><svg class="light-icon" viewbox="0 0 32 32" style=""><path d="M16 12.005a4 4 0 1 1-4 4a4.005 4.005 0 0 1 4-4m0-2a6 6 0 1 0 6 6a6 6 0 0 0-6-6z" fill="currentColor"></path><path d="M5.394 6.813l1.414-1.415l3.506 3.506L8.9 10.318z" fill="currentColor"></path><path d="M2 15.005h5v2H2z" fill="currentColor"></path><path d="M5.394 25.197L8.9 21.691l1.414 1.415l-3.506 3.505z" fill="currentColor"></path><path d="M15 25.005h2v5h-2z" fill="currentColor"></path><path d="M21.687 23.106l1.414-1.415l3.506 3.506l-1.414 1.414z" fill="currentColor"></path><path d="M25 15.005h5v2h-5z" fill="currentColor"></path><path d="M21.687 8.904l3.506-3.506l1.414 1.415l-3.506 3.505z" fill="currentColor"></path><path d="M15 2.005h2v5h-2z" fill="currentColor"></path></svg><svg class="dark-icon" viewbox="0 0 32 32" style="display:none;"><path d="M13.502 5.414a15.075 15.075 0 0 0 11.594 18.194a11.113 11.113 0 0 1-7.975 3.39c-.138 0-.278.005-.418 0a11.094 11.094 0 0 1-3.2-21.584M14.98 3a1.002 1.002 0 0 0-.175.016a13.096 13.096 0 0 0 1.825 25.981c.164.006.328 0 .49 0a13.072 13.072 0 0 0 10.703-5.555a1.01 1.01 0 0 0-.783-1.565A13.08 13.08 0 0 1 15.89 4.38A1.015 1.015 0 0 0 14.98 3z" fill="currentColor"></path></svg></button><form class="search-box" role="search"><input type="search" placeholder="Search" autocomplete="off" spellcheck="false" value><!----></form></div></header><!--]--><div class="vp-sidebar-mask"></div><!--[--><aside class="vp-sidebar" vp-sidebar><nav class="vp-navbar-items" aria-label="site navigation"><!--[--><div class="vp-navbar-item"><a class="route-link route-link-active auto-link" href="/docs/" aria-label="Documentation"><!--[--><!--[--><!--]--><!--]-->Documentation<!--[--><!--[--><!--]--><!--]--></a></div><div class="vp-navbar-item"><a class="auto-link external-link" href="https://github.com/tchiotludo/akhq" aria-label="GitHub" rel="noopener noreferrer" target="_blank"><!--[--><!--[--><!--]--><!--]-->GitHub<!--[--><!--[--><!--]--><!--]--></a></div><!--]--></nav><!--[--><!--]--><ul class="vp-sidebar-items"><!--[--><li><a class="route-link route-link-active auto-link vp-sidebar-item vp-sidebar-heading" href="/docs/" aria-label="Quick preview"><!--[--><!--[--><!--]--><!--]-->Quick preview<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item vp-sidebar-heading" href="/docs/installation.html" aria-label="Installation"><!--[--><!--[--><!--]--><!--]-->Installation<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item vp-sidebar-heading" href="/docs/configuration/" aria-label="Configurations"><!--[--><!--[--><!--]--><!--]-->Configurations<!--[--><!--[--><!--]--><!--]--></a><ul class="vp-sidebar-children" style=""><!--[--><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/brokers.html" aria-label="Cluster configuration"><!--[--><!--[--><!--]--><!--]-->Cluster configuration<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><p tabindex="0" class="vp-sidebar-item">Schema Registry <!----></p><ul class="vp-sidebar-children" style=""><!--[--><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/schema-registry/tibco.html" aria-label="TIBCO schema registry"><!--[--><!--[--><!--]--><!--]-->TIBCO schema registry<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/schema-registry/glue.html" aria-label="Glue schema registry"><!--[--><!--[--><!--]--><!--]-->Glue schema registry<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/schema-registry/schema-references.html" aria-label="Schema references"><!--[--><!--[--><!--]--><!--]-->Schema references<!--[--><!--[--><!--]--><!--]--></a><!----></li><!--]--></ul></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/" aria-label="Authentifications"><!--[--><!--[--><!--]--><!--]-->Authentifications<!--[--><!--[--><!--]--><!--]--></a><ul class="vp-sidebar-children" style=""><!--[--><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/groups.html" aria-label="Groups"><!--[--><!--[--><!--]--><!--]-->Groups<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/jwt.html" aria-label="JWT"><!--[--><!--[--><!--]--><!--]-->JWT<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/basic-auth.html" aria-label="Basic Auth"><!--[--><!--[--><!--]--><!--]-->Basic Auth<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/aws-iam-auth.html" aria-label="AWS MSK IAM Auth"><!--[--><!--[--><!--]--><!--]-->AWS MSK IAM Auth<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/oidc.html" aria-label="OIDC"><!--[--><!--[--><!--]--><!--]-->OIDC<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/github.html" aria-label="GitHub SSO / OAuth2"><!--[--><!--[--><!--]--><!--]-->GitHub SSO / OAuth2<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/ldap.html" aria-label="LDAP"><!--[--><!--[--><!--]--><!--]-->LDAP<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/header.html" aria-label="Header configuration (reverse proxy)"><!--[--><!--[--><!--]--><!--]-->Header configuration (reverse proxy)<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/authentifications/external.html" aria-label="External roles and attributes mapping"><!--[--><!--[--><!--]--><!--]-->External roles and attributes mapping<!--[--><!--[--><!--]--><!--]--></a><!----></li><!--]--></ul></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/docker.html" aria-label="Docker"><!--[--><!--[--><!--]--><!--]-->Docker<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/helm.html" aria-label="Helm"><!--[--><!--[--><!--]--><!--]-->Helm<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/akhq.html" aria-label="AKHQ configuration"><!--[--><!--[--><!--]--><!--]-->AKHQ configuration<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/avro.html" aria-label="Avro deserialization"><!--[--><!--[--><!--]--><!--]-->Avro deserialization<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/protobuf.html" aria-label="Protobuf deserialization"><!--[--><!--[--><!--]--><!--]-->Protobuf deserialization<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item" href="/docs/configuration/others.html" aria-label="Others"><!--[--><!--[--><!--]--><!--]-->Others<!--[--><!--[--><!--]--><!--]--></a><!----></li><!--]--></ul></li><li><a class="route-link auto-link vp-sidebar-item vp-sidebar-heading" href="/docs/debug.html" aria-label="Debug & Monitoring"><!--[--><!--[--><!--]--><!--]-->Debug & Monitoring<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link auto-link vp-sidebar-item vp-sidebar-heading" href="/docs/api.html" aria-label="Api"><!--[--><!--[--><!--]--><!--]-->Api<!--[--><!--[--><!--]--><!--]--></a><!----></li><li><a class="route-link route-link-active auto-link vp-sidebar-item vp-sidebar-heading active" href="/docs/dev.html" aria-label="Development Environment"><!--[--><!--[--><!--]--><!--]-->Development Environment<!--[--><!--[--><!--]--><!--]--></a><!----></li><!--]--></ul><!--[--><!--]--></aside><!--]--><!--[--><main class="vp-page"><!--[--><!--]--><div vp-content><!--[--><!--]--><div id="content"><h1 id="development-environment" tabindex="-1"><a class="header-anchor" href="#development-environment"><span>Development Environment</span></a></h1><h2 id="early-dev-image" tabindex="-1"><a class="header-anchor" href="#early-dev-image"><span>Early dev image</span></a></h2><p>You can have access to last feature / bug fix with docker dev image automatically build on tag <code>dev</code></p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token function">docker</span> pull tchiotludo/akhq:dev</span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>The dev jar is not publish on GitHub, you have 2 solutions to have the <code>dev</code> jar :</p><p>Get it from docker image</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token function">docker</span> pull tchiotludo/akhq:dev</span>
<span class="line"><span class="token function">docker</span> run <span class="token parameter variable">--rm</span> <span class="token parameter variable">--name</span><span class="token operator">=</span>akhq <span class="token parameter variable">-v</span> /tmp/akhq/application-dev.yml:/app/application.yml <span class="token parameter variable">-it</span> tchiotludo/akhq:dev</span>
<span class="line"><span class="token function">docker</span> <span class="token function">cp</span> akhq:/app/akhq.jar <span class="token builtin class-name">.</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Or build it with a <code>./gradlew shadowJar</code>, the jar will be located here <code>build/libs/akhq-*.jar</code></p><h2 id="development-server" tabindex="-1"><a class="header-anchor" href="#development-server"><span>Development Server</span></a></h2><p>A docker-compose is provided to start a development environment. Just install docker & docker compose plugin, clone the repository and issue a simple <code>docker compose -f docker-compose-dev.yml up</code> to start a dev server. Dev server is a java server & webpack-dev-server with live reload.</p><p>The configuration for the dev server is in <code>application.dev.yml</code>.</p><p>Once it started, you can visit http://localhost:4000, additionally it is possible to run <code>npm start</code> inside the client-folder which contains hot reload.</p><h2 id="setup-local-dev-environment-on-windows" tabindex="-1"><a class="header-anchor" href="#setup-local-dev-environment-on-windows"><span>Setup local dev environment on Windows</span></a></h2><p>In case you want to develop for AKHQ on Windows with IntelliJ IDEA without Docker (for any reason) you can follow this brief guide. For the following steps, please, make sure you meet these requirements:</p><ul><li>OS: Windows (10)</li><li>Kafka (2.6.0) is downloaded and extracted, the installation directory is referred to as $KAFKA_HOME in the latter</li><li>Git is installed and configured</li><li>IntelliJ IDEA (Community Edition 2020.2) with the following plugins installed: <ul><li>Gradle (bundled with IDEA)</li><li><a href="https://plugins.jetbrains.com/plugin/6317-lombok" target="_blank" rel="noopener noreferrer">Lombok</a></li></ul></li></ul><p>First run a Kafka server locally. Therefore, you need to start Zookeeper first by opening a CMD and doing:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token variable">$KAFKA_HOME</span><span class="token punctuation">\</span>bin<span class="token punctuation">\</span>windows<span class="token punctuation">\</span>zookeeper-server-start.bat config<span class="token punctuation">\</span>zookeper.properties</span>
<span class="line"><span class="token variable">$KAFKA_HOME</span><span class="token punctuation">\</span>bin<span class="token punctuation">\</span>windows<span class="token punctuation">\</span>kafka-server-start.bat config<span class="token punctuation">\</span>server.properties</span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div><p>A zero-config Kafka server should be up and running locally on your machine now. For further details or troubleshooting see <a href="https://kafka.apache.org/quickstart" target="_blank" rel="noopener noreferrer">Kafka Getting started guide</a>. In the next step we're going to checkout AKHQ from GitHub:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token function">git</span> clone https://github.com/tchiotludo/akhq.git</span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Open the checked out directory in IntelliJ IDEA. The current version of AKHQ is built with Java 25. If you don't have OpenJDK 25 installed already, do the following in IntelliJ IDEA:</p><ul><li><em>File > Project Structure... > Platform Settings > SDKs > + > Download JDK... ></em> select a vendor of your choice (but make sure it's version 25)</li><li>download + install. Make sure that JDK 25 is set under <em>Project Settings > Project SDK</em></li><li>language level is Java 25.</li><li>Now tell Gradle to use Java 25 as well: <em>File > Settings > Plugins > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM</em>: any JDK 25.</li></ul><p>To configure AKHQ for using the Kafka server you set up before, edit <code>application.yml</code> by adding the following under <code>akhq</code>:</p><div class="language-yaml line-numbers-mode" data-highlighter="prismjs" data-ext="yml"><pre><code class="language-yaml"><span class="line"><span class="token key atrule">akhq</span><span class="token punctuation">:</span></span>
<span class="line"> <span class="token key atrule">connections</span><span class="token punctuation">:</span></span>
<span class="line"> <span class="token key atrule">kafka</span><span class="token punctuation">:</span></span>
<span class="line"> <span class="token key atrule">properties</span><span class="token punctuation">:</span></span>
<span class="line"> <span class="token key atrule">bootstrap.servers</span><span class="token punctuation">:</span> <span class="token string">"localhost:9092"</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container warning"><p class="hint-container-title">Warning</p><p>Do not commit this part of <code>application.yml</code>. A more secure way to configure your local development Kafka server is described in the Micronaut doc, chapter <a href="https://docs.micronaut.io/2.5.13/guide/index.html#config" target="_blank" rel="noopener noreferrer">"Application Configuration"</a>.</p></div><p>Now you should be able to build the project with Gradle. Therefore, go to the Gradle view in IDEA, select <em>Tasks > build > build</em>. If an error occurs saying that any filename is too long: move your project directory to a root directory in your filesystem or as a fix (only for testing purposes) set the argument <code>-x test</code> to skip tests temporarily.</p><p>To debug a running AKHQ instance, go to the Gradle tab in IntelliJ IDEA, <em>Tasks > application</em> > right click <code>run</code> and click "<em>Debug(...)</em>". AKHQ should start up and hit the breakpoints you set in your IDE. Happy developing/debugging!</p></div><!--[--><!--]--></div><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link label" href="https://github.com/tchiotludo/akhq/edit/dev/docs/docs/dev.md" aria-label="Edit this page" rel="noopener noreferrer" target="_blank"><!--[--><!--[--><svg class="edit-icon" viewbox="0 0 1024 1024"><g fill="currentColor"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></g></svg><!--]--><!--]-->Edit this page<!--[--><!--[--><!--]--><!--]--></a></div><div class="vp-meta-item git-info"><div class="vp-meta-item last-updated"><span class="meta-item-label">Last Updated: </span><time class="meta-item-info" datetime="2026-11-13T11:55:41.000Z" data-allow-mismatch>11/13/26, 11:55 AM</time></div><div class="vp-meta-item contributors"><span class="meta-item-label">Contributors: </span><span class="meta-item-info"><!--[--><!--[--><span class="contributor" title="email: alexis.souquiere@michelin.com">Alexis SOUQUIERE</span><!----><!--]--><!--]--></span></div></div></footer><nav class="vp-page-nav" aria-label="page navigation"><a class="route-link auto-link prev" href="/docs/api.html" aria-label="Api"><!--[--><div class="hint"><span class="arrow left"></span> Prev</div><div class="link"><span class="external-link">Api</span></div><!--]--></a><!----></nav><!--[--><!--]--></main><!--]--></div><!--[--><!----><!--]--><!--]--></div>
<script type="module" src="/assets/app-CJcco6Ta.js" defer></script>
</body>
</html>