Configuration

This section provides information about how to configure the following for the Package Manager:

• Network configuration: how to get around a firewall and how to set up a proxy server.
• Scoped registry authentication: how to create and provide Package Manager with an authentication token for any scoped package registry servers that require it.
• Package cache sharing: how to override the location of the global cache folders.

In addition, you can find the location of the Package Manager configuration files under Configuration files.

Customizing the shared cache locations

By default, the Package Manager uses this folder structure for its caches:

<global-cache-root>
  ├── npm
  │   └── <registry data (package metadata and tarballs)>
  ├── packages
  │   └── <uncompressed contents of package tarballs>
  └── git-lfs (if enabled)
       └── <downloaded Git LFS files>

To override the default location of the Package Manager’s global cache root, you can use either the cacheRoot property in the user configuration file or set the UPM_CACHE_ROOT environment variable.

Note: Consider using the configuration file strategy for macOS and Linux systems, because it can be hard to launch Unity with environment variables if you’re not on Windows.

You can also set environment variables to override the registry data cache, the uncompressed packages cache, or the Git LFS cache. However, environment values and configuration file properties are not equivalent, so using different methods to configure settings can produce unexpected results.

There are many factors affecting how the levels and setting methods work together:

• If you set different values for the global cache root with both the UPM_CACHE_ROOT environment variable and the cacheRoot property, Package Manager uses the location in the UPM_CACHE_ROOT environment variable.
• If you set an environment variable for the registry data cache (UPM_NPM_CACHE_PATH), the uncompressed packages cache (UPM_CACHE_PATH), or the Git LFS cache (UPM_GIT_LFS_CACHE_PATH), Package Manager uses the new location, regardless of where the global cache root is.
• When you use a user configuration file, the change is applied to the current user account.
• If you enable the Git LFS cache (UPM_ENABLE_GIT_LFS_CACHE) without explicitly setting its path (UPM_GIT_LFS_CACHE_PATH), Package Manager uses the git-lfs folder under the global cache root as its location.

Using a configuration file

Follow these instructions to override the location of the global cache root:

1. Locate the .upmconfig.toml user configuration file. If the file doesn’t exist, create an empty text file.

2. Add the cacheRoot key and set its value as an absolute path to a custom location. Important: When setting Windows paths in TOML files, use forward slashes (/) or double backslashes (\\). Don’t use single backslashes (\) because they’re special characters which mark escape sequences and can cause TOML parsing errors.

   Windows example

   cacheRoot = "E:\\Unity\\cache"
   

   macOS and Linux example

   cacheRoot = "/dev/external/shared/Unity/cache"
   

You don’t need to restart the Unity Editor or the Hub after setting the cacheRoot key for the change to take effect.

Using environment variables

You can use environment variables to configure several settings for the Package Manager. However, in order for these settings to apply, you have to launch Unity or the Hub from a terminal or command prompt where those environment variables have been defined and exported every time.

For example, you can run these commands in a macOS or Linux terminal to configure the location of the global cache root and enable the Git LFS cache:

# On macOS/Linux:
export UPM_CACHE_ROOT=/dev/ssd/shared/Unity/cache
export UPM_ENABLE_GIT_LFS_CACHE=true
echo "Launching Unity with the Git LFS cache enabled and using this global cache location: '$UPM_CACHE_ROOT'"
"/Applications/Unity Hub.app/Contents/MacOS/Unity Hub"

This Windows example configures the location of the global cache root:

# On Windows:
set UPM_CACHE_ROOT=%ALLUSERSPROFILE%\Unity\cache
echo "Launching Unity with this global cache location: '%UPM_CACHE_ROOT%'"
"C:\Program Files\Unity Hub\Unity Hub.exe"

You can use the UPM_CACHE_ROOT environment variable to override the location of the global cache (the root folder containing the registry data and uncompressed packages caches).

The following environment variables are available:

Configuration files

Package Manager supports two configuration files: a global configuration file and a user configuration file. Both of these files use the TOML format and they appear in different locations:

• Global configuration files apply to all users on the machine. For example, you can define additional SSL certificate authorities when setting up a proxy server for the entire machine.
• User configuration files apply to a single user. For example, you can set up authentication tokens to use for custom package registry servers that you access with scoped registries. These tokens authenticate a specific user account.

Global configuration file location

Package Manager uses a global configuration file named upmconfig.toml. This file isn’t created when you install the Unity Hub or Editor, but you can create it in the following location if you need to customize your configuration:

User configuration file location

Package Manager uses a user configuration file named .upmconfig.toml. This file isn’t created when you install the Unity Hub or Editor, but you can create it in the following location if you need to customize your configuration:

• Setting the global cache root now supported in Package Manager configuration files in Unity 2021.2 NewIn20212