From efdfdeef96e7719e4bc6707495b94aac61adfa3a Mon Sep 17 00:00:00 2001 From: Nabeel Parkar Date: Fri, 19 Dec 2025 16:04:38 +0530 Subject: [PATCH 1/3] docs: Update configuration documentation for first-party packages --- docs/06-concepts/07-configuration.md | 20 +++++-------------- .../06-concepts/01-working-with-endpoints.md | 2 +- .../06-concepts/07-configuration.md | 20 +++++-------------- .../06-concepts/01-working-with-endpoints.md | 2 +- .../06-concepts/07-configuration.md | 20 +++++-------------- .../06-concepts/01-working-with-endpoints.md | 2 +- 6 files changed, 18 insertions(+), 48 deletions(-) diff --git a/docs/06-concepts/07-configuration.md b/docs/06-concepts/07-configuration.md index 85da4ec0..112d3db4 100644 --- a/docs/06-concepts/07-configuration.md +++ b/docs/06-concepts/07-configuration.md @@ -97,20 +97,10 @@ The following table shows the built-in secrets that Serverpod uses for its core #### Secrets for First Party Packages -The following secrets are used by official Serverpod packages: +For secrets related to first-party Serverpod packages, see their respective documentation: -- [serverpod_cloud_storage_gcp](https://pub.dev/packages/serverpod_cloud_storage_gcp): Google Cloud Storage -- [serverpod_cloud_storage_s3](https://pub.dev/packages/serverpod_cloud_storage_s3): Amazon S3 -- [serverpod_auth_server](https://pub.dev/packages/serverpod_auth_server): Serverpod Auth Server - -| Environment variable | Passwords file | Default | Description | -| ----------------------------------------------------------- | ---------------------------------------- | ------- | ----------------------------------------------------------------------------- | -| SERVERPOD_PASSWORD_HMACAccessKeyId | HMACAccessKeyId | - | The access key ID for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_HMACSecretKey | HMACSecretKey | - | The secret key for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_AWSAccessKeyId | AWSAccessKeyId | - | The access key ID for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_AWSSecretKey | AWSSecretKey | - | The secret key for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret | serverpod_auth_googleClientSecret | - | The client secret for Google authentication for serverpod_auth_server | -| SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey | serverpod_auth_firebaseServiceAccountKey | - | The service account key for Firebase authentication for serverpod_auth_server | +- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) +- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) #### Custom Secrets @@ -378,13 +368,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_idp: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Shared packages diff --git a/versioned_docs/version-3.0.0/06-concepts/01-working-with-endpoints.md b/versioned_docs/version-3.0.0/06-concepts/01-working-with-endpoints.md index f1fba72c..70eb171f 100644 --- a/versioned_docs/version-3.0.0/06-concepts/01-working-with-endpoints.md +++ b/versioned_docs/version-3.0.0/06-concepts/01-working-with-endpoints.md @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType('advancedCalcula This pattern is particularly powerful for modules. A module can provide an abstract endpoint that defines an interface, and users of the module can extend it to expose the functionality on their server: -**In a module (e.g., `serverpod_auth`):** +**In a module (e.g., `serverpod_auth_idp`):** Declare an abstract endpoint with common methods on the server: diff --git a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md index 03942dbe..f551ed14 100644 --- a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md @@ -86,20 +86,10 @@ The following table shows the built-in secrets that Serverpod uses for its core #### Secrets for First Party Packages -The following secrets are used by official Serverpod packages: +For secrets related to first-party Serverpod packages, see their respective documentation: -- [serverpod_cloud_storage_gcp](https://pub.dev/packages/serverpod_cloud_storage_gcp): Google Cloud Storage -- [serverpod_cloud_storage_s3](https://pub.dev/packages/serverpod_cloud_storage_s3): Amazon S3 -- [serverpod_auth_server](https://pub.dev/packages/serverpod_auth_server): Serverpod Auth Server - -| Environment variable | Passwords file | Default | Description | -| ----------------------------------------------------------- | ---------------------------------------- | ------- | ----------------------------------------------------------------------------- | -| SERVERPOD_PASSWORD_HMACAccessKeyId | HMACAccessKeyId | - | The access key ID for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_HMACSecretKey | HMACSecretKey | - | The secret key for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_AWSAccessKeyId | AWSAccessKeyId | - | The access key ID for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_AWSSecretKey | AWSSecretKey | - | The secret key for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret | serverpod_auth_googleClientSecret | - | The client secret for Google authentication for serverpod_auth_server | -| SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey | serverpod_auth_firebaseServiceAccountKey | - | The service account key for Firebase authentication for serverpod_auth_server | +- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) +- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) #### Custom Secrets @@ -329,13 +319,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_idp: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Custom serializable classes diff --git a/versioned_docs/version-3.1.0/06-concepts/01-working-with-endpoints.md b/versioned_docs/version-3.1.0/06-concepts/01-working-with-endpoints.md index f1fba72c..70eb171f 100644 --- a/versioned_docs/version-3.1.0/06-concepts/01-working-with-endpoints.md +++ b/versioned_docs/version-3.1.0/06-concepts/01-working-with-endpoints.md @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType('advancedCalcula This pattern is particularly powerful for modules. A module can provide an abstract endpoint that defines an interface, and users of the module can extend it to expose the functionality on their server: -**In a module (e.g., `serverpod_auth`):** +**In a module (e.g., `serverpod_auth_idp`):** Declare an abstract endpoint with common methods on the server: diff --git a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md index 03942dbe..f551ed14 100644 --- a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md @@ -86,20 +86,10 @@ The following table shows the built-in secrets that Serverpod uses for its core #### Secrets for First Party Packages -The following secrets are used by official Serverpod packages: +For secrets related to first-party Serverpod packages, see their respective documentation: -- [serverpod_cloud_storage_gcp](https://pub.dev/packages/serverpod_cloud_storage_gcp): Google Cloud Storage -- [serverpod_cloud_storage_s3](https://pub.dev/packages/serverpod_cloud_storage_s3): Amazon S3 -- [serverpod_auth_server](https://pub.dev/packages/serverpod_auth_server): Serverpod Auth Server - -| Environment variable | Passwords file | Default | Description | -| ----------------------------------------------------------- | ---------------------------------------- | ------- | ----------------------------------------------------------------------------- | -| SERVERPOD_PASSWORD_HMACAccessKeyId | HMACAccessKeyId | - | The access key ID for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_HMACSecretKey | HMACSecretKey | - | The secret key for HMAC authentication for serverpod_cloud_storage_gcp | -| SERVERPOD_PASSWORD_AWSAccessKeyId | AWSAccessKeyId | - | The access key ID for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_AWSSecretKey | AWSSecretKey | - | The secret key for AWS authentication for serverpod_cloud_storage_s3 | -| SERVERPOD_PASSWORD_serverpod_auth_googleClientSecret | serverpod_auth_googleClientSecret | - | The client secret for Google authentication for serverpod_auth_server | -| SERVERPOD_PASSWORD_serverpod_auth_firebaseServiceAccountKey | serverpod_auth_firebaseServiceAccountKey | - | The service account key for Firebase authentication for serverpod_auth_server | +- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) +- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) #### Custom Secrets @@ -329,13 +319,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_idp: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Custom serializable classes diff --git a/versioned_docs/version-3.3.0/06-concepts/01-working-with-endpoints.md b/versioned_docs/version-3.3.0/06-concepts/01-working-with-endpoints.md index f1fba72c..70eb171f 100644 --- a/versioned_docs/version-3.3.0/06-concepts/01-working-with-endpoints.md +++ b/versioned_docs/version-3.3.0/06-concepts/01-working-with-endpoints.md @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType('advancedCalcula This pattern is particularly powerful for modules. A module can provide an abstract endpoint that defines an interface, and users of the module can extend it to expose the functionality on their server: -**In a module (e.g., `serverpod_auth`):** +**In a module (e.g., `serverpod_auth_idp`):** Declare an abstract endpoint with common methods on the server: From 072b85049ae696508291272cfa4caa8a2a9adc74 Mon Sep 17 00:00:00 2001 From: developerjamiu Date: Thu, 18 Jun 2026 20:03:09 +0100 Subject: [PATCH 2/3] docs: Reference serverpod_auth_core for AuthUser module example --- docs/06-concepts/07-configuration.md | 2 +- versioned_docs/version-3.0.0/06-concepts/07-configuration.md | 2 +- versioned_docs/version-3.1.0/06-concepts/07-configuration.md | 2 +- versioned_docs/version-3.2.0/06-concepts/07-configuration.md | 4 ++-- versioned_docs/version-3.3.0/06-concepts/07-configuration.md | 4 ++-- versioned_docs/version-3.4.0/06-concepts/07-configuration.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/06-concepts/07-configuration.md b/docs/06-concepts/07-configuration.md index 112d3db4..c0cfe515 100644 --- a/docs/06-concepts/07-configuration.md +++ b/docs/06-concepts/07-configuration.md @@ -368,7 +368,7 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth_idp: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom diff --git a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md index f551ed14..c15104d5 100644 --- a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md @@ -319,7 +319,7 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth_idp: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom diff --git a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md index f551ed14..c15104d5 100644 --- a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md @@ -319,7 +319,7 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth_idp: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom diff --git a/versioned_docs/version-3.2.0/06-concepts/07-configuration.md b/versioned_docs/version-3.2.0/06-concepts/07-configuration.md index 03942dbe..cf1f60c4 100644 --- a/versioned_docs/version-3.2.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.2.0/06-concepts/07-configuration.md @@ -329,13 +329,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Custom serializable classes diff --git a/versioned_docs/version-3.3.0/06-concepts/07-configuration.md b/versioned_docs/version-3.3.0/06-concepts/07-configuration.md index 8fee9281..5422bebb 100644 --- a/versioned_docs/version-3.3.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.3.0/06-concepts/07-configuration.md @@ -337,13 +337,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Custom serializable classes diff --git a/versioned_docs/version-3.4.0/06-concepts/07-configuration.md b/versioned_docs/version-3.4.0/06-concepts/07-configuration.md index afd4eda6..a6318106 100644 --- a/versioned_docs/version-3.4.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.4.0/06-concepts/07-configuration.md @@ -338,13 +338,13 @@ Declare module dependencies and optionally assign nicknames for easier reference ```yaml modules: - serverpod_auth: + serverpod_auth_core: nickname: auth my_custom_module: nickname: custom ``` -This allows you to reference module classes as `module:auth:UserInfo` in your model files. See the [modules documentation](modules) for more information. +This allows you to reference module classes as `module:auth:AuthUser` in your model files. See the [modules documentation](modules) for more information. ### Shared packages From d1231ba20d02b0b4b9255896e9a79b707ffb1f3d Mon Sep 17 00:00:00 2001 From: developerjamiu Date: Thu, 18 Jun 2026 20:20:14 +0100 Subject: [PATCH 3/3] docs: Tighten first-party packages bullet on configuration page --- docs/06-concepts/07-configuration.md | 4 ++-- versioned_docs/version-3.0.0/06-concepts/07-configuration.md | 4 ++-- versioned_docs/version-3.1.0/06-concepts/07-configuration.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/06-concepts/07-configuration.md b/docs/06-concepts/07-configuration.md index c0cfe515..85a42b65 100644 --- a/docs/06-concepts/07-configuration.md +++ b/docs/06-concepts/07-configuration.md @@ -99,8 +99,8 @@ The following table shows the built-in secrets that Serverpod uses for its core For secrets related to first-party Serverpod packages, see their respective documentation: -- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) -- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) +- **Cloud storage**: see [Uploading files](file-uploads) for Google Cloud Storage, AWS S3, and Cloudflare R2 secrets. +- **Authentication**: see [Storing Secrets](authentication/setup#storing-secrets) on the Authentication setup page. #### Custom Secrets diff --git a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md index c15104d5..8874095f 100644 --- a/versioned_docs/version-3.0.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.0.0/06-concepts/07-configuration.md @@ -88,8 +88,8 @@ The following table shows the built-in secrets that Serverpod uses for its core For secrets related to first-party Serverpod packages, see their respective documentation: -- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) -- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) +- **Cloud storage**: see [Uploading files](file-uploads) for Google Cloud Storage, AWS S3, and Cloudflare R2 secrets. +- **Authentication**: see [Storing Secrets](authentication/setup#storing-secrets) on the Authentication setup page. #### Custom Secrets diff --git a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md index c15104d5..8874095f 100644 --- a/versioned_docs/version-3.1.0/06-concepts/07-configuration.md +++ b/versioned_docs/version-3.1.0/06-concepts/07-configuration.md @@ -88,8 +88,8 @@ The following table shows the built-in secrets that Serverpod uses for its core For secrets related to first-party Serverpod packages, see their respective documentation: -- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads) -- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets) +- **Cloud storage**: see [Uploading files](file-uploads) for Google Cloud Storage, AWS S3, and Cloudflare R2 secrets. +- **Authentication**: see [Storing Secrets](authentication/setup#storing-secrets) on the Authentication setup page. #### Custom Secrets