Skip to content

docs: Update configuration docs to redirect to module configuration #387

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

Open
exaby73 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update configuration docs to redirect to module configuration #387

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/06-concepts/01-working-with-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType<EndpointCalculator>('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:

Expand Down
20 changes: 5 additions & 15 deletions docs/06-concepts/07-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment on lines +91 to +92

@developerjamiu developerjamiu Jun 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: two small adjustments to the bullet. The file-uploads page also documents Cloudflare R2, so naming it makes the pointer accurate. Matching the link text to the actual heading on the auth page ("Storing Secrets") reads more cleanly than "Authentication Setup".

Suggested change
- **Cloud storage (GCP/S3)**: [Uploading files](file-uploads)
- **Authentication**: [Authentication Setup](authentication/setup#storing-secrets)
- **Cloud storage**: see [Uploading files](file-uploads) for GCP, AWS S3, and Cloudflare R2 secrets.
- **Authentication**: see [Storing secrets](authentication/setup#storing-secrets) on the Authentication setup page.


#### Custom Secrets

Expand Down Expand Up @@ -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.
Comment on lines +322 to +328

@marcelomendoncasoares marcelomendoncasoares Dec 23, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Will this work? Since AuthUser is declared under serverpod_auth_core, but exported from serverpod_auth_idp.

If this is true, we should also update the reference in the authentication docs to use module:serverpod_auth_idp:AuthUser and fix serverpod/serverpod#4492.

@exaby73 exaby73 Dec 28, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Above a nickname is given so it's pointing to serverpod_auth_idp

@marcelomendoncasoares marcelomendoncasoares Jan 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change the module referenced here to core, right? Since we already saw that it won't work due to the serverpod_auth_core models being exported in the serverpod_auth_ipd_server/core.dart. Unless we add the export to both the client and server central export file for the IDP package. What do you think?


### Custom serializable classes

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/06-concepts/01-working-with-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType<EndpointCalculator>('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:

Expand Down
20 changes: 5 additions & 15 deletions versioned_docs/version-3.0.0/06-concepts/07-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.1.0/06-concepts/01-working-with-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ var advancedCalc = client.getEndpointOfType<EndpointCalculator>('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:

Expand Down
20 changes: 5 additions & 15 deletions versioned_docs/version-3.1.0/06-concepts/07-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down