Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Studio deployment

If your IT department already packages Reaper scripts for its workstations (with WAPT, Intune, Jamf, or any other deployment system), it can license them the same way. Add one small file, deployment.json, to the package. Each workstation then activates the products you choose from your studio's license key in the background the first time someone runs an nvk script. Staff don't enter a key, start a trial, or open a browser.

How it works​

  • The file contains your studio's license key and the list of products each workstation should use. A key covers the purchase it came with, so if the products were bought separately, the file lists each purchase's key.
  • All the keys in one file must come from the same purchase email. If your studio's products are spread across more than one purchase email, email support@nvk.tools before you deploy.
  • On first launch, each workstation activates those products for itself. It uses one of the computers allowed on that product's seats, and only the products in the file. Other products on the same key stay free for other workstations.
  • Other people using the same workstation, reinstalls, and script updates all share that workstation's activation. They don't use more computers.
  • If a product has no free place, that workstation reports it. Other workstations are never deactivated to make room.

Each purchased seat allows up to five computers at the same time.

1. Create the deployment file​

The easiest way is the nvk_SHARED - License Manager action:

  1. In Reaper, run nvk_SHARED - License Manager from the action list.
  2. Open the Studio deployment section near the bottom of the window.
  3. Paste your studio's license key. If the products were bought separately, add each other purchase's key under Keys of other purchases, one per line.
  4. Tick the products every workstation in this group should use.
  5. Leave the revision at 1 for a first deployment, then click Save deployment file….

You can also write the file by hand. It's plain JSON with these four properties:

deployment.json
{
"version": 1,
"license_key": "XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX",
"products": ["nvk_THEME"],
"revision": 1
}

When the products come from more than one purchase, add the other keys as "license_keys": ["XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"], after license_key. It holds up to fifteen keys.

products lists one or more of these product identifiers:

ProductIdentifier
nvk_CREATEnvk_CREATE
nvk_WORKFLOW (nvk_FOLDER_ITEMS, nvk_SUBPROJECT, nvk_TAKES)nvk_WORKFLOW
nvk_NAVIGATEnvk_NAVIGATE
nvk_SIGNALnvk_SIGNAL
nvk_VARIATIONSnvk_VARIATIONS
nvk_AUTODOPPLERnvk_AUTODOPPLER
nvk_LOOPMAKERnvk_LOOPMAKER
nvk_THEMEnvk_THEME

nvk_SEARCH is free and needs no entry. A file with an unknown property or product, a repeated product, or a malformed key is rejected as a whole. That workstation then reports an invalid deployment file and activates nothing.

To give different groups different products, for example nvk_THEME for everyone and nvk_CREATE only for sound designers, build a separate file for each deployment group.

2. Install it on each workstation​

Put the file in the all-users location. Your deployment system can install it as SYSTEM or an administrator. The first staff member to run an nvk script activates the workstation from their own account.

OSAll usersOne user only
Windows%PROGRAMDATA%\nvk\deployment.json%LOCALAPPDATA%\nvk\deployment.json
macOS/Library/Application Support/nvk/deployment.json~/Library/Application Support/nvk/deployment.json
Linux/etc/nvk/deployment.json~/.local/share/nvk/deployment.json

If a user has their own file, it takes precedence over the all-users file. The file isn't read from Reaper's resource folder.

The file contains your license key

Let staff read it, but only IT and administrators change it. On Windows, set the folder's permissions for the staff group. On macOS and Linux, use your managed group and file permissions. Keep the file out of public repositories, logs, and support emails, and leave it installed so new user profiles can activate.

3. Launch​

Each workstation needs an internet connection the first time it activates. Activation runs in the background while an nvk script with a window, or the License Manager, is open. Nothing slows down Reaper's startup. A workstation that starts offline activates the next time it's online.

The License Manager on a workstation shows how setup went, including any product that isn't owned by the key or has no free place.

Changing products or re-enrolling a computer​

Workstations only act on a file whose revision is new to them. Increase revision by one whenever you:

  • change the key or the product list,
  • want a workstation to try again after you've fixed ownership or freed a place, or
  • want to re-enroll a workstation that was deactivated.

In the License Manager, Open existing file… loads your last file at its next revision. Every deployment group that targets the same computer must use the same product list for a given revision, and a revision never goes back down.

Removing a product from the file, or removing the file, doesn't deactivate anything. To free a workstation's place, run nvk_SHARED - License Manager on it and choose Deactivate this computer…, or email support@nvk.tools. A deactivated workstation stays deactivated until you install a file with a higher revision.

Computers without internet​

Studio deployment needs each workstation to connect once. For workstations that can never connect, email support@nvk.tools with the number of workstations and the products they need.