Skip to content

Commit d694756

Browse files
committed
docs: Clarify that maxUploadSize limits the request body size, not the file size
Closes #8224
1 parent 7e9d53a commit d694756

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/Options/Definitions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ module.exports.ParseServerOptions = {
416416
},
417417
maxUploadSize: {
418418
env: 'PARSE_SERVER_MAX_UPLOAD_SIZE',
419-
help: 'Max file size for uploads, defaults to 20mb',
419+
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`.',
420420
default: '20mb',
421421
},
422422
middleware: {

src/Options/docs.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Options/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ export interface ParseServerOptions {
208208
:ENV: PARSE_SERVER_ENABLE_INSECURE_AUTH_ADAPTERS
209209
:DEFAULT: false */
210210
enableInsecureAuthAdapters: ?boolean;
211-
/* Max file size for uploads, defaults to 20mb
211+
/* 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`.
212212
:DEFAULT: 20mb */
213213
maxUploadSize: ?string;
214214
/* 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.

0 commit comments

Comments
 (0)