FileserverConfig

pydantic model controller.config.FileserverConfig

Base configuration for user file servers.

This base model contains only the boolean setting for whether the file server is enabled and a few settings with defaults that are referenced even if the file server is disabled (mostly to make code simpler), allowing code to determine whether the configuration object is actually EnabledFileserverConfig.

Parameters:

data (Any)

Show JSON schema

{
   "title": "FileserverConfig",
   "description": "Base configuration for user file servers.\n\nThis base model contains only the boolean setting for whether the file\nserver is enabled and a few settings with defaults that are referenced\neven if the file server is disabled (mostly to make code simpler),\nallowing code to determine whether the configuration object is actually\n`EnabledFileserverConfig`.",
   "type": "object",
   "properties": {
      "enabled": {
         "default": false,
         "description": "If set to false, file servers will be disabled and the routes to create or manage file servers will return 404 errors",
         "title": "Whether file servers are enabled",
         "type": "boolean"
      },
      "pathPrefix": {
         "default": "/files",
         "description": "The route at which users spawn new user file servers",
         "title": "Path prefix for file server route",
         "type": "string"
      }
   }
}

Fields:

• enabled (bool)

• pathPrefix (str)

field enabled: Annotated[bool, Field(title='Whether file servers are enabled', description='If set to false, file servers will be disabled and the routes to create or manage file servers will return 404 errors')] = False

If set to false, file servers will be disabled and the routes to create or manage file servers will return 404 errors

field pathPrefix: Annotated[str, Field(title='Path prefix for file server route', description='The route at which users spawn new user file servers')] = '/files' (name 'path_prefix')

The route at which users spawn new user file servers