How to...
General questions
Licensing and payments
# 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
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.
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.
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.
You can always found the roadmap in the jsreport github repository here.
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.
You can choose one from the options below:
license-key.txtlicense-key, or licenseKey--license-key=xxx or --licenseKey=xxxlicense-key or licenseKeyIn case you purchased the single server enterprise license and need to apply it to the development instance apply the following configuration.
{
"license": {
"development": true
}
}
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.
Historically there are two kinds of jsreport purchases. You have bought either directly from us or from gumroad.com. The payment update process differs in both cases.
You can distinguish which kind of purchase you initiated simply by checking your last invoices. If there is gumroad.com mentioned, you have purchased from them. All jsreportonline purchases are based on gumroad.com so far. Also, all licenses purchased before 05/27/2020 are based on gumroad.com
Gumroad
My account/Settings in the menuUse different card and update the account detailsDirect sale from jsreport
Historically there are two kinds of jsreport purchases. You have bought either directly from us or from gumroad.com. The subscription cancel process differs in both cases.
You can distinguish which kind of purchase you initiated simply by checking your last invoices. If there is gumroad.com mentioned, you have purchased from them. All jsreportonline purchases are based on gumroad.com so far. Also, all licenses purchased before 05/27/2020 are based on gumroad.com
Gumroad
Direct sale from jsreport
The free plan can be used in commercial projects with only one limitation. You can store a 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 a stored template. To be sure you can always open the 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 paid licenses.
The subscriptions get automatically renewed every year. You should receive an email informing you 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. In case you don't want automatic renewal, you can cancel the subscription after the purchase and it will stay active only for 1 year.
The jsreport instance automatically remotely revalidates the license key during the start when you reach the date when the renewal should happen. This information, when the revalidation should happen, is stored in the file jsreport.license.json which is created during the first license key validation.
The jsreport instance will still boot if the subscription renewal fails. There is a one-month additional period to solve the payment problems, during which jsreport just logs a warning.
If the jsreport instance doesn't have an internet connection, you should start the same instance locally with an internet connection and let it revalidate the license and update the jsreport.license.json. Then you can copy it to the production instance. However, the jsreport only logs a warning when isn't able to reach the licensing server, so you can also only ignore it.
The one-time perpetual licenses cover just six months of jsreport updates after the purchase. If you need an update after this period, you can purchase the upgrade package from your customer portal. The upgrade package adds another 6 months of updates. The price is 495$ for the single instance license and 1395$ for the scale license.
jsreport company address and VAT number which are part of the invoices are the following:
jsreport s.r.o.
Jičínská 226/17
130 00 Prague
Czech Republic
VAT: CZ05821916