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
Copy file name to clipboardExpand all lines: README.md
+9-1
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,7 @@ Before you start make sure you have installed:
111
111
### Compatibility
112
112
113
113
#### Node.js
114
+
114
115
Parse Server is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
115
116
116
117
| Version | Latest Version | End-of-Life | Compatible |
@@ -122,6 +123,7 @@ Parse Server is continuously tested with the most recent releases of Node.js to
122
123
| Node.js 18 | 18.1.0 | April 2025 | ✅ Yes |
123
124
124
125
#### MongoDB
126
+
125
127
Parse Server is continuously tested with the most recent releases of MongoDB to ensure compatibility. We follow the [MongoDB support schedule](https://www.mongodb.com/support-policy) and only test against versions that are officially supported and have not reached their end-of-life date.
126
128
127
129
| Version | Latest Version | End-of-Life | Compatible |
@@ -134,6 +136,7 @@ Parse Server is continuously tested with the most recent releases of MongoDB to
134
136
| MongoDB 5.2 | 5.2.1 | TBD | ✅ Yes |
135
137
136
138
#### PostgreSQL
139
+
137
140
Parse Server is continuously tested with the most recent releases of PostgreSQL and PostGIS to ensure compatibility, using [PostGIS docker images](https://registry.hub.docker.com/r/postgis/postgis/tags?page=1&ordering=last_updated). We follow the [PostgreSQL support schedule](https://www.postgresql.org/support/versioning) and [PostGIS support schedule](https://www.postgis.net/eol_policy/) and only test against versions that are officially supported and have not reached their end-of-life date. Due to the extensive PostgreSQL support duration of 5 years, Parse Server drops support if a version is older than 3.5 years and a newer version has been available for at least 2.5 years.
138
141
139
142
| Version | PostGIS Version | End-of-Life | Parse Server Support End | Compatible |
@@ -144,6 +147,7 @@ Parse Server is continuously tested with the most recent releases of PostgreSQL
144
147
| Postgres 14 | 3.2 | November 2026 | April 2025 | ✅ Yes |
145
148
146
149
### Locally
150
+
147
151
```bash
148
152
$ npm install -g parse-server mongodb-runner
149
153
$ mongodb-runner start
@@ -236,7 +240,6 @@ $ curl -X GET \
236
240
}
237
241
]
238
242
}
239
-
240
243
```
241
244
242
245
To learn more about using saving and querying objects on Parse Server, check out the [Parse documentation](http://docs.parseplatform.org).
@@ -386,6 +389,7 @@ const server = ParseServer({
386
389
```
387
390
388
391
## Custom Routes
392
+
389
393
**Caution, this is an experimental feature that may not be appropriate for production.**
390
394
391
395
Custom routes allow to build user flows with webpages, similar to the existing password reset and email verification features. Custom routes are defined with the `pages` option in the Parse Server configuration:
@@ -418,6 +422,7 @@ The above route can be invoked by sending a `GET` request to:
418
422
The `handler` receives the `request` and returns a `custom_page.html` webpage from the `pages.pagesPath` directory as response. The advantage of building a custom route this way is that it automatically makes use of Parse Server's built-in capabilities, such as [page localization](#pages) and [dynamic placeholders](#dynamic-placeholders).
419
423
420
424
### Reserved Paths
425
+
421
426
The following paths are already used by Parse Server's built-in features and are therefore not available for custom routes. Custom routes with an identical combination of`path` and `method` are ignored.
422
427
423
428
| Path |HTTP Method | Feature |
@@ -513,6 +518,7 @@ Identical requests are identified by their request header `X-Parse-Request-Id`.
513
518
Deduplication is only done for object creation and update (`POST` and `PUT` requests). Deduplication is not done for object finding and deletion (`GET` and `DELETE` requests), as these operations are already idempotent by definition.
514
519
515
520
### Configuration example <!-- omit in toc -->
521
+
516
522
```
517
523
let api = new ParseServer({
518
524
idempotencyOptions: {
@@ -521,6 +527,7 @@ let api = new ParseServer({
521
527
}
522
528
}
523
529
```
530
+
524
531
### Parameters <!-- omit in toc -->
525
532
526
533
| Parameter | Optional | Type | Default value | Example values | Environment variable | Description |
@@ -553,6 +560,7 @@ Assuming the script above is named, `parse_idempotency_delete_expired_records.sh
553
560
## Localization
554
561
555
562
### Pages
563
+
556
564
**Caution, this is an experimental feature that may not be appropriate for production.**
557
565
558
566
Custom pages as well as feature pages (e.g. password reset, email verification) can be localized with the `pages` option in the Parse Server configuration:
0 commit comments