help:'Enable (or disable) client class creation, defaults to true',
action:parsers.booleanParser,
default:true,
},
allowCustomObjectId:{
env:'PARSE_SERVER_ALLOW_CUSTOM_OBJECT_ID',
help:'Enable (or disable) custom objectId',
action:parsers.booleanParser,
default:false,
},
allowHeaders:{
env:'PARSE_SERVER_ALLOW_HEADERS',
help:'Add headers to Access-Control-Allow-Headers',
action:parsers.arrayParser,
},
allowOrigin:{
env:'PARSE_SERVER_ALLOW_ORIGIN',
help:'Sets the origin to Access-Control-Allow-Origin',
},
analyticsAdapter:{
env:'PARSE_SERVER_ANALYTICS_ADAPTER',
help:'Adapter module for the analytics',
action:parsers.moduleOrObjectParser,
},
appId:{
env:'PARSE_SERVER_APPLICATION_ID',
help:'Your Parse Application ID',
required:true,
},
appName:{
env:'PARSE_SERVER_APP_NAME',
help:'Sets the app name',
},
auth:{
env:'PARSE_SERVER_AUTH_PROVIDERS',
help:
'Configuration for your authentication providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication',
action:parsers.objectParser,
},
cacheAdapter:{
env:'PARSE_SERVER_CACHE_ADAPTER',
help:'Adapter module for the cache',
action:parsers.moduleOrObjectParser,
},
cacheMaxSize:{
env:'PARSE_SERVER_CACHE_MAX_SIZE',
help:'Sets the maximum size for the in memory cache, defaults to 10000',
action:parsers.numberParser('cacheMaxSize'),
default:10000,
},
cacheTTL:{
env:'PARSE_SERVER_CACHE_TTL',
help:'Sets the TTL for the in memory cache (in ms), defaults to 5000 (5 seconds)',
action:parsers.numberParser('cacheTTL'),
default:5000,
},
clientKey:{
env:'PARSE_SERVER_CLIENT_KEY',
help:'Key for iOS, MacOS, tvOS clients',
},
cloud:{
env:'PARSE_SERVER_CLOUD',
help:'Full path to your cloud code main.js',
},
cluster:{
env:'PARSE_SERVER_CLUSTER',
help:'Run with cluster, optionally set the number of processes default to os.cpus().length',
action:parsers.numberOrBooleanParser,
},
collectionPrefix:{
env:'PARSE_SERVER_COLLECTION_PREFIX',
help:'A collection prefix for the classes',
default:'',
},
customPages:{
env:'PARSE_SERVER_CUSTOM_PAGES',
help:'custom pages for password validation and reset',
'Set to `true` if Parse requests within the same Node.js environment as Parse Server should be routed to Parse Server directly instead of via the HTTP interface. Default is `false`.<br><br>If set to `false` then Parse requests within the same Node.js environment as Parse Server are executed as HTTP requests sent to Parse Server via the `serverURL`. For example, a `Parse.Query` in Cloud Code is calling Parse Server via a HTTP request. The server is essentially making a HTTP request to itself, unnecessarily using network resources such as network ports.<br><br>\u26A0\uFE0F In environments where multiple Parse Server instances run behind a load balancer and Parse requests within the current Node.js environment should be routed via the load balancer and distributed as HTTP requests among all instances via the `serverURL`, this should be set to `false`.',
'Set to `true` if a email verification token should be reused in case another token is requested but there is a token that is still valid, i.e. has not expired. This avoids the often observed issue that a user requests multiple emails and does not know which link contains a valid token because each newly generated token would invalidate the previous token.<br><br>Default is `false`.<br>Requires option `verifyUserEmails: true`.',
'Set the validity duration of the email verification token in seconds after which the token expires. The token is used in the link that is set in the email. After the token expires, the link becomes invalid and a new link has to be sent. If the option is not set or set to `undefined`, then the token never expires.<br><br>For example, to expire the token after 2 hours, set a value of 7200 seconds (= 60 seconds * 60 minutes * 2 hours).<br><br>Default is `undefined`.<br>Requires option `verifyUserEmails: true`.',
'Options for request idempotency to deduplicate identical requests that may be caused by network issues. Caution, this is an experimental feature that may not be appropriate for production.',
help:'Live query server configuration options (will start the liveQuery server)',
action:parsers.objectParser,
},
loggerAdapter:{
env:'PARSE_SERVER_LOGGER_ADAPTER',
help:'Adapter module for the logging sub-system',
action:parsers.moduleOrObjectParser,
},
logLevel:{
env:'PARSE_SERVER_LOG_LEVEL',
help:'Sets the level for logs',
},
logsFolder:{
env:'PARSE_SERVER_LOGS_FOLDER',
help:"Folder for the logs (defaults to './logs'); set to null to disable file based logging",
default:'./logs',
},
masterKey:{
env:'PARSE_SERVER_MASTER_KEY',
help:'Your Parse Master Key',
required:true,
},
masterKeyIps:{
env:'PARSE_SERVER_MASTER_KEY_IPS',
help:'Restrict masterKey to be used by only these ips, defaults to [] (allow all ips)',
action:parsers.arrayParser,
default:[],
},
maxLimit:{
env:'PARSE_SERVER_MAX_LIMIT',
help:'Max value for limit option on queries, defaults to unlimited',
action:parsers.numberParser('maxLimit'),
},
maxLogFiles:{
env:'PARSE_SERVER_MAX_LOG_FILES',
help:
"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)",
action:parsers.objectParser,
},
maxUploadSize:{
env:'PARSE_SERVER_MAX_UPLOAD_SIZE',
help:'Max file size for uploads, defaults to 20mb',
default:'20mb',
},
middleware:{
env:'PARSE_SERVER_MIDDLEWARE',
help:'middleware for express server, can be string or function',
},
mountGraphQL:{
env:'PARSE_SERVER_MOUNT_GRAPHQL',
help:'Mounts the GraphQL endpoint',
action:parsers.booleanParser,
default:false,
},
mountPath:{
env:'PARSE_SERVER_MOUNT_PATH',
help:'Mount path for the server, defaults to /parse',
default:'/parse',
},
mountPlayground:{
env:'PARSE_SERVER_MOUNT_PLAYGROUND',
help:'Mounts the GraphQL Playground - never use this option in production',
action:parsers.booleanParser,
default:false,
},
objectIdSize:{
env:'PARSE_SERVER_OBJECT_ID_SIZE',
help:"Sets the number of characters in generated object id's, default 10",
'The options for pages such as password reset and email verification. Caution, this is an experimental feature that may not be appropriate for production.',
'Set to `true` to prevent a user from logging in if the email has not yet been verified and email verification is required.<br><br>Default is `false`.<br>Requires option `verifyUserEmails: true`.',
"When a user changes their password, either through the reset password email or while logged in, all sessions are revoked if this is true. Set to false if you don't want to revoke sessions.",
action:parsers.booleanParser,
default:true,
},
scheduledPush:{
env:'PARSE_SERVER_SCHEDULED_PUSH',
help:'Configuration for push scheduling, defaults to false.',
'The security check groups to run. This allows to add custom security checks or override existing ones. Default are the groups defined in `CheckGroups.js`.',
action:parsers.arrayParser,
},
enableCheck:{
env:'PARSE_SERVER_SECURITY_ENABLE_CHECK',
help:'Is true if Parse Server should check for weak security settings.',
action:parsers.booleanParser,
default:false,
},
enableCheckLog:{
env:'PARSE_SERVER_SECURITY_ENABLE_CHECK_LOG',
help:
'Is true if the security check report should be written to logs. This should only be enabled temporarily to not expose weak security settings in logs.',
help:'Is true if pages should be localized; this has no effect on custom page redirects.',
action:parsers.booleanParser,
default:false,
},
enableRouter:{
env:'PARSE_SERVER_PAGES_ENABLE_ROUTER',
help:
'Is true if the pages router should be enabled; this is required for any of the pages options to take effect. Caution, this is an experimental feature that may not be appropriate for production.',
action:parsers.booleanParser,
default:false,
},
forceRedirect:{
env:'PARSE_SERVER_PAGES_FORCE_REDIRECT',
help:
'Is true if responses should always be redirects and never content, false if the response type should depend on the request type (GET request -> content response; POST request -> redirect response).',
'The fallback locale for localization if no matching translation is provided for the given locale. This is only relevant when providing translation resources via JSON file.',
default:'en',
},
localizationJsonPath:{
env:'PARSE_SERVER_PAGES_LOCALIZATION_JSON_PATH',
help:
'The path to the JSON file for localization; the translations will be used to fill template placeholders according to the locale.',
},
pagesEndpoint:{
env:'PARSE_SERVER_PAGES_PAGES_ENDPOINT',
help:"The API endpoint for the pages. Default is 'apps'.",
default:'apps',
},
pagesPath:{
env:'PARSE_SERVER_PAGES_PAGES_PATH',
help:
"The path to the pages directory; this also defines where the static endpoint '/apps' points to. Default is the './public/' directory.",
default:'./public',
},
placeholders:{
env:'PARSE_SERVER_PAGES_PLACEHOLDERS',
help:
'The placeholder keys and values which will be filled in pages; this can be a simple object or a callback function.',
'This string should match the appId in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same appId.',
},
cacheTimeout:{
env:'PARSE_LIVE_QUERY_SERVER_CACHE_TIMEOUT',
help:
"Number in milliseconds. When clients provide the sessionToken to the LiveQuery server, the LiveQuery server will try to fetch its ParseUser's objectId from parse server and store it in the cache. The value defines the duration of the cache. Check the following Security section and our protocol specification for details, defaults to 5 * 1000 ms (5 seconds).",
action:parsers.numberParser('cacheTimeout'),
},
keyPairs:{
env:'PARSE_LIVE_QUERY_SERVER_KEY_PAIRS',
help:
'A JSON object that serves as a whitelist of keys. It is used for validating clients when they try to connect to the LiveQuery server. Check the following Security section and our protocol specification for details.',
action:parsers.objectParser,
},
logLevel:{
env:'PARSE_LIVE_QUERY_SERVER_LOG_LEVEL',
help:
'This string defines the log level of the LiveQuery server. We support VERBOSE, INFO, ERROR, NONE, defaults to INFO.',
},
masterKey:{
env:'PARSE_LIVE_QUERY_SERVER_MASTER_KEY',
help:
'This string should match the masterKey in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same masterKey.',
},
port:{
env:'PARSE_LIVE_QUERY_SERVER_PORT',
help:'The port to run the LiveQuery server, defaults to 1337.',
action:parsers.numberParser('port'),
default:1337,
},
pubSubAdapter:{
env:'PARSE_LIVE_QUERY_SERVER_PUB_SUB_ADAPTER',
help:'LiveQuery pubsub adapter',
action:parsers.moduleOrObjectParser,
},
redisOptions:{
env:'PARSE_LIVE_QUERY_SERVER_REDIS_OPTIONS',
help:"parse-server's LiveQuery redisOptions",
action:parsers.objectParser,
},
redisURL:{
env:'PARSE_LIVE_QUERY_SERVER_REDIS_URL',
help:"parse-server's LiveQuery redisURL",
},
serverURL:{
env:'PARSE_LIVE_QUERY_SERVER_SERVER_URL',
help:
'This string should match the serverURL in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same serverURL.',
},
websocketTimeout:{
env:'PARSE_LIVE_QUERY_SERVER_WEBSOCKET_TIMEOUT',
help:
'Number of milliseconds between ping/pong frames. The WebSocket server sends ping/pong frames to the clients to keep the WebSocket alive. This value defines the interval of the ping/pong frame from the server to clients, defaults to 10 * 1000 ms (10 s).',
'An array of paths for which the feature should be enabled. The mount path must not be included, for example instead of `/parse/functions/myFunction` specifiy `functions/myFunction`. The entries are interpreted as regular expression, for example `functions/.*` matches all functions, `jobs/.*` matches all jobs, `classes/.*` matches all classes, `.*` matches all paths.',
action:parsers.arrayParser,
default:[],
},
ttl:{
env:'PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_TTL',
help:
'The duration in seconds after which a request record is discarded from the database, defaults to 300s.',
'Set the duration in minutes that a locked-out account remains locked out before automatically becoming unlocked.<br><br>Valid values are greater than `0` and less than `100000`.',
'Set the number of failed sign-in attempts that will cause a user account to be locked. If the account is locked. The account will unlock after the duration set in the `duration` option has passed and no further login attempts have been made.<br><br>Valid values are greater than `0` and less than `1000`.',
'Set to `true` if the account should be unlocked after a successful password reset.<br><br>Default is `false`.<br>Requires options `duration` and `threshold` to be set.',
'Set the number of previous password that will not be allowed to be set as new password. If the option is not set or set to `0`, no previous passwords will be considered.<br><br>Valid values are >= `0` and <= `20`.<br>Default is `0`.',
'Set to `true` if a password reset token should be reused in case another token is requested but there is a token that is still valid, i.e. has not expired. This avoids the often observed issue that a user requests multiple emails and does not know which link contains a valid token because each newly generated token would invalidate the previous token.<br><br>Default is `false`.',
'Set the validity duration of the password reset token in seconds after which the token expires. The token is used in the link that is set in the email. After the token expires, the link becomes invalid and a new link has to be sent. If the option is not set or set to `undefined`, then the token never expires.<br><br>For example, to expire the token after 2 hours, set a value of 7200 seconds (= 60 seconds * 60 minutes * 2 hours).<br><br>Default is `undefined`.',
'Set a callback function to validate a password to be accepted.<br><br>If used in combination with `validatorPattern`, the password must pass both to be accepted.',
'Set the regular expression validation pattern a password must match to be accepted.<br><br>If used in combination with `validatorCallback`, the password must pass both to be accepted.',
'Enables database real-time hooks to update single schema cache. Set to `true` if using multiple Parse Servers instances connected to the same database. Failing to do so will cause a schema change to not propagate to all instances and re-syncing will only happen when the instances restart. To use this feature with MongoDB, a replica set cluster with [change stream](https://docs.mongodb.com/manual/changeStreams/#availability) support is required.',
