# Lenses Box {% embed url="" %} Lenses Box download {% endembed %} ## What’s in the Box? Lenses Box contains all components of the Apache Kafka ecosystem, CLI tools, and synthetic data streams.

Lenses Box

## Starting the Box 1. To start with the Box [get your free development license](https://lenses.io/apache-kafka-docker/) online. 2. Install and run the Docker ```bash docker run --rm \ -p 3030:3030 \ --name=dev \ --net=host \ -e EULA="https://dl.lenses.stream/d/?id=CHECK_YOUR_EMAIL_FOR_KEY" \ lensesio/box ``` Open Lenses in your [browser](http://localhost:3030), log in with `admin/admin.` ## Kafka Docker advertisement The broker in the Kafka docker has a broker id `101` and advertises the listener configuration endpoint to accept client connections. If you run Docker on macOS or Windows, you may need to find the address of the VM running Docker and export it as the advertised listener address for the broker (On macOS it usually is `192.168.99.100`). At the same time, you should give the `lensesio/box` image access to the VM’s network: ```sh docker run -e EULA="CHECK_YOUR_EMAIL_FOR_KEY" \ -e ADV_HOST="192.168.99.100" \ --net=host --name=dev \ lensesio/box ``` If you run on Linux, you don’t have to set the `ADV_HOST` , but you can do something cool with it. If you set it to be your machine’s IP address, you can access Kafka from any clients in your network. If you decide to run a box in the cloud, you (and all your team) can access Kafka from your development machines. Remember to provide the public IP of your server as the kafka advertised host for your producers and consumers to access it. ## Kafka Docker JMX Kafka JMX metrics are enabled by default. Refer to ports once you expose the relevant port, ie. `-p 9581:9581` you can connect to JMX with ```bash jconsole localhost:9581 ``` ## Custom hostname If you are using docker-machine or setting this up in a Cloud or **DOCKER\_HOST** is a custom IP address such as `192.168.99.100`, you will need to use the parameters `--net=host -e ADV_HOST=192.168.99.100`. ```sh docker run --rm \ -p 3030:3030 \ --net=host \ -e ADV_HOST=192.168.99.100 \ -e EULA="https://dl.lenses.stream/d/?id=CHECK_YOUR_EMAIL_FOR_KEY" \ lensesio/box ``` ## Docker data persistence To persist the Kafka data between multiple executions, provide a name for your Docker instance and do not set the container to be removed automatically (`--rm` flag). For example: ```sh docker run \ -p 3030:3030 -e EULA="CHECK_YOUR_EMAIL_FOR_KEY" \ --name=dev lensesio/box ``` Once you want to free up resources, just press `Control-C`. Now you have two options: either remove the Docker: ```sh docker rm dev ``` Or use it at a later time and continue from where you left off: ```sh docker start -a devhshel ``` ## Port Numbers
ServicePort Number
Kafka broker9092
Kafka connect8083
Zookeeper2181
Schema Registry8081
Lenses3030
Elasticsearch9200
Kafka broker JMX9581
Schema registry JMX9582
Kafka connect JMX9584
Zookeeper JMX9585
Kafka broker (ssl)9092
## Advanced options
VariableDescription
ADV_HOST=[ip-address]The ip address that the broker will advertise
DEBUG=1Prints all stdout and stderr processes to container’s stdout for debugging.
DISABLE_JMX=1Disables exposing JMX metrics on Kafka services.
ELASTICSEARCH_PORT=0Will not start Elasticsearch.
ENABLE_SSL=1Creates CA and key-cert pairs and makes the broker also listen to SSL://127.0.0.1:9093
KAFKA_BROKER_ID=1Overrides the broker id (the default id is 101).
SAMPLEDATA=0Disables the synthetic streaming data generator that are running by default.
SUPERVISORWEB=1Enables supervisor interface on port 9001 (adjust via SUPERVISORWEB_PORT) to control services.
## FAQ ### How can I run offline? Download your key locally and run the command: ```bash LFILE=`cat license.json` docker run --rm -it -p 3030:3030 -e LICENSE="$LFILE" lensesio/box:latest ``` ### How much memory to allocate? The container is running multiple services, and it is recommended to allocate 5GB of RAM to the docker (although it can operate with even less than 4GB). To reduce the memory footprint, it is possible to disable some connectors and shrink the Kafka Connect heap size by applying these options (choose connectors to keep) to the `docker run` command: {% code fullWidth="false" %} ```sh -e DISABLE=azure-documentdb,cassandra,elastic5,ftp,influxdb,jms,mongodb,mqtt,redis -e CONNECT_HEAP=512m ``` {% endcode %} --- # 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/lenses-box.md?ask= ``` 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.