Skip to content

Commit

Permalink
docs: add info about --dev parameter (#1842)
Browse files Browse the repository at this point in the history
* docs: Add info about --dev parameter

* docs: restyle --dev parameter explanation

* minor reformatting

Co-authored-by: Manuel <5673677+mtrezza@users.noreply.github.com>
  • Loading branch information
cyb3rko and mtrezza authored Oct 7, 2021
1 parent 1418ac1 commit fc86e10
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ parse-dashboard --dev --appId yourAppId --masterKey yourMasterKey --serverURL "h

You may set the host, port and mount path by supplying the `--host`, `--port` and `--mountPath` options to parse-dashboard. You can use anything you want as the app name, or leave it out in which case the app ID will be used.

NB: the `--dev` parameter is disabling production-ready security features, do not use this parameter when starting the dashboard in production. This parameter is useful if you are running on docker.
The `--dev` parameter disables production-ready security features. This parameter is useful when running Parse Dashboard on Docker. Using this parameter will:

- allow insecure http connections from anywhere, bypassing the option `allowInsecureHTTP`
- allow the Parse Server `masterKey` to be transmitted in cleartext without encryption
- allow dashboard access without user authentication

> ⚠️ Do not use this parameter when deploying Parse Dashboard in a production environment.
After starting the dashboard, you can visit http://localhost:4040 in your browser:

Expand Down

0 comments on commit fc86e10

Please sign in to comment.