Documentation

This document covers how the Shotgun Desktop startup sequence can be configured.

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.

Configuration

The config.ini file allows you to tweak login behaviour as well as how the browser integration is configured. This is entirely optional and in most cases you shouldn't need to edit this.

Here's a config.ini sample with documentation about what each setting means.

# Login related settings
[Login]
# Default login to display in the login dialog for a user who never logged into the Shotgun Desktop. Defaults to the current users's OS login.
default_login=some_name
# Default site to display in the login dialog for a user who never logged into the Shotgun Desktop. Defaults to https://mystudio.shotgunstudio.com
default_site=https://jf.shotgunstudio.com
# Proxy server to use when connecting to Shotgun. You can optionally specify a username and password to the proxy using the username:password@address syntax.
http_proxy: 127.0.0.1

# Browser integration related settings
[BrowserIntegration]
# Power-user only. When set to 1, this allows the browser integration to output text to the Shotgun Desktop's log file. Defaults to 0.
debug: 0
# When set to 0, this setting disables the browser integration. Defaults to 1.
enabled: 1
# Port to listen for requests from the browser. Defaults to 9000.
port: 9001
# List of sites that can connect to this server. Defaults to *.shotgunstudio.com.
whitelist: *.shotgunstudio.com

The file is searched for in multiple locations and in the following order:

1. Inside the user folder
   • Windows: %APPDATA$\Shotgun\desktop\config\config.ini
   • MacOSX: ~/Library/Caches/Shotgun/desktop/config/config.ini
   • Linux: ~/.shotgun/desktop/config/config.ini
2. An environment variable named SGTK_DESKTOP_CONFIG_LOCATION that points to the config.ini file.
   • For example, on Windows you would set the following: set SGTK_DESKTOP_CONFIG_LOCATION=C:\path\to\the\config.ini

Note that you can also save the config.ini file inside in application directory, but this location is deprecated and you should use the two others means described above. Specifically on MacOS, adding a file inside the installation directory invalidates the package's signature, which will result in a prompt from the firewall when the Shotgun Desktop launches since MacOS can't certify that the package hasn't been altered by a malicious program.

If you still wish to put your configuration file in the application directory, the file must be inside Content/Resources on MacOSX and next to the Shotgun executable on Windows and Linux.