Skip to content

docs: Improve dashboard options documentation in README #2987

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

Merged
merged 20 commits into from
Oct 25, 2025
Merged

docs: Improve dashboard options documentation in README #2987

Changes from 3 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
cdfa197
feat: improve README config table
coratgerl Sep 30, 2025
e5dfcb3
feat: more configuration
coratgerl Sep 30, 2025
1424943
fix: remove ai agent from config
coratgerl Sep 30, 2025
9ee3ac2
fix: coderabit feedback
coratgerl Sep 30, 2025
eb5497e
fix: feedback
coratgerl Oct 2, 2025
d9a2601
fix: more
coratgerl Oct 2, 2025
bc89dc0
fix: feedbacks
coratgerl Oct 4, 2025
b31b89d
fix: more
coratgerl Oct 4, 2025
ff6c8bf
fix: more
coratgerl Oct 4, 2025
7876028
fix: feedbacks
coratgerl Oct 4, 2025
d7c17f8
fix: feedbacks
coratgerl Oct 11, 2025
2d73264
fix: more style
coratgerl Oct 11, 2025
59211c9
Merge branch 'alpha' into feat-improve-readme-config
mtrezza Oct 14, 2025
722559f
fix: feedbacks
coratgerl Oct 14, 2025
8fa6553
Merge branch 'feat-improve-readme-config' of github.com:coratgerl/par…
coratgerl Oct 14, 2025
c3829d7
fix: auto review
coratgerl Oct 14, 2025
ee30578
fix: master key ttl
coratgerl Oct 14, 2025
9e8324c
fix: ttl only for function
coratgerl Oct 14, 2025
1dacda7
Merge branch 'alpha' into feat-improve-readme-config
mtrezza Oct 15, 2025
261c2e8
Merge branch 'alpha' into feat-improve-readme-config
mtrezza Oct 25, 2025
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
142 changes: 117 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,31 +142,123 @@ Parse Dashboard is continuously tested with the most recent releases of Node.js

### Options

