Skip to content

Commit

Permalink
Merge branch 'obsidiandynamics:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
DesineSperare authored Jan 6, 2025
2 parents 565b7d9 + 2f6f710 commit b90c7d2
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,23 @@ Kafdrop supports TLS (SSL) and SASL connections for [encryption and authenticati
* `kafka.keystore.jks`: specifying the private key to authenticate the client to the broker, if mutual TLS authentication is required.
* `kafka.properties`: specifying the necessary configuration, including key/truststore passwords, cipher suites, enabled TLS protocol versions, username/password pairs, etc. When supplying the truststore and/or keystore files, the `ssl.truststore.location` and `ssl.keystore.location` properties will be assigned automatically.

### Running from JAR
First create a `kafka.properties` file with the following content:

```yml
security.protocol=SASL_SSL
sasl.mechanism=SCRAM-SHA-512
sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required username="foo" password="bar"
```

Then run Kafdrop with the following command:

```shell
java -jar target/kafdrop-<version>.jar \
--kafka.brokerConnect=<host:port,host:port> \
--kafka.propertiesFile=./kafka.properties
```

### Using Docker
The three files above can be supplied to a Docker instance in base-64-encoded form via environment variables:

Expand Down
6 changes: 5 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
<exclusion>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
Expand Down Expand Up @@ -179,7 +183,7 @@
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.7.0</version>
<version>2.8.1</version>
</dependency>

<!-- Spring test -->
Expand Down

0 comments on commit b90c7d2

Please sign in to comment.