logireport-server
Pixel-perfect Reporting for Data Analysis and insight
1M+
Logi Report enables you to generate and distribute precise reports at scale without coding or leaving the app.
Logi Report from Logi Analytics empowers companies to embed the most precise, high performance reports and dashboards into web applications. The embedded analytics platform provides developers and users with a scalable, fault tolerant solution that’s easy to customize and work seamlessly as part of their applications on any platform, with any data source. Every day, Logi Report delivers insights for hundreds of thousands of users at over 10,000 OEM and enterprise installations worldwide.
Logi Report lets you design, embed, and scale sophisticated operational reports. Get precise layout control and easy distribution to thousands of users.
docker run --name logireportserver -itd \
-e USERKEY="<fake_user_key>" \
-e USERPASSWORD="<fake_user_password>" \
-e LGRPT_ADMIN_USERNAME=admin \
-e LGRPT_ADMIN_PASSWORD=admin_Pass30rd \
-e LGRPT_INIT_HEAP_SIZE=700m \
-e LGRPT_MAX_HEAP_SIZE=16g \
-e LGRPT_RESTART_TIMEOUT=10 \
-p 8888:8888/tcp logianalytics/logireport-server
or use docker-compose
services:
logireportserver:
environment:
# License key and password for LogiReport Server
# Replace with your actual user key and password.
- USERKEY=<fake_user_key>
- USERPASSWORD=<fake_user_password>
# Set the admin user password for LogiReport Server
# Replace with your actual admin user and password
- LGRPT_ADMIN_USERNAME=admin
- LGRPT_ADMIN_PASSWORD=admin_Pass30rd
# Initial and maximum heap sizes for the LogiReport Server JVM
- LGRPT_INIT_HEAP_SIZE=700m
- LGRPT_MAX_HEAP_SIZE=16g
# Timeout in second for server restart when getting abnormal shutdown
- LGRPT_RESTART_TIMEOUT=10
# For version upgrades, just change the image tag to the new version.
# For example, to upgrade from v25.1.1 to version v25.1.4, change the image tag to `logianalytics/logireport-server:25.1.4`.
# Note: you can only upgrade to a newer version, not downgrade to an older version, if you use an older version tag,
# you'll be prompted 'This docker image version, vXXXX cannot work with the installed version, vYYYY, will exit.'
# in the container logs.
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
Then access the service at http://localhost:8888/
If you want to keep things like your license key, deployed reports, and server settings, and use them in a new container, mount container path /opt/LogiReportServer to a volume:
docker run --name logireportserver -itd -p 8888:8888/tcp -v report_home:/opt/LogiReport/Server logianalytics/logireport-server
or use docker compose:
services:
logireportserver:
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
volumes:
# Bind REPORTHOME in container to a volume on the host machine
# for persisting LogiReport Server data.
- report_home:/opt/LogiReport/Server
volumes:
# Volume definition for persisting LogiReport Server data.
# For demo, we are using named volume on the docker host here.
# You can also use a host path, NFS or a cloud storage solutions (e.g. AWS EBS/EFS).
# When using a host path or NFS, make sure the path is writable by
# the container user (logi user with UID 1106).
report_home: {}
Logi Report Server logs can be found in the following directory inside the container:
/opt/LogiReport/Server/logs
You can also stream the logs to the container console for easier access to the logs, set log levels, and configure console logs destination using environment variables.
All logger types support the following log levels:
OFF: Disable logging.ERROR: Only log error messages.WARN: Log warning and error messages.INFO: Log informational, warning, and error messages.DEBUG: Log debug, informational, warning, and error messages.TRACE: Log trace, debug, informational, warning, and error messages.services:
logireportserver:
environment:
# Stream Logi Report Server logs to container console
- LGRPT_ENABLE_CONSOLE_LOGS_DESTINATION=true
# Log level settings
- LGRPT_LOGGER_ENGINE_LEVEL=ERROR
- LGRPT_LOGGER_DHTML_LEVEL=ERROR
- LGRPT_LOGGER_DESIGNER_LEVEL=ERROR
- LGRPT_LOGGER_EVENT_LEVEL=ERROR
- LGRPT_LOGGER_ERROR_LEVEL=ERROR
- LGRPT_LOGGER_ACCESS_LEVEL=ERROR
- LGRPT_LOGGER_MANAGE_LEVEL=ERROR
- LGRPT_LOGGER_DEBUG_LEVEL=ERROR
- LGRPT_LOGGER_PERFORMANCE_LEVEL=ERROR
- LGRPT_LOGGER_DUMP_LEVEL=ERROR
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
The built-in hsqldb in the out of box docker image is just for demo purposes. For production use, you should use a real database such as PostgreSQL, MySQL, or Oracle.
You can set the database connection properties using environment variables when running the container. For example, to use PostgreSQL, you can set the following environment variables:
services:
logireportserver:
environment:
# Database settings for Logi Report Server
- LGRPT_SYSDB_TYP=Production
- LGRPT_SYSDB_JDBC_URL=jdbc:postgresql://your-db-host/logireport
- LGRPT_SYSDB_JDBC_DRIVER_CLASSNAME=org.postgresql.Driver
# Download the PostgreSQL JDBC driver from https://jdbc.postgresql.org/download/postgresql-42.7.3.jar
# to the ./additional-lib folder on the host machine, and then bind mount it to this path in the container.
- LGRPT_SYSDB_JDBC_DRIVER_PATH=/var/lib/logi-report/additional-lib/postgresql-42.7.3.jar
- LGRPT_SYSDB_USERNAME=your_db_username
- LGRPT_SYSDB_PASSWORD=your_db_password
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
volumes:
# Bind additional java libraries, such as JDBC drivers, to the container.
# Put jar files into ./additional-lib folder on the host machine.
- ./additional-lib:/var/lib/logi-report/additional-lib
Logi Report Server supports clustering for high availability and load balancing. To enable clustering, set the following environment variables:
services:
logireportserver:
environment:
- LGRPT_CLUSTER_ENABLE=true
- LGRPT_CLUSTER_NAME=logireport-cluster
# Set the cluster history directory, which should be shared across all nodes in the cluster.
# Make sure the directory exists and is writable by the logi user (UID 1106).
- LGRPT_HISTORY_DIRECTORY=/var/lib/logi-report/shared/history
# Enable automatic host detection for cluster nodes.
- LGRPT_JAVA_OPTS=-Djreport.cluster.auto_detect_host=true
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
volumes:
# Bind named volume for persisting LogiReport Server history.
- shared_data:/var/lib/logi-report/shared
volumes:
# Define a named external volume for persisting LogiReport Server history.
shared_data:
driver: local
driver_opts:
type: nfs4
o: addr=10.123.45.16,rw,noatime,nolock
device: :/Public/logireport/shared
Logi Report Server supports TrueType fonts for report rendering. To add custom TrueType fonts, bind mount the font folder with TTF files to the container:
services:
logireportserver:
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
volumes:
# Put TTF files into ./font folder on the host machine,
# and mount it to font subdirectory under the customized
# resources directory in the container.
- ./font:/var/lib/logi-report/custom/font
Note:
The main Logi Report Server installation directory inside the container is/opt/LogiReport/Server.
The/var/lib/logi-report/customdirectory is used for customizations, additional resources, and configuration overrides (such as custom fonts, CSS/HTML/JS files, or property files), please keep the directory structure same as/opt/LogiReport/Server, so that the customized resources can be correctly applied.
For example, you can customize the Logi Report Server properties by binding a custom server.properties file from your host to the container path /var/lib/logi-report/custom/bin/install.server.properties. This allows you to override server properties without modifying the main installation directory.
You can also customize the HTTP response headers by binding a custom responseHeaders.properties file to the container file /var/lib/logi-report/custom/bin/responseHeaders.properties.
services:
logireportserver:
image: logianalytics/logireport-server
ports:
- "8888:8888/tcp"
volumes:
# Bind customized server properties file to the server container.
- ./bin/server.properties:/var/lib/logi-report/custom/bin/install.server.properties
# Bind customized http response headers to the server container.
# Refer to https://docs-report.zendesk.com/hc/en-us/articles/12491438683277-Security-for-Accessing-Web-Pages#HTTPHeader
# for more information.
- ./bin/responseHeaders.properties:/var/lib/logi-report/custom/bin/responseHeaders.properties
Please refer to the Logi Report Server documentation for a complete list of available environment variables and their descriptions.
Where to get help: Logi Report Server Documentation, Docker Community Forums, Docker Blog or Stack Overflow
Maintained by: Logi Analytics
Supported Docker versions: Latest release (down to 1.6 on a best-effort basis)
Content type
Helm
Digest
sha256:b7b2644ed…
Size
2 kB
Last updated
17 days ago
helm pull oci://registry-1.docker.io/logianalytics/logireport-server --version 26.1.2-helm