| Parameter | Type | Optional | Default | Example | Description |
|----------------------------------------|---------------------|----------|---------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `apps` | Array<Object> | no | - | `[{ ... }, { ... }]` | The apps that are configured for the dashboard. |
| `apps.appId` | String | yes | - | `"myAppId"` | The Application ID for your Parse Server instance. |
| `apps.masterKey` | String \| Function | yes | - | `"exampleMasterKey"`, `() => "exampleMasterKey"` | The master key for full access to Parse Server. It can be provided directly as a String or as a Function returning a String. |
| `apps.masterKeyTtl` | Number | no | - | `3600` | Time-to-live (TTL) for the master key in seconds. This defines how long the master key is cached before the `masterKey` function is re-triggered. |
| `apps.serverURL` | String | yes | - | `"http://localhost:1337/parse"` | The URL where your Parse Server is running. |
| `apps.appName` | String | no | - | `"MyApp"` | The display name of the app in the dashboard. |
| `infoPanel` | Array<Object> | yes | - | `[{ ... }, { ... }]` | The [info panel](#info-panel) configuration. |
| `infoPanel[*].title` | String | no | - | `User Details` | The panel title. |
| `infoPanel[*].classes` | Array<String> | no | - | `["_User"]` | The classes for which the info panel should be displayed. |
| `infoPanel[*].cloudCodeFunction` | String | no | - | `getUserDetails` | The Cloud Code Function which received the selected object in the data browser and returns the response to be displayed in the info panel. |
| `infoPanel[*].prefetchObjects` | Number | yes | `0` | `2` | Number of next rows to prefetch when browsing sequential rows. For example, `2` means the next 2 rows will be fetched in advance. |
| `infoPanel[*].prefetchStale` | Number | yes | `0` | `10` | Duration in seconds after which prefetched data is discarded as stale. |
| `apps.scripts` | Array<Object> | yes | `[]` | `[{ ... }, { ... }]` | The scripts that can be executed for that app. |
| `apps.scripts.title` | String | no | - | `'Delete User'` | The title that will be displayed in the data browser context menu and the script run confirmation dialog. |
| `apps.scripts.classes` | Array<String> | no | - | `['_User']` | The classes of Parse Objects for which the scripts can be executed. |
| `apps.scripts.cloudCodeFunction` | String | no | - | `'deleteUser'` | The name of the Parse Cloud Function to execute. |
| `apps.scripts.executionBatchSize` | Integer | yes | `1` | `10` | The batch size with which a script should be executed on all selected objects. For example, with 50 objects selected, a batch size of 10 means the script will run on 10 objects in parallel, running a total of 5 batches in serial. |
| `apps.scripts.showConfirmationDialog` | Bool | yes | `false` | `true` | Is `true` if a confirmation dialog should be displayed before the script is executed, `false` if the script should be executed immediately. |
| `apps.scripts.confirmationDialogStyle` | String | yes | `info` | `critical` | The style of the confirmation dialog. Valid values: `info` (blue style), `critical` (red style). |
| `apps.cloudConfigHistoryLimit` | Integer | yes | `100` | `100` | The number of historic values that should be saved in the Cloud Config change history. Valid values: `0`...`Number.MAX_SAFE_INTEGER`.
| `apps.config` | Object | yes | - | `{ ... }` | App settings option used to store dashboard configuration on the server.
| `apps.config.className` | String | yes | _ | `DashboardConfig` | The table name used to save and migrate the dashboard configuration. |

This section provides a comprehensive reference for all Parse Dashboard configuration options that can be used in the configuration file, via CLI arguments, or as environment variables.

#### Configuration File Options

##### App Configuration (`apps` array)

| Parameter | Type | Optional | Default | CLI | Env Variable | Example | Description |
|-----------|------|----------|---------|-----|--------------|---------|-------------|
| `appId` | String | no | - | `--appId` | `PARSE_DASHBOARD_APP_ID` | `"myAppId"` | The Application ID for your Parse Server instance. |
| `masterKey` | String \| Function | no | - | `--masterKey` | `PARSE_DASHBOARD_MASTER_KEY` | `"key"` | Master key for full access. Can be a String or Function returning a String. |
| `serverURL` | String | no | - | `--serverURL` | `PARSE_DASHBOARD_SERVER_URL` | `"http://localhost:1337/parse"` | The URL where your Parse Server is running. |
| `appName` | String | yes | `appId` | `--appName` | `PARSE_DASHBOARD_APP_NAME` | `"MyApp"` | Display name of the app. |
| `masterKeyTtl` | Number | yes | - | `--masterKeyTtl` | - | `3600` | TTL for master key cache in seconds (when `masterKey` is a Function). |
| `readOnlyMasterKey` | String | yes | - | - | - | `"myReadOnlyKey"` | Read-only master key that prevents mutations. |
| `clientKey` | String | yes | - | - | - | `"myClientKey"` | Client key for Parse SDK (legacy, mostly unused). |
| `javascriptKey` | String | yes | - | - | - | `"myJsKey"` | JavaScript key for Parse SDK (legacy, mostly unused). |
| `restKey` | String | yes | - | - | - | `"myRestKey"` | REST API key for server-side REST applications. |
| `windowsKey` | String | yes | - | - | - | `"myWindowsKey"` | Windows SDK key (legacy, mostly unused). |
| `webhookKey` | String | yes | - | - | - | `"myWebhookKey"` | Webhook key for Cloud Code Webhooks. |
| `apiKey` | String | yes | - | - | - | `"myFileKey"` | File key (also called apiKey) for file migrations. |
| `graphQLServerURL` | String | yes | - | `--graphQLServerURL` | `PARSE_DASHBOARD_GRAPHQL_SERVER_URL` | `"http://localhost:1337/graphql"` | The URL where your Parse GraphQL Server is running. |
| `appNameForURL` | String | yes | `appName` | - | - | `"my-app"` | URL-friendly name used in dashboard URLs. |
| `production` | Boolean | yes | `false` | - | - | `true` | Mark as production environment. |
| `iconName` | String | yes | - | - | - | `"icon.png"` | Filename of app icon (requires global `iconsFolder`). |
| `primaryBackgroundColor` | String | yes | - | - | - | `"#FFA500"` | Primary background color (CSS value). |
| `secondaryBackgroundColor` | String | yes | - | - | - | `"#FF4500"` | Secondary background color (CSS value). |
| `supportedPushLocales` | Array<String> | yes | - | - | - | `["en","fr"]` | Supported locales for push notifications. |
| `preventSchemaEdits` | Boolean | yes | `false` | - | - | `true` | Prevent schema modifications through the dashboard. |
| `columnPreference` | Object | yes | - | - | - | `{"_User":[...]}` | Column visibility/sorting/filtering preferences. See [column preferences details](#prevent-columns-sorting). |
| `classPreference` | Object | yes | - | - | - | `{"_Role":{...}}` | Persistent filters for all users. See [persistent filters details](#persistent-filters). |
| `enableSecurityChecks` | Boolean | yes | `false` | - | - | `true` | Enable security checks under App Settings > Security. |
| `cloudConfigHistoryLimit` | Integer | yes | `100` | - | - | `200` | Number of historic Cloud Config values (0 to Number.MAX_SAFE_INTEGER). |
| `config` | Object | yes | - | - | - | `{...}` | Settings for storing dashboard config on server. |
| `config.className` | String | yes | - | - | - | `"DashboardConfig"` | Table name for dashboard configuration. |
| `scripts` | Array<Object> | yes | `[]` | - | - | `[{...}]` | Scripts for this app. See [scripts table below](#scripts-configuration). |
| `infoPanel` | Array<Object> | yes | - | - | - | `[{...}]` | Info panel config. See [info panel table below](#info-panel-configuration). |

##### Column Preference Configuration (`apps[].columnPreference.<className>[]`)

Each class in `columnPreference` can have an array of column configurations:

| Parameter | Type | Optional | Default | Example | Description |
|-----------|------|----------|---------|---------|-------------|
| `name` | String | no | - | `"createdAt"` | Column/field name. |
| `visible` | Boolean | yes | `true` | `false` | Whether the column is visible in the data browser. |
| `preventSort` | Boolean | yes | `false` | `true` | Prevent this column from being sortable. |
| `filterSortToTop` | Boolean | yes | `false` | `true` | Sort this column to the top in filter popup. |

##### Scripts Configuration (`apps[].scripts[]`)

| Parameter | Type | Optional | Default | Example | Description |
|-----------|------|----------|---------|---------|-------------|
| `title` | String | no | - | `"Delete User"` | Title in context menu and confirmation dialog. |
| `classes` | Array&lt;String&gt; \| Array&lt;Object&gt; | no | - | `["_User"]` | Classes for which script can run. |
| `cloudCodeFunction` | String | no | - | `"deleteUser"` | Parse Cloud Function name to execute. |
| `executionBatchSize` | Integer | yes | `1` | `10` | Batch size for multiple objects (runs in serial). |
| `showConfirmationDialog` | Boolean | yes | `false` | `true` | Show confirmation dialog before execution. |
| `confirmationDialogStyle` | String | yes | `info` | `critical` | Dialog style: `info` (blue) or `critical` (red). |

##### Info Panel Configuration (`apps[].infoPanel[]`)

| Parameter | Type | Optional | Default | Example | Description |
|-----------|------|----------|---------|---------|-------------|
| `title` | String | no | - | `"User Details"` | Panel title. |
| `classes` | Array&lt;String&gt; | no | - | `["_User"]` | Classes for which panel is displayed. |
| `cloudCodeFunction` | String | no | - | `"getUserDetails"` | Cloud Function receiving selected object. |
| `prefetchObjects` | Number | yes | `0` | `2` | Number of next rows to prefetch. |
| `prefetchStale` | Number | yes | `0` | `10` | Seconds after which prefetched data is stale. |

##### Global Configuration

| Parameter | Type | Optional | Default | CLI | Env Variable | Example | Description |
|-----------|------|----------|---------|-----|--------------|---------|-------------|
| `apps` | Array&lt;Object&gt; | no | - | - | `PARSE_DASHBOARD_CONFIG` | `[{...}]` | Array of apps to manage. |
| `users` | Array&lt;Object&gt; | yes | - | - | - | `[{...}]` | User accounts for authentication. See [users table below](#user-configuration). |
| `useEncryptedPasswords` | Boolean | yes | `false` | - | - | `true` | Use bcrypt hashes instead of plain text passwords. |
| `trustProxy` | Boolean \| Number | yes | `false` | `--trustProxy` | `PARSE_DASHBOARD_TRUST_PROXY` | `1` | Trust X-Forwarded-* headers when behind proxy. |
| `iconsFolder` | String | yes | - | - | - | `"icons"` | Folder for app icons (relative or absolute path). |
| `agent` | Object | yes | - | - | `PARSE_DASHBOARD_AGENT` (JSON) | `{...}` | AI agent config. See [agent table below](#ai-agent-configuration). |
| `enableResourceCache` | Boolean | yes | `false` | - | - | `true` | Enable browser caching of dashboard resources. |

##### User Configuration (`users[]`)

| Parameter | Type | Optional | Default | CLI | Env Variable | Example | Description |
|-----------|------|----------|---------|-----|--------------|---------|-------------|
| `user` | String | no | - | `--userId` | `PARSE_DASHBOARD_USER_ID` | `"admin"` | Username for authentication. |
| `pass` | String | no | - | `--userPassword` | `PARSE_DASHBOARD_USER_PASSWORD` | `"pass"` | Password (plain or bcrypt hash). |
| `mfa` | String | yes | - | - | - | `"JBSWY3DPEHPK3PXP"` | MFA secret for TOTP. |
| `mfaAlgorithm` | String | yes | `"SHA1"` | - | - | `"SHA256"` | TOTP algorithm for MFA. |
| `mfaDigits` | Number | yes | `6` | - | - | `8` | Number of digits in MFA code. |
| `mfaPeriod` | Number | yes | `30` | - | - | `60` | MFA code validity period in seconds. |
| `readOnly` | Boolean | yes | `false` | - | - | `true` | Read-only access to all their apps. |
| `apps` | Array&lt;Object&gt; | yes | - | - | - | `[{...}]` | Apps user can access (all if omitted). |
| `apps[].appId` | String | no | - | - | - | `"myAppId"` | App ID user can access. |
| `apps[].readOnly` | Boolean | yes | `false` | - | - | `true` | Read-only access to this specific app. |

#### CLI & Server Options

| Parameter | Type | Optional | Default | CLI | Env Variable | Example | Description |
|-----------|------|----------|---------|-----|--------------|---------|-------------|
| `host` | String | yes | `"0.0.0.0"` | `--host` | `HOST` | `"127.0.0.1"` | Host address to bind server. |
| `port` | Number | yes | `4040` | `--port` | `PORT` | `8080` | Port for dashboard server. |
| `mountPath` | String | yes | `"/"` | `--mountPath` | `MOUNT_PATH` | `"/dashboard"` | Mount path for application. |
| `allowInsecureHTTP` | Boolean | yes | `false` | `--allowInsecureHTTP` | `PARSE_DASHBOARD_ALLOW_INSECURE_HTTP` | `true` | Allow HTTP (use behind HTTPS proxy). |
| `sslKey` | String | yes | - | `--sslKey` | `PARSE_DASHBOARD_SSL_KEY` | `"/path/key"` | Path to SSL private key for HTTPS. |
| `sslCert` | String | yes | - | `--sslCert` | `PARSE_DASHBOARD_SSL_CERT` | `"/path/cert"` | Path to SSL certificate for HTTPS. |
| `cookieSessionSecret` | String | yes | Random | `--cookieSessionSecret` | `PARSE_DASHBOARD_COOKIE_SESSION_SECRET` | `"secret"` | Secret for session cookies (for multi-server). |
| `cookieSessionMaxAge` | Number | yes | Session-only | `--cookieSessionMaxAge` | `PARSE_DASHBOARD_COOKIE_SESSION_MAX_AGE` | `3600` | Session cookie expiration (seconds). |
| `dev` | Boolean | yes | `false` | `--dev` | - | - | Development mode (**DO NOT use in production**). |
| `config` | String | yes | - | `--config` | - | `"config.json"` | Path to JSON configuration file. |

#### Helper CLI Commands

| Command | Description |
|---------|-------------|
| `--createUser` | Interactive tool to generate secure user passwords and MFA secrets. |
| `--createMFA` | Interactive tool to generate MFA secrets for existing users. |
### File

You can also start the dashboard from the command line with a config file. To do this, create a new file called `parse-dashboard-config.json` inside your local Parse Dashboard directory hierarchy. The file should match the following format:
Expand Down
Loading