Pode Configuration Functions (idea not ready yet)

[mdaneri]

Summary

This document provides details on two new functions, Set-PodeConfiguration and Get-PodeConfiguration, to manage Pode server configurations programmatically.

Functions

Set-PodeConfiguration

This function allows users to set various configurations for the Pode server as an alternative to using the server.psd1 file or directly modifying the $PodeContext hashtable.

Parameters

• SslProtocols: Sets SSL protocols.
  • link
• RequestTimeout: Defines the request timeout in seconds.
  • link
• RequestBodySize: Defines the maximum body size for a request in bytes.
  • link
• DisableAutoImportModules: Disables the AutoImport setting for Modules.
  • link
• AutoImportModulesExportOnly: Sets the AutoImport Modules ExportOnly option.
  • link
• DisableAutoImportSnapins: Disables the AutoImport setting for Snapins.
  • link
• AutoImportSnapinsExportOnly: Sets the AutoImport Snapins ExportOnly option.
  • link
• DisableAutoImportFunctions: Disables the AutoImport setting for Functions.
  • link
• AutoImportFunctionsExportOnly: Sets the AutoImport Functions ExportOnly option.
  • link
• DisableSecretManagement: Disables the AutoImport setting for SecretVault.
  • link
• SecretManagementExportOnly: Sets the AutoImport SecretVault ExportOnly option.
  • link
• Root: Overrides root path of the server.
  • link
• RestartPeriod: Sets the interval in minutes for automatically restarting the server.
  • link
• RestartCrons: Sets the cron schedules for automatically restarting the server.
  • link
• RestartTimes: Sets the times for automatically restarting the server in the format "HH:mm".
  • link
• FileMonitorEnable: Enables or disables file monitoring for restarting the server.
  • link
• FileMonitorInclude: Specifies the file patterns to include for monitoring.
  • link
• FileMonitorExclude: Specifies the file patterns to exclude from monitoring.
  • link
• FileMonitorShowFiles: Enables or disables showing monitored files.
  • link
• DefaultFoldersPublic: Sets the custom path for the Public folder.
  • link
• DefaultFoldersViews: Sets the custom path for the Views folder.
  • link
• DefaultFoldersErrors: Sets the custom path for the Errors folder.
  • link
• OpenApiDefaultDefinitionTag: Defines the primary tag name for OpenAPI.
  • link
• StaticValidateLast: Changes the way routes are processed.
  • link
• TransferEncodingDefault: Sets the default transfer encoding.
  • link
• TransferEncodingRoutes: Sets the transfer encoding for specific routes.
  • link
• Compression: Sets any compression to use on the Response.
  • link
• ContentTypeDefault: Sets the default transfer encoding.
  • link
• ContentTypeRoutes: Sets the transfer encoding for specific routes.
  • link
• ErrorPagesDefault: Sets the default transfer encoding.
  • link
• ErrorPagesRoutes: Sets the transfer encoding for specific routes.
  • link
• ErrorPagesShowExceptions: Enables or disables the viewing of exceptions on the error page.
  • link
• ErrorPagesStrictContentTyping: Enables or disables generating an error page that matches the route/request's content type.
  • link
• StaticDefaults: Sets the default static files.
  • link
• StaticCacheEnable: Enables or disables caching for static content.
  • link
• StaticCacheExclude: Specifies the file patterns to exclude from caching.
  • link
• StaticCacheInclude: Specifies the file patterns to include for caching.
  • link
• LoggingMaskingPatterns: Defines the patterns for masking sensitive data in logs.
  • link
• LoggingMask: Defines the mask to use for sensitive data in logs.
  • link
• LoggingQueueLimit: Defines the maximum number of logs allowed in the queue before throwing an event.
  • link

Examples

Set-PodeConfiguration -SslProtocols @('TLS12', 'TLS13')
Set-PodeConfiguration -RequestTimeout 300 -RequestBodySize 1048576
Set-PodeConfiguration -DisableAutoImportModules -AutoImportModulesExportOnly
Set-PodeConfiguration -RestartPeriod 360
Set-PodeConfiguration -RestartCrons @('0 12 * * TUE,FRI')
Set-PodeConfiguration -RestartTimes @('09:45', '21:15')
Set-PodeConfiguration -FileMonitorEnable -FileMonitorInclude @('*.txt', '*.ps1') -FileMonitorExclude @('public/*') -FileMonitorShowFiles
Set-PodeConfiguration -TransferEncodingDefault 'gzip' -TransferEncodingRoutes @{'/api/*' = 'gzip'; '/status/*' = 'deflate'}
Set-PodeConfiguration -ErrorPagesShowExceptions -ErrorPagesStrictContentTyping
Set-PodeConfiguration -StaticDefaults @('home.html') -StaticCacheEnable -StaticCacheExclude @('*.exe') -StaticCacheInclude @('/images/*', '/assets/*.js')
Set-PodeConfiguration -DefaultFoldersPublic 'c:\custom\public' -DefaultFoldersViews 'd:\shared\views' -DefaultFoldersErrors 'e:\logs\errors'
Set-PodeConfiguration -LoggingMaskingPatterns @('(?<keep_before>Password=)\w+') -LoggingMask '--MASKED--' -LoggingQueueLimit 500

Get-PodeConfiguration

This function retrieves the current configurations for the Pode server by reading from the $PodeContext hashtable.

Parameters

Section: Specifies which section of the configuration to retrieve (e.g., SslProtocols, RequestTimeout, AutoImport, etc.).

Get-PodeConfiguration -Section 'SslProtocols'
Get-PodeConfiguration -Section 'RequestTimeout'
Get-PodeConfiguration