Skip to content

Commit

Permalink
Merge pull request #2819 from neondatabase/dprice-vercel-doc-updates
Browse files Browse the repository at this point in the history
docs: vercel doc updates
  • Loading branch information
danieltprice authored Jan 22, 2025
2 parents 86f6b4b + 4c99f54 commit 89511e7
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
3 changes: 2 additions & 1 deletion content/docs/guides/vercel-native-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ POSTGRES_PRISMA_URL

## Limitations

When using the Neon Postgres Native Integration, installing the [Neon Postgres Previews Integration](/docs/guides/vercel-previews-integration) on the same Vercel Project is not supported.
- When using the Neon Postgres Native Integration, installing the [Neon Postgres Previews Integration](/docs/guides/vercel-previews-integration) on the same Vercel Project is not supported.
- To use the Neon CLI with the Neon Postgres Native Integration, you must authenticate connections from the CLI client using a Neon API key. Please see [Neon CLI — API keys](/docs/reference/cli-install#api-key). The `neon auth` command requires an account registered through Neon rather than Vercel.

<NeedHelp/>
1 change: 1 addition & 0 deletions content/docs/guides/vercel-postgres-transition-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ The transition to Neon also unblocks several limitations:
- **Terraform support**. The [Vercel Terraform Provider](https://vercel.com/guides/integrating-terraform-with-vercel) did not support Vercel Postgres. With Neon Postgres, you have access to a [Neon Terraform provider](/docs/reference/terraform).
- **Larger computes**. On Vercel, databases on Hobby plans are limited to 0.25 logical CPUs. The Neon Free plan supports computes up to 2 vCPUs and [Autoscaling](/docs/introduction/autoscaling). Neon paid plans support much larger compute sizes.
- **Postgres roles**. On Vercel, you were limited to a single Postgres database access role. There is no such limit on Neon. You can create additional Postgres roles as needed.
- **Point-in-time restore**. In Vercel Postgres, Neon's history retention is set to 0, which means point-in-time restore is not possible. On Neon, the default setting is 1 day, and you can configure longer periods on Neon's paid plans.

### What Postgres versions are supported?

Expand Down
4 changes: 4 additions & 0 deletions content/docs/reference/cli-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ The command launches a browser window where you can authorize the Neon CLI to ac
/home/<home>/.config/neonctl/credentials.json
```

<Admonition type="note">
If you use Neon through the [Native Integration on Vercel](/docs/guides/vercel-native-integration), you must authenticate connections from the CLI client using a Neon API key (see below). The `neon auth` command requires an account registered through Neon rather than Vercel.
</Admonition>

An alternative to authenticating using `neon auth` is to provide an API key when running a CLI command. You can do this using the global `--api-key` option or by setting the `NEON_API_KEY` variable. See [Global options](/docs/reference/neon-cli#global-options) for instructions.

<Admonition type="info">
Expand Down
4 changes: 4 additions & 0 deletions content/docs/reference/cli-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,10 @@ neonctl auth

The [neonctl auth](/docs/reference/cli-auth) command launches a browser window where you can authorize the Neon CLI to access your Neon account. If you have not authenticated previously, running a Neon CLI command automatically launches the web authentication process unless you have specified an API key.

<Admonition type="note">
If you use Neon through the [Native Integration on Vercel](/docs/guides/vercel-native-integration), you must authenticate connections from the CLI client using a Neon API key (see below). The `neon auth` command requires an account registered through Neon rather than Vercel.
</Admonition>

### API key

To authenticate with a Neon API key, you can specify the `--api-key` option when running a Neon CLI command. For example, the following `neon projects list` command authenticates to Neon using the `--api-key` option:
Expand Down

0 comments on commit 89511e7

Please sign in to comment.