mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
Miranda Limonczenko
abbf667084
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem The Docs E2E link checker found broken links throughout docs, starting with `phone-login.mdx` pointing to `/docs/guides/cli/config` (404). Old links like `/docs/guides/cli/config` still work on the live site because `supabase.com` has redirects set up for them, but these links break on the docs preview site, which is what the E2E check tests against. These issues look clean on the live site, and I didn't catch them in my first pass because I was testing production instead of the preview. The E2E check only tests the ~20 pages a given PR happens to touch, so fixing the pages it flagged kept exposing more of the same problem one page at a time as each fix pulled in a new file. To stop chasing this incrementally, I cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against actual usage across all of `apps/docs`, and verified each candidate against the live preview. ## Solution Rather than updating the Docs E2E link checker, this PR resolves the links. **Why:** we own these docs, so keeping the links clean without redirects is keeping the house maintained. See [Broken Window Theory](https://blog.codinghorror.com/the-broken-window-theory/). Updated every link still using an old path to point straight at the current page instead of relying on a redirect. This covers old links like: - `/docs/guides/cli/config` → `/docs/guides/local-development/cli/config` - `/docs/guides/cli/getting-started` → `/docs/guides/local-development/cli/getting-started` - `/docs/guides/cli/local-development` → `/docs/guides/local-development/database-migrations` - `/docs/guides/cli/managing-environments` → `/docs/guides/deployment/managing-environments` - `/docs/guides/cli/seeding-your-database` → `/docs/guides/local-development/seeding-your-database` - bare `/docs/guides/cli` → `/docs/guides/local-development` - `/docs/guides/platform/compute-add-ons` → `/docs/guides/platform/compute-and-disk` - `/docs/guides/platform/shared-responsibility-model` → `/docs/guides/deployment/shared-responsibility-model` - `/docs/guides/database` → `/docs/guides/database/overview` - `/docs/reference/javascript`, `/docs/reference/dart`, `/docs/reference/kotlin`, `/docs/reference/python`, `/docs/reference/csharp` → their `/introduction` pages (the redirect's own destination, `/start`, turned out to be dead even on production — a separate bug in `redirects.js` I didn't touch here) - and about 35 more of the same pattern, listed in the commit messages Also fixed a handful of dead heading anchors found along the way (links that resolve to the right page but point at a `#section` that got renamed or moved), including the original `#bigquery` anchor and a few in `connecting-to-postgres.mdx` where content moved to its own dedicated page. Left alone on purpose: - `content/guides/cli.mdx` — this page has no route in the docs app at all (no `app/guides/cli/` directory), so it 404s even in production before the `www` redirect ever fires. Fixing its internal link wouldn't change that; it needs an actual routing/content decision, not a link fix. - A few candidates that already resolve fine as-is (`pg_partman`, bare `/docs/reference/api`, bare `/docs/reference/cli`) — confirmed via curl, left untouched. ## Manual testing 1. Confirmed every new link target actually exists by checking the destination file/page and matching heading anchors. 2. Cross-referenced every `/docs/guides/*` and `/docs/reference/*` redirect source in `apps/www/lib/redirects.js` against real usage in `apps/docs`, and curl-verified each old path (404) and new path (200) against the live PR preview before fixing it. 3. Ran the Docs E2E link checker locally against changed pages. 4. Spot-checked the original broken link from CI (`/docs/guides/cli/config`) to confirm it now points to a working page.
73 lines
2.0 KiB
Plaintext
73 lines
2.0 KiB
Plaintext
---
|
|
title = "Issues serving Edge Functions locally"
|
|
topics = [ "functions", "cli" ]
|
|
keywords = [ "local", "serve", "development", "debug", "port", "edge function" ]
|
|
database_id = "1cff12df-7ad6-48c5-b518-5ea468b54bab"
|
|
|
|
[api]
|
|
cli = [ "supabase-functions-serve" ]
|
|
---
|
|
|
|
If `supabase functions serve` fails or you're having trouble running Edge Functions locally, follow these steps to diagnose and resolve the issue.
|
|
|
|
## Debugging steps
|
|
|
|
### Use debug mode
|
|
|
|
Run the serve command with the `--debug` flag for detailed output:
|
|
|
|
```bash
|
|
supabase functions serve your-function --debug
|
|
```
|
|
|
|
### Check port availability
|
|
|
|
Ensure the required ports are available. The Supabase CLI uses ports `54321` and `8081` by default:
|
|
|
|
```bash
|
|
# Check if port 54321 is in use
|
|
lsof -i :54321
|
|
|
|
# Check if port 8081 is in use
|
|
lsof -i :8081
|
|
```
|
|
|
|
If these ports are in use, stop the processes using them or configure different ports.
|
|
|
|
## Common issues
|
|
|
|
### Port conflicts
|
|
|
|
Another process may be using the required ports. Check for:
|
|
|
|
- Other Supabase projects running locally
|
|
- Docker containers
|
|
- Other development servers
|
|
|
|
### Deno cache issues
|
|
|
|
Clear the Deno cache if you're experiencing module resolution problems:
|
|
|
|
```bash
|
|
deno cache --reload /path/to/function/index.ts
|
|
```
|
|
|
|
### Environment variables
|
|
|
|
Make sure your `.env` file is properly configured and accessible to the CLI.
|
|
|
|
## Getting more help
|
|
|
|
If the problem persists, search the following repositories for similar error messages:
|
|
|
|
- [Edge Runtime repository](https://github.com/supabase/edge-runtime)
|
|
- [CLI repository](https://github.com/supabase/cli)
|
|
|
|
If the output from these commands does not help resolve the issue, open a support ticket via the Supabase Dashboard (by clicking the "Help" button at the top right) and include all output and details about your commands.
|
|
|
|
## Additional resources
|
|
|
|
- [Local development guide](/docs/guides/local-development/database-migrations)
|
|
- [Edge Functions quickstart](/docs/guides/functions/quickstart)
|
|
- [Debugging Edge Functions](/docs/guides/functions/logging)
|