diff --git a/README.md b/README.md index bd75e0ab7d..71fdc87a37 100644 --- a/README.md +++ b/README.md @@ -59,14 +59,14 @@ $ mongodb-runner start $ parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test ``` ***Note:*** *If installation with* `-g` *fails due to permission problems* (`npm ERR! code 'EACCES'`), *please refer to [this link](https://docs.npmjs.com/getting-started/fixing-npm-permissions).* - + ### Inside a Docker container ``` $ docker build --tag parse-server . $ docker run --name my-mongo -d mongo $ docker run --name my-parse-server --link my-mongo:mongo -d parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://mongo/test -``` +``` You can use any arbitrary string as your application id and master key. These will be used by your clients to authenticate with the Parse Server. @@ -322,15 +322,15 @@ var server = ParseServer({ }, // optional settings to enforce password policies passwordPolicy: { - // Two optional settings to enforce strong passwords. Either one or both can be specified. + // Two optional settings to enforce strong passwords. Either one or both can be specified. // If both are specified, both checks must pass to accept the password - // 1. a RegExp object or a regex string representing the pattern to enforce + // 1. a RegExp object or a regex string representing the pattern to enforce validatorPattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})/, // enforce password with at least 8 char with at least 1 lower case, 1 upper case and 1 digit // 2. a callback function to be invoked to validate the password - validatorCallback: (password) => { return validatePassword(password) }, + validatorCallback: (password) => { return validatePassword(password) }, validationError: 'Password must contain at least 1 digit.' // optional error message to be sent instead of the default "Password does not meet the Password Policy requirements." message. doNotAllowUsername: true, // optional setting to disallow username in passwords - maxPasswordAge: 90, // optional setting in days for password expiry. Login fails if user does not reset the password within this period after signup/last reset. + maxPasswordAge: 90, // optional setting in days for password expiry. Login fails if user does not reset the password within this period after signup/last reset. maxPasswordHistory: 5, // optional setting to prevent reuse of previous n passwords. Maximum value that can be specified is 20. Not specifying it or specifying 0 will not enforce history. //optional setting to set a validity duration for password reset links (in seconds) resetTokenValidityDuration: 24*60*60, // expire after 24 hours @@ -390,7 +390,7 @@ Parse Server allows developers to choose from several options when hosting files # Upgrading to 3.0.0 -Starting 3.0.0, parse-server uses the JS SDK version 2.0. +Starting 3.0.0, parse-server uses the JS SDK version 2.0. In short, parse SDK v2.0 removes the backbone style callbacks as well as the Parse.Promise object in favor of native promises. All the Cloud Code interfaces also have been updated to reflect those changes, and all backbone style response objects are removed and replaced by Promise style resolution. @@ -427,17 +427,12 @@ You can also use your own forks, and work in progress branches by specifying the npm install github:myUsername/parse-server#my-awesome-feature ``` -And don't forget, if you plan to deploy it remotely, you should run `npm install` with the `--save` option. +And don't forget, if you plan to deploy it remotely, you should run `npm install` with the `--save` option. # Contributing We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the [Contributing to Parse Server guide](CONTRIBUTING.md). ------ - -As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code. - - # Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/parse-server#backer)] @@ -509,3 +504,6 @@ Become a sponsor and get your logo on our README on Github with a link to your s +----- + +As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.