Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

Latest commit

 

History

History
70 lines (43 loc) · 1.96 KB

deploy.rst

File metadata and controls

70 lines (43 loc) · 1.96 KB

Deploy

Deploying the Framework locally

After you have built, copy the plugin directory that is output in /build for each Framework plugin, to the ftrack Connect plugin path (or to a location pointed to by the FTRACK_CONNECT_PLUGIN_PATH):

  • Windows; %LOCALAPPDATA%\ftrack\ftrack-connect-plugins
  • Mac OSX; ~/Library/Application Support/ftrack-connect-plugins
  • Linux; ~/.local/share/ftrack-connect-plugins

Finalise by restarting Connect and DCC(s) to have the newly built integrations discovered.

Important

This is no need to restart Connect on a rebuild if the the version number is the same, in that case only a relaunch of DCC is required.

Building and deploying Connect centrally

To minimise IT administrative tasks, one could build Connect and launch it from a central location within a new or existing Python environment.

The process is documented in the :ref:`ftrack Connect documentation <ftrack-connect:developing>`, a short summary:

Run:

pip install .

or:

python setup.py install

A Connect executable is then compiled, which can be set to run a login time on workstations and be wrapped with a proper launcher having an icon.

Deploying Framework centrally

To have Connect pickup your custom built Framework plugins, build and deploy them to a central network location, for example:

\\filesrv\nas\pipeline\connect

Then on workstations set the environment variable to point at this location:

set|export FTRACK_CONNECT_PLUGIN_PATH=\\filesrv\nas\pipeline\connect

Finally install and launch Connect, remember to remove any locally installed Framework plugins to prevent conflict.