License Usage Guide

Obtaining the License File

1. Go to the License Management page and click "Try Business Version For Free". Click "Download License" to obtain the license file.
   Note: You need to be logged in to start the trial. If you don't have an account, the system will create one for you upon your first login.

Replacing the License File

1. After unzipping the downloaded license-univer.zip file, you will get license.txt and licenseKey.txt files. Please keep these two files safe and ensure that you do not modify their format or content.

Backend Service

• Use docker-compose

Copy the license.txt and licenseKey.txt files to the /docker-compose/configs/ directory.
Run the service script bash run.sh in the docker-compose directory to restart the universer service.

• Use Kubernetes

execute

helm upgrade --install -n univer --create-namespace \
    --set global.istioNamespace="univer" \
    --set-file universer.license.licenseV2=$(YOUR_LICENSE_TXT_PATH) \
    --set-file universer.license.licenseKeyV2=$(YOUR_LICENSE_KEY_TXT_PATH) \
    univer-stack oci://univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/helm-charts/univer-stack

Frontend SDK

1. In addition to importing the univer plugin in your project, also import the license plugin. For specific plugin import methods, please refer to here.

import { UniverLicensePlugin } from '@univerjs-pro/license';

2. Register the UniverLicensePlugin plugin. Make sure this plugin is registered first after the univer instance is initialized, as shown in the image below. Then paste the content of the license.txt file into the license parameter of the plugin.

univer.registerPlugin(UniverLicensePlugin, {
  license: `Content of your license.txt file`
});

Verifying the License File

After successfully replacing the frontend and backend license files and restarting the service, please follow these steps to verify that the service is running normally and the license has been successfully loaded.

Backend Service

1. Visit host:8000/universer-api/license/key to view the license entitlement information.
   For example: If your service is running locally, please visit http://localhost:8000/universer-api/license/key.

verify:true // License verification result
release_type:COMMERCIAL // License type

Frontend SDK

1. After injecting the License into the frontend and starting the project, you can verify whether the License is valid and being used correctly.
   Note: If no license is entered, or if the entered license is invalid (e.g., expired or incorrect content), some features will be restricted, and a watermark will be displayed on the page.

2. With a valid license entered, the project will run normally without restrictions.

At this point, we have completed the installation and verification of the Univer Business Version. Next, you can read the official documentation to learn more about its features and usage methods to help integrate it into your application. Enjoy using Univer!