Skip to content

Commit

Permalink
docs: clarify login url usage (vercel#9963)
Browse files Browse the repository at this point in the history
### Description

Clarifying that you don't need the login configurations, flags,
environment variables, etc. unless you're building a server-side
solution that can dynamically generate tokens.

### Testing Instructions

👀
  • Loading branch information
anthonyshew authored and joshnuss committed Feb 15, 2025
1 parent e262569 commit 1940ae7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
12 changes: 10 additions & 2 deletions docs/repo-docs/reference/link.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,22 @@ The selected owner (either a user or an organization) will be able to share [cac

Specifies the URL of your Remote Cache provider.

```bash title="Terminal"
turbo link --api=https://example.com
```

### `--yes`

Answer yes to all prompts

```bash title="Terminal"
turbo link --yes
```

### `--scope <scope>`

The scope, i.e. Vercel team, to which you are linking
The scope to which you are linking. For example, when using Vercel, this is your Vercel team's slug.

```bash title="Terminal"
turbo link --api https://acme.com
turbo link --scope=your-team
```
2 changes: 1 addition & 1 deletion docs/repo-docs/reference/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ turbo login --api=https://acme.com/api

### --login \<url>

Set the URL for login requests. This is only required for platforms with robust login features.
Set the URL for login requests that should dynamically generate tokens.

```bash title="Terminal"
turbo login --login=https://acme.com
Expand Down
3 changes: 2 additions & 1 deletion docs/repo-docs/reference/system-environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ System environment variables are always overridden by flag values provided direc
</td>
<td>
Set the URL used to log in to{' '}
<a href="/repo/docs/core-concepts/remote-caching">Remote Cache</a>.
<a href="/repo/docs/core-concepts/remote-caching">Remote Cache</a>. Only
needed for self-hosted Remote Caches that implement an endpoint that dynamically creates tokens.
</td>
</tr>
<tr id="turbo_no_update_notifier">
Expand Down

0 comments on commit 1940ae7

Please sign in to comment.