FAQ

How to...

General questions

Licensing and payments

Update existing jsreport server to the latest version

# install helpful tool to check the latest versions
npm install -g npm-check-updates
# check the latest versions of jsreport and additional extensions.
# remember to check release notes when you are planning to update,
# specially if you are going to do a major version update
ncu
# update package.json
ncu -u
# install the latest versions
npm install

Deploy to production

The simplest way to deploy local instance to the production is to compress the whole application folder, upload it to the server and decompress. You can even simply attach the node executable to the compressed package if you don't have node.js installed on the production server. Such package should be able to run without other dependencies installed. This approach should work as long as you have the same OS architecture on the local and the production.

The other options are to run install through npm on the production server and then just copy the templates.

The most complex and powerful approach is to set up an image through docker for example.

Migrate templates from the test to the production server

migrating/moving templates should be easy using the import-export feature, you can export from test server and then import the generated backup (zip file) into the production server. other option can be to copy files, since jsreport stores by default templates in the [application path]/data folder. To migrate templates you can just grab content of this folder and copy it to the production server.

Run jsreport on different port

You need to open jsreport.config.json file and edit httpPort property to desired value. another option is to use cli args or env vars to set the port while starting jsreport. ex: jsreport start --httpPort 5489 or httpPort=5489 jsreport start. For details please explore configuration documentation, which contains different ways to do it.

Roadmap

You can always found the roadmap in the jsreport github repository here.

Running in browser

You can use jsreport browser client to invoke rendering from the browser. However jsreport itself is server side tool and cannot run fully in the browser.

How to apply license key

You can choose one from the options below:

  1. The license key can be saved into the application working directory as license-key.txt
  2. Filled in the configuration file in the property license-key, or licenseKey
  3. Passed in the command line parameter as --license-key=xxx or --licenseKey=xxx
  4. Set in the environment variable as license-key or licenseKey

When using the official jsreport docker image, you can follow these instructions to apply your license key.

The license key validation is invoked remotely and requires internet connection. In case your production server doesn't have internet connection you can either ignore the warning in the logs, or let the validation happen on computer with internet connection. The validation during the first run creates file jsreport.license.json which you can just copy paste to the production server without internet. Note in case of yearly subscription the license validation runs every year.

Update payment details

jsreport enterprise or jsreportonline subscribers can update the payment details in the following way.

  1. Open your gumroad account
  2. Login through the email you filled during the initial subscription. It is the same email your receipts are being sent to.
  3. Choose My account/Settings in the menu
  4. Select Use different card and update the account details

Cancel subscription

  1. Open your gumroad account
  2. Select the subscription you want to cancel
  3. Click red "Cancel subscription" button

You can find more detail description in gumroad help.

5 templates limitation in free plan

The free plan can be used in commercial projects with only one limitation. You can store maximum 5 templates in the jsreport store. The template entities are typically created and persisted to store using jsreport studio UI. The templates sent to the jsreport render API with full specification doesn't count to this. In other words the requests which includes in the body template.content are not using stored template. To be sure you can always open jsreport studio and verify how many templates are visible there.

The studio also warns in the modal dialog that the maximum number of templates was reached and one month trial in which you can use infinite templates started. In case your trial expires and you want to get back to the free license, you need to delete some of the templates manually from the data folder. Each template is represented by a folder that has the same name as the template.

There is no other limitation in the free plan compared to the payed licenses.

Subscription renew

The subscriptions gets automatically renewed every year. You should receive an email from gumroad informing about the renewal payment every year. The license key stays the same. This means there is no change needed in your application. Keep in mind you should update your payment details if you change the bank card.