License Validation & Troubleshooting

How commercial product license validation works, and how to get and use license keys.

Vaadin core includes an extensive set of technologies and components that are free to use. Vaadin core is available under the terms of the Apache License 2.0, which allows you to use what’s included in any project — even commercially.

You need a commercial license only if you use one of the commercial components (e.g., Vaadin Charts) or one of the tools (e.g., Vaadin TestBench). If a project includes such components or tools, a commercial license is needed for development, and to build a production application.

Vaadin requires a production runtime license only for a Premium subscription which counts Daily Active Users. Starting in version 24.5, Collaboration Kit is free. Previously, it was priced per end-user (see Collaboration Kit documentation).

For other use cases, you don’t need a license after deploying an application to production.

Local License Validation

On a local machine, the licenses for commercial components and tools are checked automatically using your Vaadin account. The first time you use a commercial component or tool, you’ll be asked to log into vaadin.com to validate your license.

Once validated, you can continue developing your project. A license key is created on your machine in the following location:

%userprofile%\.vaadin\proKey

Offline License Key

If your local development environment is offline and can’t reach vaadin.com, you’ll need to get an offline license key.

Each offline license key is tied to the machine ID, in the form of mid-xxxxxxxx-xxxxxxxx. You’ll have to submit that to vaadin.com/myaccount/licenses, so as to download an offline license key.

Once you’ve downloaded the offlineKey file — remove any .txt suffix-- you should place it in your home directory:

%userprofile%\.vaadin\offlineKey

Machine ID

You can find your machine ID in the logs when you try to use a commercial component or tool offline without an existing license key. You can also find it by running the following commands on your machine:

mvn dependency:get -Dartifact=com.vaadin:license-checker-machineid:1.8.1
java -jar %userprofile%\.m2\repository\com\vaadin\license-checker-machineid\1.8.1\license-checker-machineid-1.8.1.jar

Validation on CI/CD or Build Server

For CI/CD/build servers, you’ll need to download a server license key. These can only be used for production builds. You can download such a key (i.e., an offlineKey file) from vaadin.com/myaccount/licenses.

You should place the offlineKey file in the home directory of the CI server like so:

%userprofile%\.vaadin\offlineKey

You can also give the license key by using the vaadin.offlineKey system property or the VAADIN_OFFLINE_KEY environment variable. Copy the license key string value from the offlineKey file.

mvn -Dvaadin.offlineKey=[contents of offlineKey file here] ...

Troubleshooting

You can contact [email protected] for further help.

I Get A Trial Message Although I Have A Valid License

Verify that you have a valid license by going to vaadin.com/pro/validate-license. If not, either your company’s license administrator hasn’t yet assigned a seat for you, or the license is no longer valid.

SSLHandshakeException with Multiplatform Runtime

This is a known error in SSLHandshakeException reported by users of WebSphere Liberty and WildFly in Docker. See the following discussion for more details: vaadin.com/forum/t/running-mpr-project-on-websphere-liberty-fails-with-suncertpathbuilderexcep/160675.

D56655EB-4310-49FF-8A81-E790235E1420

Docs