Skip to content

docs: add projectUrl migration guide #773

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

Closed
onmax wants to merge 1 commit into from
Closed

docs: add projectUrl migration guide #773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions docs/content/docs/1.getting-started/4.migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ You can visit [legacy.hub.nuxt.com](https://legacy.hub.nuxt.com) to read the doc
| Blob access | `hubBlob()` | `blob` from `hub:blob` |
| KV access | `hubKV()` | `kv` from `hub:kv` |
| AI & AutoRAG | `hubAI()` | Removed (use [AI SDK](https://ai-sdk.dev)) |
| Remote storage | `hub.projectUrl` + `hub.projectSecretKey` | `wrangler.jsonc` with `remote: true` per binding |
| NuxtHub Admin | Supported | Deprecated (sunset Dec 31, 2025) |
| `nuxthub deploy` | Supported | Deprecated (sunset Jan 31, 2026) |

Expand Down Expand Up @@ -93,6 +94,31 @@ export default defineNuxtConfig({
})
```

### Remote Storage

The `projectUrl` and `projectSecretKey` options have been removed. To connect to remote Cloudflare resources during local development, use wrangler's native `remote: true` flag on each binding in your `wrangler.jsonc`:

```jsonc [wrangler.jsonc]
{
"d1_databases": [
{ "binding": "DB", "database_name": "<name>", "database_id": "<id>", "remote": true }
],
"r2_buckets": [
{ "binding": "BLOB", "bucket_name": "<name>", "remote": true }
],
"kv_namespaces": [
{ "binding": "KV", "id": "<id>", "remote": true },
{ "binding": "CACHE", "id": "<id>", "remote": true }
]
}
```

This requires wrangler v4.37.0+. When `remote: true` is set, your code runs locally but binding calls are routed to actual Cloudflare resources.

::callout{to="https://developers.cloudflare.com/workers/development-testing/#remote-bindings"}
Learn more about wrangler remote bindings.
::

## Code Migration

### Database Access
Expand Down Expand Up @@ -380,6 +406,7 @@ Replace `npx nuxthub deploy` with your provider's deployment method:
- [ ] Replace `hubBlob()` calls with `blob` from `hub:blob`
- [ ] Replace `hubKV()` calls with `kv` from `hub:kv`
- [ ] Remove AI/AutoRAG usage or migrate to AI SDK
- [ ] For remote development: Add `remote: true` to bindings in `wrangler.jsonc`
- [ ] For Cloudflare: Configure resource IDs in `nuxt.config.ts` (v0.10.3+) OR create manual `wrangler.jsonc`
- [ ] For Vercel: Add storage from dashboard and install required packages
- [ ] Update CI/CD from NuxtHub GitHub Action to provider's deployment (Workers/Pages CI, Vercel Git integration, etc.)
Expand Down
Loading