parse-community / parse-community/parse-server
Flag Parse Server options which can only be used in certain setups
Open
Nobody has claimed this yet.
type:docs
- Dominant language
- JavaScript
- Stars
- 21.4k
- Forks
- 4.8k
- Avg merge
- 7h 45m
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- I am not disclosing a vulnerability.
- I am not just asking a question.
- I have searched through existing issues.
- I can reproduce the issue with the latest version of Parse Server.
Issue Description
Certain Parse Server options can only be used (and only have an effect) when starting Parse Server via the CLI. These options lack this restriction in their documentation. For example:
trustProxy: has no effect when mounting Parse Server on a custom express app; in that caseexpressApp.set('trust proxy', ...);needs to be used insteadclusters: can only be used when launching Parse Server via the CLI; has no effect when instantiating a single Parse Server instance
Solution
- Add limitation to the docs for affected options.
- If technically possible log a warning when an option is used in a way where it is ineffective
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the documentation for trustProxy and clusters, along with the CLI and custom Express initialization paths described in the issue. Identify other options with the same setup limitation, document their valid contexts, and assess whether ineffective use can safely produce a warning; done means the affected options clearly state these restrictions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- express, javascript, nodejs
- Domain
- backend, cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100