# Docker

{% hint style="info" %}
On start-up, Lenses will be in bootstrap mode unless it has an existing Kafka Connection. See [provisioning ](/latest/devx/5.5/deployment/installation/automation.md)for automating.
{% endhint %}

The Lenses docker image can be configured via environment variables or via volume mounts for the configuration files (`lenses.conf`, `security.conf`).

## Running the Docker

{% code fullWidth="false" %}

```bash
docker run --name lenses \
  -e LENSES_PORT=3030\
  -e LENSES_SECURITY_USER=admin \
  -e LENSES_SECURITY_PASSWORD=sha256:8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918 \
  -p 3030:3030\
  -p 9102:9102 \
   lensesio/lenses:latest
```

{% endcode %}

Open Lenses in your [browser](http://localhost:3030), log in with `admin/admin` and configure your [brokers ](/latest/devx/5.5/getting-started/connections/kafka.md)and add your [license](/latest/devx/5.5/getting-started/connections/adding-a-license.md).

## Environment Variables

Environment variables prefixed with **`LENSES_`** are transformed into corresponding configuration options. The environment variable name is converted to lowercase and underscores (`_`) are replaced with dots (`.`). As an example set the option `lenses.port` use the environment variable `LENSES_PORT`.

Alternatively, the **lenses.conf** and **security.conf** can be mounted directly as

* **/mnt/settings/lenses.conf**
* **/mnt/secrets/security.conf**

## Docker volumes <a href="#docker-volumes" id="docker-volumes"></a>

The Docker image exposes four volumes in total, where cache, logs, plugins, and persistent data are stored:

* `/data/storage`
* `/data/plugins`
* `/data/logs`
* `/data/kafka-streams-state`

### Storage volume <a href="#storage-volume" id="storage-volume"></a>

Resides under `/data/storage` and is used to store persistent data, such as Data Policies. For this data to survive between Docker runs and/or Lenses upgrades, the volume must be managed externally (persistent volume).

### Plugins volume <a href="#plugins-volume" id="plugins-volume"></a>

Resides under `/data/plugins` it’s where classes that extend Lenses may be added —such as custom Serdes, LDAP filters, UDFs for the Lenses SQL table engine, and custom\_http implementations.

### Logs volume <a href="#logs-volume" id="logs-volume"></a>

Resides under `/data/logs`, logs are stored here. The application also logs to stdout, so the log files aren’t needed for most cases.

### KStreams state volume <a href="#kstreams-state-volume" id="kstreams-state-volume"></a>

Resides under `/data/kafka-streams-state`, used when Lenses SQL is in IN\_PROC configuration. In such a case, Lenses uses this scratch directory to cache Lenses SQL internal state. Whilst this directory can safely be removed, it can be beneficial to keep it around, so the Processors won’t have to rebuild their state during a restart.

## Lenses TLS and Global JVM Trust Store <a href="#lenses-tls-and-global-jvm-trust-store" id="lenses-tls-and-global-jvm-trust-store"></a>

By default, the Lenses serves connections over plaintext (HTTP). It is possible to use TLS instead. The Docker image offers the ability to provide the content for extra files via secrets mounted as files or as environment variables. Especially for SSL, Docker supports SSL/TLS keys and certificates in Java Keystore (JKS) formats.

This capability is optional, and users can mount such files under custom paths and configure `lenses.conf` manually via environment variables, or `lenses.append.conf`.

There are two ways to use the File/Variable names of the table below.

1. Create a file with the appropriate filename as listed below and mount it under `/mnt/settings`, `/mnt/secrets`, or `/run/secrets`
2. Set them as environment variables.

All settings except for passwords, can be optionally encoded in base64. The docker will detect such encoding automatically.

<table data-full-width="false"><thead><tr><th>File / Variable Name</th><th>Description</th></tr></thead><tbody><tr><td><code>FILECONTENT_JVM_SSL_TRUSTSTORE</code></td><td>The SSL/TLS trust store to use as the global JVM trust store.<br>Add to LENSES_OPTS the property javax.net.ssl.trustStore</td></tr><tr><td><code>FILECONTENT_JVM_SSL_TRUSTSTORE_PASSWORD</code></td><td>Τhe trust store password. If set, the startup script will add automatically to LENSES<em>OPTS the property javax.net.ssl.trustStorePassword (**_base64 not supported</em>**)</td></tr><tr><td><code>FILECONTENT_LENSES_SSL_KEYSTORE</code></td><td>The SSL/TLS keystore to use for the TLS listener for Lenses</td></tr></tbody></table>

## Process UID/GUI <a href="#process-uidgui" id="process-uidgui"></a>

The docker does not require running as root. The default user is set to root for convenience and to verify upon start-up that all the directories and files have the correct permissions. The user drops to `nobody` and group `nogroup` (**65534:65534**) before starting Lenses.

If the image is started without root privileges, the agent will start successfully using the effective uid:gid applied. Ensure any volumes mounted (i.e., for the license, settings, and data) have the correct permission set.


---

# Agent Instructions: 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://docs.lenses.io/latest/devx/5.5/deployment/installation/docker.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.
