arrow-left

All pages
gitbookPowered by GitBook
1 of 3

Loading...

Loading...

Loading...

Environment Variables

Listed in this page are all environment variables needed to run Jsreport.

Variable Name
Type
Relevance
Required
Default

JS_REPORT_LICENSE_KEY

String

Service license key

Yes

JS_REPORT

String

Jsreport service password

No

dev_password_only

JS_REPORT_USERNAME

String

Jsreport service username

No

admin

JS_REPORT_SECRET

String

Secret password for the authentication of a cookie session related to the extension used in Jsreport

No

dev_secret_only

ES_HOSTS

String

Elasticsearch connection string

No

analytics-datastore-elastic-search:9200

ES_PASSWORD

String

Elasticsearch password (for request authentication)

No

dev_password_only

ES_USERNAME

String

Elasticsearch username (for request authentication

No

elastic

JS_REPORT_INSTANCES

Number

Number of service replicas

No

1

JS_REPORT_SSL

Boolean

SSL protocol requirement

No

false

JS_REPORT_CONFIG_FILE

String

Path to the service import file

No

export.jsrexport

JS_REPORT_DEV_MOUNT

Boolean

Dev mount mode enabling flag

No

false

JS_REPORT_PACKAGE_PATH

String

Local path to package

Yes if JS_REPORT_DEV_MOUNT is set to true

JS_REPORT_CPU_LIMIT

Number

CPU usage limit

No

0

JS_REPORT_MEMORY_LIMIT

String

RAM usage limit

No

3G

JS_REPORT_CPU_RESERVE

Number

Reserved CPU

No

0.05

JS_REPORT_MEMORY_RESERVE

String

Reserved RAM

No

500M

Local Development

hashtag
Accessing the Service

Jsreport - http://127.0.0.1:5488/arrow-up-right

hashtag
Scripts/Templates Development

When seeking to make changes to the Jsreport scripts/templates without having to repeatedly start and stop the service, one can set the JS_REPORT_DEV_MOUNT environment variable in your .env file to true to attach the service's content files to those on your local machine.

circle-exclamation
  • You have to run the set-permissions.sh script before and after launching Jsreport when JS_REPORT_DEV_MOUNT=true.

  • REMEMBER TO EXPORT THE JSREXPORT FILE WHEN YOU'RE DONE EDITING THE SCRIPTS. More info is available at

circle-info
  • With JS_REPORT_DEV_MOUNT=true, you have to set the JS_REPORT_PACKAGE_PATH variable with the absolute path to the Jsreport package on your local machine, i.e., JS_REPORT_PACKAGE_PATH=/home/user/Documents/Projects/platform/dashboard-visualiser-jsreport

hashtag
Export & Import

After editing the templates in Jsreport, you will need to save these changes, it is advised to export a file containing all the changes named export.jsrexport and put it into the folder <path to project packages>/dashboard-visualiser-jsreport/importer.

The config importer of Jsreport will import the export.jsrexport and then all the templates, assets, and scripts will be loaded in Jsreport.

Remember to shut down Jsreport before changing git branches if JS_REPORT_DEV_MOUNT=true, otherwise, the dev mount will persist the Jsreport scripts/templates across your branches.
https://jsreport.net/learn/import-exportarrow-up-right

Dashboard Visualiser - Jsreport

Jsreport is a visualisation tool configured to query data from Elasticsearch.

hashtag