tk2232/parse-init repository overview

⁠parse-inti-docker

Parse server init container

⁠ENV

⁠SERVER_URL

default: SERVER_URL="0.0.0.0"

⁠PORT

default: PORT=1337

⁠MASTER_KEY

MASTER_KEY="myMasterKey"

⁠CLIENT_KEY

Optional
CLIENT_KEY="myClientKey"

⁠MONGODB_FULL_URI

Select MONGODB_FULL_URI or MONGODB_HOST with options or MONGODB_SERVICE with options
Full MongoDb uri example: MONGODB_FULL_URI="mongodb://user:password@url:port/?options/db"

⁠MONGODB_HOST

Select MONGODB_FULL_URI or MONGODB_HOST with options or MONGODB_SERVICE with options
MONGODB_URI"mongodb0.example.com"

⁠MONGODB_SERVICE

Select MONGODB_FULL_URI or MONGODB_HOST with options or MONGODB_SERVICE with options
MONGODB_SERVICE="my-service-name"

⁠MONGODB_USER

MONGODB_USER="mongodbUser"

⁠MONGODB_PASSWORD

MONGODB_PASSWORD="mongoUserPassword"

⁠MONGODB_PORT

MONGODB_PORT=27017

⁠MONGODB_DATABASE

MONGODB_DATABASE="dbName"

⁠MONGODB_OPTIONS

MONGODB_OPTIONS="/?authSource=admin"

⁠APP_ID

APP_ID="myAppID"

⁠APP_NAME

APP_NAME="myAppName"

⁠MOUNT_PATH

default: MOUNT_PATH="/parse"

⁠CLOUD_CODE_PATH

default: CLOUD_CODE_PATH="./cloud/main.js"
disable: CLOUD_CODE_PATH = ""

⁠REDIS_CACHE_PASSWORD

optional
REDIS_CACHE_PASSWORD="myRedisCacheSecret"

⁠REDIS_CACHE_OPTIONS

Options for redis.
Possible options: https://www.npmjs.com/package/redis#rediscreateclient⁠
Do not add the password here.
Use REDIS_CACHE_PASSWORD for the password.
Options example: REDIS_CACHE_OPTIONS='{"url": "example.com","db": "test-db", "option2": "value"}'

⁠MAX_UPLOAD_SIZE

default: 10mb
example: MAX_UPLOAD_SIZE = "20mb"

⁠LIVE_QUERY_CLASSNAMES

optional
example: LIVE_QUERY_CLASSNAMES = 'apple,orange,pear,banana,raspberry,peach'
No whitespaces allowed
wrong: LIVE_QUERY_CLASSNAMES = 'apple, orange, pear, banana, raspberry, peach'

⁠LIVE_QUERY_REDIS_URL

optional
Redis url or Service
example: LIVE_QUERY_REDIS_URL="redis://parse-redis-service" or LIVE_QUERY_REDIS_URL="redis://url"

⁠LIVE_QUERY_REDIS_PASSWORD

optional
example: LIVE_QUERY_REDIS_PASSWORD="myRedisSecret"

⁠LIVE_QUERY_REDIS_OPTIONS

optional
Options for redis. Possible options: https://www.npmjs.com/package/redis#rediscreateclient⁠
Do not add the password here.
Do not add the redis url here.
Use LIVE_QUERY_REDIS_PASSWORD for the password.
Use LIVE_QUERY_REDIS_URL for the url.
example: LIVE_QUERY_REDIS_OPTIONS='{"db": "test-db", "option2": "value"}'

⁠ACCOUNT_LOCKOUT

optional
failed login attempts
default: {duration: 5, threshold: 3}
example: ACCOUNT_LOCKOUT = '{"duration": 2, "threshold": 6}'

⁠PUBLIC_SERVER_URL

optional
ref: https://docs.parseplatform.org/parse-server/guide/⁠
When using files on Parse, you will need to use the publicServerURL option in your Parse Server config.
This is the URL that files will be accessed from, so it should be a URL that resolves to your Parse Server. Make sure to include your mount point in this URL.

⁠MOUNT_GRAPHQL

optional
default: MOUNT_GRAPHQL=false

⁠GRAPHQL_PATH

optional
default: GRAPHQL_PATH="/graphql"

⁠MOUNT_PLAYGROUND

optional
default: MOUNT_PLAYGROUND=false
ref: https://github.com/parse-community/parse-server#using-expressjs⁠
Note: Do NOT use --mountPlayground option in production. Parse Dashboard has a built-in GraphQL Playground and it is the recommended option for production apps.

⁠PLAYGROUND_PATH

optional
default: PLAYGROUND_PATH="/playground"

⁠MAX_LOG_FILES

default: MAX_LOG_FILES=1000
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.

⁠VERBOSE

default: VERBOSE=false
Set the logging to verbose

⁠EXTRA_ENV_VARS

optional
stringified JSON with extra environments from https://github.com/parse-community/parse-server/blob/master/src/Options/index.js⁠
example: "{"jsonLogs": true}"

⁠Docker

docker run \
-e MASTER_KEY="masterKey" \
-e MONGODB_HOST="localhost" \
-e APP_ID="appId" \
-e APP_NAME="appName" \
-e REDIS_CACHE_PASSWORD="redisCachepw" \
-e REDIS_CACHE_OPTIONS='{"url": "redis://redis-service}' \
-e LIVE_QUERY_CLASSNAMES='apple,orange,pear,banana,raspberry,peach' \
-e LIVE_QUERY_REDIS_PASSWORD="liveQueryRedisPW" \
-e LIVE_QUERY_REDIS_URL="redis//redis-url" \
-e MONGODB_URI="example.mongo.com" \
tk2232/parse-init