Skip to content

Commit 4e70e7b

Browse files
committed
add best practice page
1 parent 23e78ae commit 4e70e7b

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

BEST_PRACTICE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Best Practice <!-- omit in toc -->
2+
3+
- [Security](#security)
4+
- [Firewall](#firewall)
5+
- [Optimization](#optimization)
6+
- [Database](#database)
7+
- [Queries](#queries)
8+
9+
*This page is a work in progress and by no means complete. If you have any suggestions, please open a PR to extend the list.*
10+
11+
## Security
12+
13+
### Firewall
14+
15+
Protect all Parse Server endpoints using a Firewall. For example, rate-limiting the number of requests per IP address can mitigate the risk of malicious attempts to scape user data, flood your database and simple DDoS attacks.
16+
17+
## Optimization
18+
19+
The following is a list of design considerations to optimize data traffic.
20+
21+
### Database
22+
23+
- Use short field names; field names need to be stored in the database just like the field values; short field names not only require less database storage but also reduce the data traffic between database, server and client.
24+
25+
### Queries
26+
27+
- Use `select` and `exclude` to transfer only the fields that you need instead of the whole object.

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ ___
150150
- Add CI check to add changelog entry (Manuel Trezza) [#7512](https://github.com/parse-community/parse-server/pull/7512)
151151
- Refactor: uniform issue templates across repos (Manuel Trezza) [#7528](https://github.com/parse-community/parse-server/pull/7528)
152152
- ci: bump ci environment (Manuel Trezza) [#7539](https://github.com/parse-community/parse-server/pull/7539)
153+
- docs: add best practice page (Manuel Trezza) [#7541](https://github.com/parse-community/parse-server/pull/7541)
153154

154155
## 4.10.3
155156
[Full Changelog](https://github.com/parse-community/parse-server/compare/4.10.2...4.10.3)

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ The full documentation for Parse Server is available in the [wiki](https://githu
7676
- [Reserved Keys](#reserved-keys)
7777
- [Parameters](#parameters-1)
7878
- [Logging](#logging)
79+
- [Best Practice](#best-practice)
7980
- [Deprecations](#deprecations)
8081
- [Live Query](#live-query)
8182
- [GraphQL](#graphql)
@@ -740,6 +741,10 @@ Logs are also viewable in Parse Dashboard.
740741
741742
**Want new line delimited JSON error logs (for consumption by CloudWatch, Google Cloud Logging, etc)?** Pass the `JSON_LOGS` environment variable when starting `parse-server`. Usage :- `JSON_LOGS='1' parse-server --appId APPLICATION_ID --masterKey MASTER_KEY`
742743
744+
# Best Practice
745+
746+
See the [Best Practice](https://github.com/parse-community/parse-server/blob/master/BEST_PRACTICE.md) page for security considerations and common server and database optimizations.
747+
743748
# Deprecations
744749
745750
See the [Deprecation Plan](https://github.com/parse-community/parse-server/blob/master/DEPRECATIONS.md) for an overview of deprecations and planned breaking changes.

0 commit comments

Comments
 (0)