Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/.styles/config/vocabularies/webforj/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,5 @@ Stylus
Preact
Svelte
stylesheet
BLS
BASIS
6 changes: 2 additions & 4 deletions docs/docs/configuration/licensing-and-watermark.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Request a webforJ trial certificate and place certificate.bls in th

By default, webforJ projects can be run but won't have a license certificate associated with them. When running an unlicensed project, a watermark will display on the running app's UI until a valid license has been entered.

<!-- TODO add link -->
For individual developers, getting a trial license certificate of webforJ is simple. Visit the [webforJ pricing page](https://webforj.com/pricing/), choose the appropriate plan, and follow the prompts to request a license.

For individual developers, getting a trial license certificate of webforJ is simple, visit the license certification request form, fill out the details, and submit the form. Once submitted, a confirmation email with an attached `certificate.bls` file will be sent to the provided email.

Place this file inside of the `resources` directory of a project, and the watermark will no longer display.
To let a webforJ app request a license from a service running on your development machine or internal network, go to [Local BLS License](./local-bls-license).
99 changes: 99 additions & 0 deletions docs/docs/configuration/local-bls-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: Local BLS License

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BLS', if it's unfamiliar to the audience.

sidebar_class_name: new-content
sidebar_position: 25
description: Configure a webforJ project to use a locally installed BLS certificate and client configuration.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BLS', if it's unfamiliar to the audience.

---

A local BASIS License Service (BLS) lets a webforJ app request a license from a service running on your development machine or internal network. This setup is useful when you have a serial number and authorization number and want the project to use the generated local license files instead of the default license configuration.

A webforJ project made with [startforJ](https://docs.webforj.com/startforj) includes two license files under `src/main/resources`:

```text
src/main/resources/blsclient.conf
src/main/resources/certificate.bls
```

Here's how to replace the default license files with ones generated with a local BLS installation:

## Prerequisites {#prerequisites}

Before you start, make sure you have:

- Java 21 or Java 25 available to run the BLS 26 installer.
Comment thread
bbrennanbasis marked this conversation as resolved.
- A serial number and authorization number.
- A webforJ project with a `src/main/resources` directory.
- Access to the machine where BLS will run.
Comment thread
bbrennanbasis marked this conversation as resolved.

## 1. Download the BLS installer {#1-download-bls}
Comment thread
bbrennanbasis marked this conversation as resolved.

To get the BLS installer, go to the [BASIS Product Suite Downloads](https://basis.cloud/bbj-downloads/) page.
Once you've selected a desired language for the form, go to the **Select Product** section. In the **Product** dropdown, select `BLS`, and in the **Revision** dropdown, select the latest version. The required Java versions for running the BLS are under the **Revision** dropdown.

Then, fill in the form inside **Contact Information**, and select the checkboxes inside **Download Terms**.
Once you've filled the form, select the `Download` button to download the BLS installer JAR.

![Download form with BLS selected as the product](/img/configuration/local-bls-license/download-bls.png#rounded-border)

*Download form with `BLS` selected as the product.*

## 2. Install and Configure the BLS {#2-install-andc-onfig-bls}

The downloaded executable JAR has the following naming convention: `BLS<revision><date>_<time>.jar`. Locate the JAR and double-click it to launch the installer, or run it from a command console:

```bash
java -jar <downloaded-bls-installer>.jar
```

Follow the installer prompts and fill in the required details.

By default, the BLS installs in specific directories depending on the operating system, but can be changed in the **Directory Selection** window. Going forward, `<blshome>` refers to the installation location of the BLS.

- **Windows**: `C:\bls`
- **macOS**: `/Applications/bls`
- **Other operating systems**: `/usr/local/bls`

Once you've installed the BLS, it will open the **License Registration Wizard**.

### License registration {#license-registration}

1. In the License Registration Wizard, choose the `Retrieve a license` option:

![License Registration Wizard with Retrieve a license selected](/img/configuration/local-bls-license/retrieve-license.png#rounded-border)

*License Registration Wizard with `Retrieve a license` selected.*

2. In the next windows, enter your contact information, serial number, and authorization number.

3. When you get to the **License Registration and Delivery Methods** window, choose `Register and install a license automatically`.

After registering your license, finish configuring the local BLS as needed. If, at a later point, you need to change your BLS settings, or retrieve another license, use the BLS Admin at `<blshome>/bin/BLSAdmin`.

## 3. Copy the generated license files {#3-copy-the-generated-license-files}

Now, go to the `<blshome>/cfg` directory and locate the generated license files `blsclient.conf` and `certificate.bls`:

![BLS cfg folder containing the generated client configuration and certificate](/img/configuration/local-bls-license/bls-cfg-folder.png#rounded-border)
Comment thread
bbrennanbasis marked this conversation as resolved.

*BLS installation `cfg` folder containing the generated client configuration and certificate.*
Comment thread
bbrennanbasis marked this conversation as resolved.

Copy `blsclient.conf` and `certificate.bls` into your webforJ project, and replace any existing files with the same names in the resources directory. Now, when your local BLS is running, your webforJ app requests the license from that service.

```
src
├───main
│ ├───java/
│ └───resources
│ ├───icons/
│ ├───static/
│ ├───application.properties
│ ├───banner.txt
// highlight-next-line
│ ├───blsclient.conf
// highlight-next-line
│ └───certificate.bls
```

:::tip
If your license files live outside the default webforJ configuration directory, you can configure the license directory with [`webforj.license.cfg`](./properties#configuration-options).
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading