Skip to content

docs: Clarify cluster option is CLI-only #10459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShravanthReddy wants to merge 1 commit into
base: alpha
Choose a base branch
from
+3 −3
Open

docs: Clarify cluster option is CLI-only #10459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Options/Definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ module.exports.ParseServerOptions = {
},
cluster: {
env: 'PARSE_SERVER_CLUSTER',
help: 'Run with cluster, optionally set the number of processes default to os.cpus().length',
help: 'Run with cluster, optionally set the number of processes default to os.cpus().length. This option only applies when Parse Server is started through the CLI; setting `cluster` on the ParseServer options object has no effect.',
action: parsers.numberOrBooleanParser,
},
collectionPrefix: {
Expand Down
2 changes: 1 addition & 1 deletion src/Options/docs.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/Options/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ export interface ParseServerOptions {
/* Mount path for the server, defaults to /parse
:DEFAULT: /parse */
mountPath: ?string;
/* Run with cluster, optionally set the number of processes default to os.cpus().length */
/* Run with cluster, optionally set the number of processes default to os.cpus().length. This option only applies when Parse Server is started through the CLI; setting `cluster` on the ParseServer options object has no effect. */
cluster: ?NumberOrBoolean;
/* middleware for express server, can be string or function */
middleware: ?((() => void) | string);
Expand Down