help:'account lockout policy for failed login attempts',
action:parsers.objectParser,
},
allowClientClassCreation:{
env:'PARSE_SERVER_ALLOW_CLIENT_CLASS_CREATION',
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',
'Replace HTTP Interface when using JS SDK in current node runtime, defaults to false. Caution, this is an experimental feature that may not be appropriate for production.',
'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.',
"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.',
