You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project adheres to the [Open Code of Conduct](http://todogroup.org/opencodeofconduct/#Parse Server/[email protected]). By participating, you are expected to honor this code.
A Parse.com API compatible router package for Express
9
+
Parse Server is an open source version of the Parse backend that can be deployed to any infrastructure that can run Node.js.
10
+
11
+
Parse Server works with the Express web application framework. It can be added to existing web applications, or run by itself.
8
12
9
13
Read the announcement blog post here: http://blog.parse.com/announcements/introducing-parse-server-and-the-database-migration-tool/
10
14
11
-
Read the migration guide here: https://parse.com/docs/server/guide#migrating
15
+
## Documentation
16
+
17
+
Documentation for Parse Server is available in the [wiki](https://github.com/ParsePlatform/parse-server/wiki) for this repository. The [Parse Server guide](https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide) is a good place to get started.
18
+
19
+
If you're interested in developing for Parse Server, the [Development guide](https://github.com/ParsePlatform/parse-server/wiki/Development-Guide) will help you get set up.
20
+
21
+
### Example Project
22
+
23
+
Check out the [parse-server-example project](https://github.com/ParsePlatform/parse-server-example) repository for an example of a Node.js application that uses the parse-server module on Express.
24
+
25
+
### Migration Guide
26
+
27
+
Migrate your existing Parse apps to your own Parse Server. The hosted version of Parse will be fully retired on January 28th, 2017. If you are planning to migrate an app, you need to begin work as soon as possible. Learn more in the [Migration guide](https://github.com/ParsePlatform/parse-server/wiki/Migrating-an-Existing-Parse-App).
12
28
13
-
There is a development wiki here on GitHub: https://github.com/ParsePlatform/parse-server/wiki
14
29
15
-
We also have an [example project](https://github.com/ParsePlatform/parse-server-example) using the parse-server module on Express.
16
30
17
31
---
18
32
33
+
19
34
#### Basic options:
20
35
21
36
* databaseURI (required) - The connection string for your database, i.e. `mongodb://user:[email protected]/dbname`
@@ -36,12 +51,67 @@ The client keys used with Parse are no longer necessary with parse-server. If y
36
51
* restAPIKey
37
52
* dotNetKey
38
53
54
+
#### OAuth Support
55
+
56
+
parse-server supports 3rd party authentication with
57
+
58
+
* Twitter
59
+
* Meetup
60
+
* Linkedin
61
+
* Google
62
+
* Instagram
63
+
* Facebook
64
+
65
+
66
+
Configuration options for these 3rd-party modules is done with the oauth option passed to ParseServer:
67
+
68
+
```
69
+
{
70
+
oauth: {
71
+
twitter: {
72
+
consumer_key: "", // REQUIRED
73
+
consumer_secret: "" // REQUIRED
74
+
},
75
+
facebook: {
76
+
appIds: "FACEBOOK APP ID"
77
+
}
78
+
}
79
+
80
+
}
81
+
```
82
+
83
+
#### Custom Authentication
84
+
85
+
It is possible to leverage the OAuth support with any 3rd party authentication that you bring in.
86
+
87
+
```
88
+
{
89
+
90
+
oauth: {
91
+
my_custom_auth: {
92
+
module: "PATH_TO_MODULE" // OR object,
93
+
option1: "",
94
+
option2: "",
95
+
}
96
+
}
97
+
}
98
+
```
99
+
100
+
On this module, you need to implement and export those two functions `validateAuthData(authData, options) {} ` and `validateAppId(appIds, authData) {}`.
101
+
102
+
For more informations about custom auth please see the examples:
* filesAdapter - The default behavior (GridStore) can be changed by creating an adapter class (see [`FilesAdapter.js`](https://github.com/ParsePlatform/parse-server/blob/master/src/Adapters/Files/FilesAdapter.js))
42
112
* databaseAdapter (unfinished) - The backing store can be changed by creating an adapter class (see `DatabaseAdapter.js`)
43
113
* loggerAdapter - The default behavior/transport (File) can be changed by creating an adapter class (see [`LoggerAdapter.js`](https://github.com/ParsePlatform/parse-server/blob/master/src/Adapters/Logger/LoggerAdapter.js))
44
-
114
+
* enableAnonymousUsers - Defaults to true. Set to false to disable anonymous users.
You can configure the Parse Server with environment variables:
88
158
89
-
```js
159
+
```js
90
160
PARSE_SERVER_DATABASE_URI
91
161
PARSE_SERVER_CLOUD_CODE_MAIN
92
162
PARSE_SERVER_COLLECTION_PREFIX
93
163
PARSE_SERVER_APPLICATION_ID// required
94
-
PARSE_SERVER_CLIENT_KEY
164
+
PARSE_SERVER_CLIENT_KEY
95
165
PARSE_SERVER_REST_API_KEY
96
166
PARSE_SERVER_DOTNET_KEY
97
167
PARSE_SERVER_JAVASCRIPT_KEY
@@ -137,3 +207,7 @@ You can also set up an app on Parse, providing the connection string for your mo
137
207
### Not supported
138
208
139
209
*`Parse.User.current()` or `Parse.Cloud.useMasterKey()` in cloud code. Instead of `Parse.User.current()` use `request.user` and instead of `Parse.Cloud.useMasterKey()` pass `useMasterKey: true` to each query. To make queries and writes as a specific user within Cloud Code, you need the user's session token, which is available in `request.user.getSessionToken()`.
210
+
211
+
## Contributing
212
+
213
+
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).
0 commit comments