From b88e3d7efbd299128425cb655a9f5dbe3073c2bf Mon Sep 17 00:00:00 2001 From: Chiziaruhoma Ogbonda Date: Tue, 9 Jun 2026 13:52:52 +0100 Subject: [PATCH] docs: Update authentication provider setup instructions to use 'serverpod start' instead of 'dart run bin/main.dart --apply-migrations' --- .../11-authentication/04-providers/03-google/01-setup.md | 4 ++-- .../04-providers/03-google/04-troubleshooting.md | 2 +- .../11-authentication/04-providers/04-apple/01-setup.md | 2 +- .../04-providers/04-apple/04-troubleshooting.md | 2 +- .../11-authentication/04-providers/06-firebase/01-setup.md | 2 +- .../04-providers/06-firebase/05-troubleshooting.md | 6 +++--- .../11-authentication/04-providers/07-github/01-setup.md | 2 +- .../04-providers/07-github/04-troubleshooting.md | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/06-concepts/11-authentication/04-providers/03-google/01-setup.md b/docs/06-concepts/11-authentication/04-providers/03-google/01-setup.md index b9c4b2c3..5467bc3e 100644 --- a/docs/06-concepts/11-authentication/04-providers/03-google/01-setup.md +++ b/docs/06-concepts/11-authentication/04-providers/03-google/01-setup.md @@ -152,7 +152,7 @@ Run the following commands from your server project directory (e.g., `my_project ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` :::warning @@ -244,7 +244,7 @@ On web, Google completes sign-in by redirecting the browser to a callback URL yo ```bash flutter build web --output ../my_project_server/web/app # from your Flutter project -dart run bin/main.dart # from your server project +serverpod start # from your server project ``` Open `http://localhost:8082/app` to test. `flutter run -d chrome` won't work here because Flutter's dev server runs on a different port from Serverpod — for hot-reload workflows, use the [separately-hosted Flutter web](./customizations#separately-hosted-flutter-web) flow instead. diff --git a/docs/06-concepts/11-authentication/04-providers/03-google/04-troubleshooting.md b/docs/06-concepts/11-authentication/04-providers/03-google/04-troubleshooting.md index 16a66d25..75eb98fc 100644 --- a/docs/06-concepts/11-authentication/04-providers/03-google/04-troubleshooting.md +++ b/docs/06-concepts/11-authentication/04-providers/03-google/04-troubleshooting.md @@ -174,7 +174,7 @@ Every line of the JSON must be indented by at least one level more than `googleC ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` ## Lightweight sign-in (One Tap) not appearing diff --git a/docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md b/docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md index b7e24df9..0b432a59 100644 --- a/docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md +++ b/docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md @@ -173,7 +173,7 @@ Run the following commands from your server project directory (e.g., `my_project ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` :::note diff --git a/docs/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md b/docs/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md index cea085a7..fc8cf2f4 100644 --- a/docs/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md +++ b/docs/06-concepts/11-authentication/04-providers/04-apple/04-troubleshooting.md @@ -126,7 +126,7 @@ If you use `--dart-define`, confirm `APPLE_SERVICE_IDENTIFIER` is the Services I ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` ## Apple rejects the redirect URI with `invalid_request` diff --git a/docs/06-concepts/11-authentication/04-providers/06-firebase/01-setup.md b/docs/06-concepts/11-authentication/04-providers/06-firebase/01-setup.md index 47bae597..84121071 100644 --- a/docs/06-concepts/11-authentication/04-providers/06-firebase/01-setup.md +++ b/docs/06-concepts/11-authentication/04-providers/06-firebase/01-setup.md @@ -141,7 +141,7 @@ Run the following commands from your server project directory (e.g., `my_project ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` :::note diff --git a/docs/06-concepts/11-authentication/04-providers/06-firebase/05-troubleshooting.md b/docs/06-concepts/11-authentication/04-providers/06-firebase/05-troubleshooting.md index a6ec87fe..1fc58e46 100644 --- a/docs/06-concepts/11-authentication/04-providers/06-firebase/05-troubleshooting.md +++ b/docs/06-concepts/11-authentication/04-providers/06-firebase/05-troubleshooting.md @@ -21,7 +21,7 @@ Go through this before investigating a specific error. Most problems come from a - [ ] Confirm the `project_id` inside `firebaseServiceAccountKey` matches the Firebase project the client is using. - [ ] Add `FirebaseIdpConfigFromPasswords()` to `identityProviderBuilders` in `server.dart`. - [ ] Create a `FirebaseIdpEndpoint` file in `lib/src/auth/` extending `FirebaseIdpBaseEndpoint`. -- [ ] Run **`serverpod generate`**, then **`serverpod create-migration`**, then apply migrations with `dart run bin/main.dart --apply-migrations`. +- [ ] Run **`serverpod generate`**, then **`serverpod create-migration`**, then start the server with `serverpod start`. #### Client @@ -43,7 +43,7 @@ Go through this before investigating a specific error. Most problems come from a ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` ## Token verification fails with "invalid signature" @@ -109,7 +109,7 @@ If you haven't run `flutterfire configure`, do so to generate the `firebase_opti 1. **Missing service account key:** The `firebaseServiceAccountKey` is not present in `passwords.yaml`, or the JSON is invalid. 2. **Missing endpoint:** You did not create the endpoint class extending `FirebaseIdpBaseEndpoint`. Without it, the client has no endpoint to call. -3. **Missing migration:** The provider's database tables don't exist yet. Apply migrations with `dart run bin/main.dart --apply-migrations`. +3. **Missing migration:** The provider's database tables don't exist yet. Start the server with `serverpod start`. 4. **Project mismatch:** The service account key belongs to a different Firebase project than the one configured in your Flutter app. Compare `project_id` in `firebaseServiceAccountKey` against the project in `firebase_options.dart`. 5. **App Check enabled prematurely:** If you enabled Firebase App Check before the client integration is in place, every request will be rejected with an App Check assertion error. Disable App Check until the client is wired up. diff --git a/docs/06-concepts/11-authentication/04-providers/07-github/01-setup.md b/docs/06-concepts/11-authentication/04-providers/07-github/01-setup.md index 4dc76911..4022994b 100644 --- a/docs/06-concepts/11-authentication/04-providers/07-github/01-setup.md +++ b/docs/06-concepts/11-authentication/04-providers/07-github/01-setup.md @@ -147,7 +147,7 @@ Run the following commands from your server project directory (e.g., `my_project ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` :::warning diff --git a/docs/06-concepts/11-authentication/04-providers/07-github/04-troubleshooting.md b/docs/06-concepts/11-authentication/04-providers/07-github/04-troubleshooting.md index f1f60777..43a05b5e 100644 --- a/docs/06-concepts/11-authentication/04-providers/07-github/04-troubleshooting.md +++ b/docs/06-concepts/11-authentication/04-providers/07-github/04-troubleshooting.md @@ -161,7 +161,7 @@ See [Configuring client IDs on the app](./customizations#configuring-client-ids- **Cause:** The keys are missing from `config/passwords.yaml`, are spelled differently, or are not present under the active environment section. -**Resolution:** Confirm both keys exist under the section matching your run mode (`development:` for `dart run bin/main.dart`, `production:` when deployed): +**Resolution:** Confirm both keys exist under the section matching your run mode (`development:` when running locally with `serverpod start`, `production:` when deployed): ```yaml development: @@ -182,7 +182,7 @@ Quotes are required because the values are strings; YAML interprets unquoted val ```bash serverpod generate serverpod create-migration -dart run bin/main.dart --apply-migrations +serverpod start ``` ## Android sign-in opens GitHub but the callback never fires