Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated JNLP runner docs for new release #210

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
Binary file modified sites/labs/public/assets/jnlp-screenshots/homescreen.png
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.
Binary file modified sites/labs/public/assets/jnlp-screenshots/license_key.png
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.
Binary file modified sites/labs/public/assets/jnlp-screenshots/license_token.png
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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions sites/labs/src/components/ExtensionPayment.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
import Shell from "@leaningtech/astro-theme/layouts/Shell.astro";
import { products } from "@leaningtech/astro-theme/products";
import { Image } from "astro:assets";
import { type Product } from "../../../../packages/astro-theme/lib/nav.ts";

interface Props {
productId: Product;
formUrl: string;
}

const { productId, formUrl } = Astro.props;
const product = products[productId];
---

<Shell title=`${product.name} Payment`>
<main
class="flex flex-col justify-center items-center flex-grow w-full max-w-screen-2xl mx-auto px-6 py-10 overflow-hidden"
>
<div class="flex justify-between items-center w-4/5 max-w-6xl p-4">
<div class="w-1/2 p-4 box-border">
<div class="mb-6">
<a href={product.href} target="_blank">
<Image src={product.logotype} alt={product.name} class="w-4/5" />
</a>
</div>
<h2 class="text-3xl font-bold mb-4">Purchase Your License</h2>
<p class="text-base">
Complete the purchase to get your license key. Once you have completed
the purchase, you will receive an email with the license key.
</p>
<br />
<p class="text-base">
Activate your license key
<a
href="chrome-extension://aklbimhnkloeefmeobindhkbpncelbmg/license.html"
target="_blank"
class="text-white hover:text-gray-300 font-bold">here.</a
>
Comment on lines +34 to +39
Copy link
Member

Choose a reason for hiding this comment

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

Careful here, the url points to a local installation of the JNLPRunner and not the version in the webstore. In general I don't think it's a smart idea to link to an extension page like this. We could say something like, enter the key in the "manage license" section of the installed JNLPRunner extension and also link to the docs that explain how to activate a license.

</p>
</div>
<div class="w-1/2 p-4 box-border">
<!-- <iframe class="w-full h-[600px] border-none" src={formUrl}> </iframe> -->
Copy link
Member

Choose a reason for hiding this comment

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

Comment can be removed.

<script
id="fsc-api"
src="https://sbl.onfastspring.com/sbl/1.0.1/fastspring-builder.min.js"
type="text/javascript"
data-storefront={formUrl.toString()}></script>
<div id="fsc-embedded-checkout-container"></div>
<script type="text/javascript">
fastspring.builder.add("cheerpj-jnlp-runner");
</script>
</div>
</div>
</main>
</Shell>
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is important to explain at the beginning of this guide that there are two ways to do the license activation and that they are mutually exclusive. Then direct the user to the section that they need to follow. Otherwise they may think it is required to do both methods.

Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,40 @@ description: Activate your extension license

This tutorial will guide you step by step on how to activate your JNLP Runner extension license.

## Step 1
## Activation via license key

The first time you launch a JNLP file to run a Java application, the JNLP Runner will automatically detect it and it will start running. The first screen you will see is the license agreement. Please read this carefully and if you agree with the terms and conditions, click on _**Accept license**_.
### Step 1

<div class="mx-24">![](/assets/jnlp-screenshots/license_agreement.png)</div>
In order to activate your license, click on the _**Manage License**_ button on the extension's home screen or the popup.

## Step 2
<div style="display: flex; justify-content: center; gap: 24px; width: 50%; margin: 0 auto;">
<img
src="/assets/jnlp-screenshots/homescreen_annotated.png"
alt="Home screen"
/>
<img src="/assets/jnlp-screenshots/popup_annotated.png" alt="Popup" />
</div>

After accepting the license, you will be asked for a _**license key**_ or _**license token**_ in order to activate your license.
Once you click on the _**Manage License**_ button, you will be redirected to the license activation screen. Here you can enter your license key or license token. Click on the link to purchase a license key.

### Free trial license key
<div class="mx-24">![](/assets/jnlp-screenshots/license_key_annotated.png)</div>

