Skip to content

MacOS

This page contains the description for installation of the MacOS version of vinkvfxls. To make the guide easier to understand, the name vinkvfxls is used as this is also the name of the application. vinkvfxls means Vink VFX License Server.

Download

First, make sure you download the latest version of vinkvfxls at the downloads page:

Downloads

Installation

Once downloaded and extracted, you will find the installer called as vinkvfxls-{version}-macos.run (or for ARM vinkvfxls-{version}-macos_arm.run)

Hashes

For safety it is recommended to verify if the hashes match with the INSTALL.md file. The command to check the hashes is provided in there.

You might need to run the commands with sudo. Or choose a directory where you have permissions to write to.

In here, I've chosen to install it in /opt/vinkvfxls. But this can be any directory. Just be sure to change the commands to the directory you've chosen.

Then run the installer with these commands (I just assume the version we are installing is v1.0.0, make sure to change it):

tar -xf vinkvfxls-v1.0.0-linux.tar.gz
chmod +x vinkvfxls-v1.0.0-linux.run
vinkvfxls-v1.0.0-linux.run --prefix=/opt

Optionally, but recommended: create symlink to make the vinkvfxls command available globally: 

ln -fs /opt/vinkvfxls/bin/vinkvfxls /usr/local/bin/vinkvfxls

You can see the entire process here. You can pause and copy right from this window the commands necessary.

Confirm

You can verify that the installation is installed correctly by just running the vinkvfxls command: 

vinkvfxls --help

Which will return the help menu: 

License server for Vink VFX software.

Usage: vinkvfxls [OPTIONS]

Options:
  -c, --configure            Start the configure panel
  -l, --logs                 Fetch the logs
  -s, --status               Collect the system status
  -m, --manage-licenses      Start the license management utility
  -r, --reset-configuration  Reset the configuration file if problems have occurred. Will not delete license data.
  -h, --help                 Print help
  -V, --version              Print version

Service

A service file has been added as well to the installation, to make it easy to setup the license server to automatically start on boot. Navigate to the installation directory and run the svc.sh script.

Installation order

Make sure to set-up the licenses first before installing the service. As the license server will exit immediately if there are no licenses installed.

It has a few options:

  • --install: setup the svc service
  • --start: enable and start the service
  • --status: fetch status of the service
  • --stop: disable and stop the service
  • --uninstall: stop and uninstall the service.
sudo /opt/vinkvfxls/svc.sh --install

Next up

If installation succeeded, continue to the Quickstart for usage of the CLI and installation of the licenses.