Docs
/
Core Concepts
/
Remote Caching (Beta)

Remote Caching

A major key 🔑 to Turborepo's speed is that it is both lazy and efficient—it does the least amount of work possible and it tries to never redo work that's already been done before.

At the moment, your Turborepo caches your tasks on your local filesystem (i.e. "single-player mode," if you will). However, what if there was a way to take advantage of the computational work done by your teammates or your CI (i.e. "co-op multiplayer mode")?

What if there was a way to teleport and share a single cache across machines? Almost like a "Dropbox" for your Turborepo cache.

Remote Caching has entered the chat.

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines for an additional speed boost. This is possible because Turborepo uses content addressable storage.

Remote Caching is a powerful feature of Turborepo, but with great power comes great responsibility. Make sure you are caching correctly first and double check handling of environment variables. Please also remember Turborepo treats logs as artifacts, so be aware of what you are printing to the console.

Vercel

For Local Development

If you want to link your local turborepo to your Remote Cache you do so by first authenticating the Turborepo CLI with your Vercel account:

npx turbo login

Next, you can link your turborepo to your remote cache by running the following command:

npx turbo link

Once enabled, make some changes to a package or application you are currently caching and run tasks against it with turbo run. Your cache artifacts will now be stored locally and in your Remote Cache.

To verify, delete your local Turborepo cache with:

rm -rf ./node_modules/.cache/turbo

Then run the same build again. If things are working properly, turbo should not execute tasks locally, but rather download both the logs and artifacts from your Remote Cache and replay them back to you.

Remote Caching on Vercel Builds

If you are building and hosting your apps on Vercel, then Remote Caching will be automatically set up for you on your behalf once you use turbo. You need to update your build settings to build with turbo.

Please refer to the Vercel documentation for instructions.

Artifact Integrity and Authenticity Verification

You can enable Turborepo to sign artifacts with a secret key before uploading them to the Remote Cache. Turborepo uses HMAC-SHA256 signatures on artifacts using a secret key you provide. Turborepo will verify the remote cache artifacts' integrity and authenticity when they're downloaded. Any artifacts that fail to verify will be ignored and treated as a cache miss by Turborepo.

To enable this feature, set the remoteCache options on your turbo config to include signature: true. Then specify your secret key by declaring the TURBO_REMOTE_CACHE_SIGNATURE_KEY environment variable.

{
  "$schema": "https://turborepo.org/schema.json",
  "remoteCache": {
    // Indicates if signature verifcation is enabled.
    "signature": true
  }
}

Custom Remote Caches

You can self-host your own Remote Cache or use other remote caching service providers as long as they comply with Turborepo's Remote Caching Server API.

You can set / control the remote caching domain by specifying the --api and --token flags, where --api is the hostname and --token is a bearer token.

turbo run build --api="https://my-server.example.com" --token="xxxxxxxxxxxxxxxxx"

You can see the endpoints / requests needed here.

Last updated on April 27, 2022