Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remote Cache API doc. #7236

Merged
merged 4 commits into from
Feb 2, 2024
Merged

Remote Cache API doc. #7236

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2b12ab
Improve documentation for Remote Cache API.
anthonyshew Jan 23, 2024
0bccfb7
fix
anthonyshew Feb 2, 2024
655f609
Tweaks.
anthonyshew Feb 2, 2024
da583f1
Merge branch 'main' into remote-cache-api-doc
anthonyshew Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/pages/repo/docs/core-concepts/remote-caching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,24 @@ To enable this feature, set the `remoteCache` options on your `turbo.json` confi
}
```

## Custom Remote Caches
## Remote Caching API

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.
A Remote Cache can be implemented by any HTTP server that meets Turborepo's Remote Caching API specification.

You can set the remote caching domain by specifying the `--api` and `--token` flags, where `--api` is the hostname and `--token` is a bearer token.
### Managed Remote Cache with Vercel

[Vercel](https://vercel.com), the creators and maintainers of Turborepo, provide a managed Remote Cache that is fully compatible with Turborepo.

Using [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching) is zero-configuration and automatically integrates with [Vercel deployments](https://vercel.com/docs/deployments/overview) through the open-source [Vercel Remote Cache SDK](https://github.com/vercel/remote-cache).

Learn more about [Turborepo on Vercel](https://vercel.com/docs/monorepos/turborepo) or [deploy a template for free](https://vercel.com/templates?search=turborepo) to try it out.

### Self-hosting

You can also self-host your own Remote Cache and set the remote caching domain by specifying the `--api` and `--token` flags, where `--api` is the hostname and `--token` is a bearer token.

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

You can see the endpoints / requests [needed here](https://github.com/vercel/turbo/blob/main/crates/turborepo-api-client/src/lib.rs).
You can [find the OpenAPI specification for the API here](/api/remote-cache-spec). At this time, all versions of `turbo` are compatible with the `v8` endpoints.
Loading