ParseServerOptions

ParseServerOptions

Properties:
Name Type Description
accountLockout Any

account lockout policy for failed login attempts

allowClientClassCreation Boolean

Enable (or disable) client class creation, defaults to true

analyticsAdapter Adapter.<AnalyticsAdapter>

Adapter module for the analytics

appId String

Your Parse Application ID

appName String

Sets the app name

auth Any

Configuration for your authentication providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication

cacheAdapter Adapter.<CacheAdapter>

Adapter module for the cache

cacheMaxSize Number

Sets the maximum size for the in memory cache, defaults to 10000

cacheTTL Number

Sets the TTL for the in memory cache (in ms), defaults to 5000 (5 seconds)

clientKey String

Key for iOS, MacOS, tvOS clients

cloud String

Full path to your cloud code main.js

cluster Number | Boolean

Run with cluster, optionally set the number of processes default to os.cpus().length

collectionPrefix String

A collection prefix for the classes

customPages CustomPagesOptions

custom pages for password validation and reset

databaseAdapter Adapter.<StorageAdapter>

Adapter module for the database

databaseOptions Any

Options to pass to the mongodb client

databaseURI String

The full URI to your database. Supported databases are mongodb or postgres.

directAccess Boolean

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.

dotNetKey String

Key for Unity and .Net SDK

emailAdapter Adapter.<MailAdapter>

Adapter module for email sending

emailVerifyTokenValidityDuration Number

Email verification token validity duration, in seconds

enableAnonymousUsers Boolean

Enable (or disable) anon users, defaults to true

enableExpressErrorHandler Boolean

Enables the default express error handler for all errors

enableSingleSchemaCache Boolean

Use a single schema cache shared across requests. Reduces number of queries made to _SCHEMA, defaults to false, i.e. unique schema cache per request.

expireInactiveSessions Boolean

Sets wether we should expire the inactive sessions, defaults to true

fileKey String

Key for your files

filesAdapter Adapter.<FilesAdapter>

Adapter module for the files sub-system

graphQLPath String

Mount path for the GraphQL endpoint, defaults to /graphql

host String

The host to serve ParseServer on, defaults to 0.0.0.0

javascriptKey String

Key for the Javascript SDK

jsonLogs Boolean

Log as structured JSON objects

liveQuery LiveQueryOptions

parse-server's LiveQuery configuration object

liveQueryServerOptions LiveQueryServerOptions

Live query server configuration options (will start the liveQuery server)

loggerAdapter Adapter.<LoggerAdapter>

Adapter module for the logging sub-system

logLevel String

Sets the level for logs

logsFolder String

Folder for the logs (defaults to './logs'); set to null to disable file based logging

masterKey String

Your Parse Master Key

masterKeyIps Array.<String>

Restrict masterKey to be used by only these ips, defaults to [] (allow all ips)

maxLimit Number

Max value for limit option on queries, defaults to unlimited

maxUploadSize String

Max file size for uploads, defaults to 20mb

middleware Union

middleware for express server, can be string or function

mountGraphQL Boolean

Mounts the GraphQL endpoint

mountPath String

Mount path for the server, defaults to /parse

mountPlayground Boolean

Mounts the GraphQL Playground - never use this option in production

objectIdSize Number

Sets the number of characters in generated object id's, default 10

passwordPolicy Any

Password policy for enforcing password related rules

playgroundPath String

Mount path for the GraphQL Playground, defaults to /playground

port Number

The port to run the ParseServer, defaults to 1337.

preserveFileName Boolean

Enable (or disable) the addition of a unique hash to the file names

preventLoginWithUnverifiedEmail Boolean

Prevent user from login if email is not verified and PARSE_SERVER_VERIFY_USER_EMAILS is true, defaults to false

protectedFields ProtectedFields

Protected fields that should be treated with extra security when fetching details.

publicServerURL String

Public URL to your parse server with http:// or https://.

push Any

Configuration for push, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#push-notifications

readOnlyMasterKey String

Read-only key, which has the same capabilities as MasterKey without writes

restAPIKey String

Key for REST calls

revokeSessionOnPasswordReset Boolean

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.

scheduledPush Boolean

Configuration for push scheduling, defaults to false.

schemaCacheTTL Number

The TTL for caching the schema for optimizing read/write operations. You should put a long TTL when your DB is in production. default to 5000; set 0 to disable.

serverURL String

URL to your parse server with http:// or https://.

sessionLength Number

Session duration, in seconds, defaults to 1 year

silent Boolean

Disables console output

skipMongoDBServer13732Workaround Boolean

Circumvent Parse workaround for historical MongoDB bug SERVER-13732

startLiveQueryServer Boolean

Starts the liveQuery server

userSensitiveFields Array.<String>

Personally identifiable information fields in the user table the should be removed for non-authorized users. Deprecated @see protectedFields

verbose Boolean

Set the logging to verbose

verifyUserEmails Boolean

Enable (or disable) user email validation, defaults to false

webhookKey String

Key sent with outgoing webhook calls