diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js index 5b2e6e497a..760702cfce 100644 --- a/src/Options/Definitions.js +++ b/src/Options/Definitions.js @@ -416,7 +416,7 @@ module.exports.ParseServerOptions = { }, maxUploadSize: { env: 'PARSE_SERVER_MAX_UPLOAD_SIZE', - help: 'Max file size for uploads, defaults to 20mb', + help: 'The maximum size of the HTTP request body for file uploads, for example `20mb`. This limits the request body size, not the file size: the encoded upload is larger than the file itself, so set this higher than your largest intended file to allow for encoding overhead. Files sent as base64 (for example via the JavaScript SDK) inflate the payload by roughly 33%, and multipart uploads add boundary and header overhead. Defaults to `20mb`.', default: '20mb', }, middleware: { diff --git a/src/Options/docs.js b/src/Options/docs.js index 91d58cbe9b..c2fb1e07ab 100644 --- a/src/Options/docs.js +++ b/src/Options/docs.js @@ -78,7 +78,7 @@ * @property {Number} masterKeyTtl (Optional) The duration in seconds for which the current `masterKey` is being used before it is requested again if `masterKey` is set to a function. If `masterKey` is not set to a function, this option has no effect. Default is `0`, which means the master key is requested by invoking the `masterKey` function every time the master key is used internally by Parse Server. * @property {Number} maxLimit Max value for limit option on queries, defaults to unlimited * @property {Number|String} maxLogFiles Maximum number of logs to keep. If not set, no logs will be removed. This can be a number of files or number of days. If using days, add 'd' as the suffix. (default: null) - * @property {String} maxUploadSize Max file size for uploads, defaults to 20mb + * @property {String} maxUploadSize The maximum size of the HTTP request body for file uploads, for example `20mb`. This limits the request body size, not the file size: the encoded upload is larger than the file itself, so set this higher than your largest intended file to allow for encoding overhead. Files sent as base64 (for example via the JavaScript SDK) inflate the payload by roughly 33%, and multipart uploads add boundary and header overhead. Defaults to `20mb`. * @property {Union} middleware middleware for express server, can be string or function * @property {Boolean} mountGraphQL Mounts the GraphQL endpoint * @property {String} mountPath Mount path for the server, defaults to /parse diff --git a/src/Options/index.js b/src/Options/index.js index d8f56defca..653efc2116 100644 --- a/src/Options/index.js +++ b/src/Options/index.js @@ -208,7 +208,7 @@ export interface ParseServerOptions { :ENV: PARSE_SERVER_ENABLE_INSECURE_AUTH_ADAPTERS :DEFAULT: false */ enableInsecureAuthAdapters: ?boolean; - /* Max file size for uploads, defaults to 20mb + /* The maximum size of the HTTP request body for file uploads, for example `20mb`. This limits the request body size, not the file size: the encoded upload is larger than the file itself, so set this higher than your largest intended file to allow for encoding overhead. Files sent as base64 (for example via the JavaScript SDK) inflate the payload by roughly 33%, and multipart uploads add boundary and header overhead. Defaults to `20mb`. :DEFAULT: 20mb */ maxUploadSize: ?string; /* Set to `true` to require users to verify their email address to complete the sign-up process. Supports a function with a return value of `true` or `false` for conditional verification. The function receives a request object that includes `createdWith` to indicate whether the invocation is for `signup` or `login` and the used auth provider.