You can obtain your **license key** via email after registering your free trial. Please click on the link _**start your free trial**_ where you will be redirected to the [_**Leaning Technologies shop**_](https://leaningtech.onfastspring.com/cheerpj-jnlp-runner) where you can request your license key.
### Step 2

<div class="mx-24">![](/assets/jnlp-screenshots/license_key.png)</div>
You will be redirected to the [_**Leaning Technologies shop**_](/payment-jnlp) where you can request your license key.

### Offline activation via License Token
<div class="mx-24">![](/assets/jnlp-screenshots/purchase_license.png)</div>

If you already have a **license token**, please click on _**Offline activation via License Token**_ and enter your valid token.
Once the purchase is complete, the license key will be displayed on the screen. You will also receive an email with the license key. Copy the license key and paste it into the license key field.

<div class="mx-24">![](/assets/jnlp-screenshots/license_token.png)</div>
### Step 3

Click on the _**Validate**_ button to validate your license key. If your license key is valid, you will see a success message.

<div class="mx-24">![](/assets/jnlp-screenshots/valid_license.png)</div>

## Step 3
## Offline activation via License Token

If your license key or license token is valid, you will be able to continue using the extension under the agreed terms and conditions. Please visit the next tutorial [_using the JNLP Runner for the first time._](/cheerpj-jnlp-runner/getting-started/using-first-time)
If you have been provided with a license token, you can activate your license offline. Click on the _**License Token activation**_ link, enter your license token and click on the _**Validate Token**_ button.

<div class="mx-24">![](/assets/jnlp-screenshots/license_token.png)</div>
Copy link
Member

Choose a reason for hiding this comment

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

We should also add a section on the popup and that you can drag and drop a jnlp file there.

Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,24 @@ title: Using the extension for the first time
description: Tutorial for first-time users
---

This tutorial will guide you on the basic functionalities of the JNLP Runner extension. We assume you have installed the extension on [Chrome](/cheerpj-jnlp-runner/getting-started/install-chrome) or [Edge](/cheerpj-jnlp-runner/getting-started/install-edge) and you have already [activated your license](/cheerpj-jnlp-runner/getting-started/licensing).
This tutorial will guide you on the basic functionalities of the JNLP Runner extension. We assume you have installed the extension on [Chrome](/cheerpj-jnlp-runner/getting-started/install-chrome) or [Edge](/cheerpj-jnlp-runner/getting-started/install-edge).

### Before using the extension

The first time you launch a JNLP file to run a Java application, the JNLP Runner will automatically detect it and it will start running. The first screen you will see is the license agreement. Please read this carefully and if you agree with the terms and conditions, click on _**Accept license**_.

<div class="mx-24">![](/assets/jnlp-screenshots/license_agreement.png)</div>
Comment on lines +6 to +12
Copy link
Member

Choose a reason for hiding this comment

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

We should also link to the actual license here -> https://cheerpj.com/cheerpj-jnlp-runner-end-user-licence-agreement/


## The home screen

When the JNLP Runner extension detects that a JNLP file has been triggered it will show the screen below in a new tab. This screen displays a few options alongside the license's owner and the JNLP filename.

<div class="mx-24">![](/assets/jnlp-screenshots/homescreen.png)</div>

### Manage license button

Click on this button to activate your license key or token. For more information, check the [Activate your license](/cheerpj-jnlp-runner/getting-started/activate-license) tutorial.

Comment on lines +20 to +23
Copy link
Member

Choose a reason for hiding this comment

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

I would change the wording of button to link, since it currently does not really look like a button.
The url to activate-license does not work, I think the file is currently just called licensing

### Start application button

If this button is selected, the JNLP Runner will start executing your Java application, you will see a loading screen and after just a few seconds you will see your application running in the browser.
Expand Down
4 changes: 4 additions & 0 deletions sites/labs/src/content/docs/cheerpj-jnlp-runner/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ To get started with CheerpJ JNLP Runner, you need to install the extension from

Once installed, you can run Java Applets on any website. Visit our [using the extension for the first time] page for more information.

## Licensing

CheerpJ is free for personal use and technical evaluation. See [licensing](/docs/cheerpj-jnlp-runner/licensing) for details.

## Community

We have an amazing community of developers and users.
Expand Down
48 changes: 48 additions & 0 deletions sites/labs/src/content/docs/cheerpj-jnlp-runner/licensing.mdx
Copy link
Member

Choose a reason for hiding this comment

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

At the end of the licensing part we should also link to the licensing agreement -> https://cheerpj.com/cheerpj-jnlp-runner-end-user-licence-agreement/
We also do that in the CheerpX docs like this:
For any doubt, please check the [Complete License](https://cheerpj.com/cheerpj-jnlp-runner-end-user-licence-agreement/).

Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Licensing
---

The CheerpJ JNLP Runner extension is free to use for non-business purposes on public-network JNLP applications.

- **Free** usage applies to:
- Individuals using the extension for personal or non-commercial projects.
- Publicly accessible JNLP applications that are not associated with a business or organisation.
- Business, corporate, and public-sector organisations:
- Free for [technical evaluations](#technical-evaluations) or testing purposes.
- Requires a [commercial license][licensing] for any other use.
- Academic and non-profit organisations: [please enquire for eligibility][contact]

## Examples

- Example 1: You are an individual using the extension to run a public-facing educational JNLP application. **Free license**.
- Example 2: You are a student using the extension to run JNLP applications for a personal project. **Free license**.
- Example 3: You are an individual within a company, using the extension to access an internal or customer-facing JNLP application. [Requires a commercial license][licensing].
- Example 4: You are working within a public-sector organisation, and using the extension to access an internal applet. [Requires a commercial license][licensing].
- Example 5: You are a developer in a company evaluating the extension for future use of CheerpJ. **Free license (evaluation only).**
- Example 6: You are a business that wants to self-host the CheerpJ JNLP Runner instead of relying on the hosted service. [Requires a self-hosting license][contact].

## Technical evaluations

A technical evaluation refers to any scenario where the JNLP application is not actively being used in production, such as:

- Testing JNLP applications on non-public systems.
- Evaluating compatibility with the extension for a potential project.

This does not include:

- Active use of the extension in internal systems by employees or users.

## Self-hosting

If you wish to self-host CheerpJ JNLP Runner, you will need a dedicated license. [Contact us][contact] for more information.

### System Integrators (SIs), Resellers, Distributors, and OEMs

Please [contact us directly][contact] to discuss OEM or Reseller licences.

---

If you are not sure whether you require a license, [contact us][contact].

[licensing]: /cheerpj-jnlp-runner/getting-started/licensing
[contact]: https://cheerpj.com/contact/
8 changes: 8 additions & 0 deletions sites/labs/src/pages/payment-jnlp.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
import ExtensionPayment from "../components/ExtensionPayment.astro";
---

<ExtensionPayment
productId="cheerpj-jnlp-runner"
formUrl="leaningtech.onfastspring.com/embedded-storefront"
/>