"
# Optional settings (defaults shown):
# service_endpoint: https://api.lumi-ai.com # Lumi AI platform endpoint
# console_log_level: INFO # Log verbosity for console output
# # Valid values: TRACE, DEBUG, INFO,
# # SUCCESS, WARNING, ERROR, CRITICAL
# retry_count: 5 # Max consecutive connection failures
# # before the gateway gives up
# reset_time: 300 # Seconds before the retry counter resets
```
Configuration can also be supplied via environment variables or command-line arguments, which take precedence over the config file in that order:
| Setting | config.yaml key | Environment variable | CLI flag |
| ----------------- | ------------------- | -------------------------------------------- | ------------------- |
| Token | token | LUMI\_AI\_DATA\_GATEWAY\_TOKEN | --token |
| Platform endpoint | service\_endpoint | LUMI\_AI\_DATA\_GATEWAY\_SERVICE\_ENDPOINT | --service-endpoint |
| Console log level | console\_log\_level | LUMI\_AI\_DATA\_GATEWAY\_CONSOLE\_LOG\_LEVEL | --console-log-level |
| Retry count | retry\_count | LUMI\_AI\_DATA\_GATEWAY\_RETRY\_COUNT | --retry-count |
| Reset time | reset\_time | LUMI\_AI\_DATA\_GATEWAY\_RESET\_TIME | --reset-time |
### 4. Start the Data Gateway
Run the executable from its directory. The gateway runs in the foreground and prints log output to the terminal.
#### Linux
```bash
./lumi-agent-linux-vX.X.XX
```
#### Windows (Command Prompt or PowerShell)
```powershell
.\lumi-agent-windows-vX.X.XX.exe
```
To run the gateway as a background service that starts automatically at boot, see [Configuring the Data Gateway for Boot](/product-features/data-gateway/configuring-the-data-gateway-for-boot.md).
If any issues arise, see [Troubleshooting](#troubleshooting-1) below.
### 5. Check the Admin Panel
The Data Gateway instance should now appear as **Active** in the Admin Settings panel.
{% hint style="info" %}
An Active status confirms the gateway process is running and connected to the platform. It does not validate the connection configuration for a specific Knowledge Base — you can test and verify source system connectivity from the Knowledge Base settings.
{% endhint %}
### 6. \[Optional] Configure the Data Gateway to Run at Startup
See [Configuring the Data Gateway for Boot](/product-features/data-gateway/configuring-the-data-gateway-for-boot.md) for instructions on setting up the gateway as a service or scheduled task on Linux or Windows.
## Docker Deployment
A Linux Docker image is available for enterprise customers on request. [Contact support](mailto:support@lumi-ai.com) to obtain the image.
The Docker image is based on Ubuntu 22.04 and includes:
* The gateway binary at `/opt/lumi-ai-data-gateway/lumi-ai-data-gateway`
* Microsoft ODBC Driver 18 for SQL Server (pre-installed — no extra setup needed for SQL Server connections)
* A non-root `lumi` user for runtime security
No inbound ports are exposed. The gateway communicates outbound only.
### Running with Docker
The simplest way to run is to pass the token as an environment variable:
docker run -d \
--name lumi-data-gateway \
--restart unless-stopped \
-e LUMI_AI_DATA_GATEWAY_TOKEN= \
<image>
To persist logs on the host, mount the logs directory:
```bash
docker run -d \
--name lumi-data-gateway \
--restart unless-stopped \
-e LUMI_AI_DATA_GATEWAY_TOKEN= \
-v /opt/lumi-gateway/logs:/opt/lumi-ai-data-gateway/logs \
```
To use a `config.yaml` file instead of environment variables, mount it into the container at the expected path:
```bash
docker run -d \
--name lumi-data-gateway \
--restart unless-stopped \
-v /opt/lumi-gateway/config.yaml:/opt/lumi-ai-data-gateway/config.yaml:ro \
-v /opt/lumi-gateway/logs:/opt/lumi-ai-data-gateway/logs \
```
### Running with Docker Compose
```yaml
services:
lumi-data-gateway:
image:
container_name: lumi-data-gateway
restart: unless-stopped
environment:
- LUMI_AI_DATA_GATEWAY_TOKEN=
volumes:
- ./logs:/opt/lumi-ai-data-gateway/logs
```
Save this as `docker-compose.yml` and run:
```bash
docker compose up -d
```
### Viewing Logs
Container stdout (console output at INFO level):
```bash
docker logs lumi-data-gateway
docker logs -f lumi-data-gateway # follow
```
If you mounted the log volume, the full DEBUG-level log file is at the host path you specified.
### Checking Health
The image includes a health check that confirms the gateway process is running:
```bash
docker inspect --format='{{.State.Health.Status}}' lumi-data-gateway
```
A status of `healthy` means the process is running. Check the Admin Settings panel to confirm the gateway is connected to the platform.
{% hint style="info" %}
The Docker image is Linux-only. For Windows hosts, use the standalone executable with the Task Scheduler or Windows Service method described in [Configuring the Data Gateway for Boot](/product-features/data-gateway/configuring-the-data-gateway-for-boot.md).
{% endhint %}
## Troubleshooting
**Check the admin panel status**
If the instance shows as **Inactive**, verify the process is running on the host and restart it if necessary.
**Check the gateway log**
The `logs` folder next to the executable (or the mounted volume path for Docker) contains up to 7 days of logs at DEBUG level. Error events are logged with context that can help identify the root cause.
**Verify the token**
If the token is invalid or associated with a different gateway instance, the gateway will not connect. Generate a new token from the Admin Settings panel and update your configuration.
**Verify outbound network connectivity**
The gateway host must be able to reach Lumi AI's endpoints over HTTPS on port 443. Test basic connectivity from the host:
```bash
# Linux / macOS
curl -I https://api.lumi-ai.com
curl -I https://broker.lumi-ai.com
# Windows (PowerShell)
Invoke-WebRequest -Uri https://api.lumi-ai.com -Method Head
Invoke-WebRequest -Uri https://broker.lumi-ai.com -Method Head
```
Any response (including an error status code) confirms the TCP connection is working. A connection timeout or TLS error points to a firewall or SSL inspection issue — see [Network Configuration](/using-lumi/network-configuration.md) for guidance.
If none of the above resolves the issue, [contact Lumi AI support](mailto:support@lumi-ai.com).
---
# 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.lumi-ai.com/product-features/data-gateway/deploying-the-data-gateway.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.