Documentation

The Desktop Startup framework implements the startup logic of the Shotgun Desktop. Its main function is to:

1. initialize the browser integration
2. log the user in
3. download Toolkit
4. configure the site configuration
5. auto update itself and the site configuration when necessary
6. launch the tk-desktop engine.

This is an internal Toolkit framework and therefore the interface it implements is subject to change. We advise that you do not use this framework in your projects.

Maintaining the repo

This framework integrates code from tk-core and tk-framework-desktopserver. Integrating a new version of the core or the framework can be done using the tk_core_update.sh and tk_framework_desktopserver_update.sh scripts respectively. Both need to be invoked with a GitHub tag name in order to update to a specific release.

Auto-updates

This framework auto-updates itself and the auto-updates are installed inside the user directory. Here's the location for each platform:

Windows: %APPDATA%\Shotgun\desktop\install\frameworks\app_store\tk-framework-desktopstartup\vX.Y.Z
MacOSX: ~/Library/Caches/Shotgun/desktop/install/frameworks/app_store/tk-framework-desktopstartup/vX.Y.Z
Linux: ~/.shotgun/desktop/install/frameworks/app_store/tk-framework-desktopstartup/vX.Y.Z

Debugging

There are a lot of environment variables that can be set for debugging. You can either set them on the command line or you can set them inside a special debugging file called debug.ini. They are documented here.

Here's the location of the debug.ini file for each platform:

Windows: %APPDATA%\Shotgun\desktop\config\debug.ini
MacOSX: ~/Library/Caches/Shotgun/desktop/config/debug.ini
Linux: ~/.shotgun/desktop/config/debug.ini