You are viewing documentation for Vaadin Framework 8 and related products View documentation for Vaadin Framework 7 ›
Installing Vaadin Board · Vaadin
Vaadin Board - Java API - Installing Vaadin Board
 Edit This Page

Installing Vaadin Board

Vaadin Board is is currently being developed and only available in the Vaadin Framework 8.1 prerelease versions, starting from 8.1.0.beta2. There is no vaadin-archetype available for this version, so you can not generate the application. You need to add vaadin prerelease repository to your POM.xml and change vaadin dependencies to 8.1.0.beta2 in you existing vaadin project.

As with most Vaadin add-ons, you can install Vaadin Board as a Maven dependency in your project. For general instructions on installing add-ons, please see "Using Vaadin Add-ons".

Vaadin Board 1.0.0 requires Vaadin 8.1.0.beta2 or later.

Using Vaadin Board requires a license key, which you must install before compiling the widget set. The widget set must be compiled after setting up the dependency or library JARs.

Maven Dependency

The Maven dependency for Vaadin Board is as follows:

<dependency>
    <groupId>com.vaadin</groupId>
    <artifactId>vaadin-board</artifactId>
    <version>1.0.0-beta1</version>
</dependency>
<dependency>
    <groupId>com.vaadin</groupId>
    <artifactId>vaadin-board-precompiled</artifactId>
    <version>1.0.0-beta1</version>
</dependency>

You also need to define the Vaadin add-ons repository if not already defined:

<repository>
   <id>vaadin-addons</id>
   <url>http://maven.vaadin.com/vaadin-addons</url>
</repository>

Installing License Key

You need to install a license key before compiling the widget set. The license key is checked during widget set compilation, so you do not need it when deploying the application.

You can obtain a free trial key from the Vaadin Pro Licenses. You need to register in Vaadin Directory to get the key.

To install the license key in a development workstation, you can copy and paste it verbatim to a .vaadin.board.developer.license file in your home directory. For example, in Linux and OS X:

$ echo "L1cen5e-c0de" > ~/.vaadin.board.developer.license

You can also pass the key as a system property to the widget set compiler, usually with a -D option. For example, on the command-line:

$ java -Dvaadin.board.developer.license=L1cen5e-c0de …​

Passing License Key in Different Environments

How you actually pass the parameter to the widget set compiler depends on the development environment and the build system that you use to compile the widget set. Below are listed a few typical environments:

Eclipse IDE

To install the license key for all projects, select Window  Preferences and navigate to the Java  Installed JREs section. Select the JRE version that you use for the application and click Edit. In the Default VM arguments, give the -D expression as shown above.

Apache Ant

If compiling the project with Apache Ant, you could set the key in the Ant script as follows:

<sysproperty key="vaadin.board.developer.license"
             value="L1cen5e-c0de"/>

However, you should never store license keys in a source repository, so if the Ant script is stored in a source repository, you should pass the license key to Ant as a property that you then use in the script for the value argument of the <sysproperty> as follows:

<sysproperty key="vaadin.board.developer.license"
    value="${vaadin.board.developer.license}"/>

When invoking Ant from the command-line, you can pass the property with a -D parameter to Ant.

Apache Maven

If building the project with Apache Maven, you can pass the license key with a -D parameter to Maven:

$ mvn -Dvaadin.board.developer.license=L1cen5e-c0de package
Continuous Integration Systems

In CIS systems, you can pass the license key to build runners as a system property in the build configuration. However, this only passes it to a runner. As described above, Ant does not pass it to sub-processes implicitly, so you need to forward it explicitly as described earlier.