Skip to content

Commit e5dfcb3

Browse files
committed
feat: more configuration
1 parent cdfa197 commit e5dfcb3

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,22 +156,40 @@ This section provides a comprehensive reference for all Parse Dashboard configur
156156
| `appName` | String | yes | `appId` | `--appName` | `PARSE_DASHBOARD_APP_NAME` | `"MyApp"` | Display name of the app. |
157157
| `masterKeyTtl` | Number | yes | - | `--masterKeyTtl` | - | `3600` | TTL for master key cache in seconds (when `masterKey` is a Function). |
158158
| `readOnlyMasterKey` | String | yes | - | - | - | `"myReadOnlyKey"` | Read-only master key that prevents mutations. |
159-
| `graphQLServerURL` | String | yes | - | `--graphQLServerURL` | `PARSE_DASHBOARD_GRAPHQL_SERVER_URL` | `"http://localhost:1337/graphql"` | URL of GraphQL Server. |
159+
| `clientKey` | String | yes | - | - | - | `"myClientKey"` | Client key for Parse SDK (legacy, mostly unused). |
160+
| `javascriptKey` | String | yes | - | - | - | `"myJsKey"` | JavaScript key for Parse SDK (legacy, mostly unused). |
161+
| `restKey` | String | yes | - | - | - | `"myRestKey"` | REST API key for server-side REST applications. |
162+
| `windowsKey` | String | yes | - | - | - | `"myWindowsKey"` | Windows SDK key (legacy, mostly unused). |
163+
| `webhookKey` | String | yes | - | - | - | `"myWebhookKey"` | Webhook key for Cloud Code Webhooks. |
164+
| `apiKey` | String | yes | - | - | - | `"myFileKey"` | File key (also called apiKey) for file migrations. |
165+
| `graphQLServerURL` | String | yes | - | `--graphQLServerURL` | `PARSE_DASHBOARD_GRAPHQL_SERVER_URL` | `"http://localhost:1337/graphql"` | The URL where your Parse GraphQL Server is running. |
160166
| `appNameForURL` | String | yes | `appName` | - | - | `"my-app"` | URL-friendly name used in dashboard URLs. |
161167
| `production` | Boolean | yes | `false` | - | - | `true` | Mark as production environment. |
162168
| `iconName` | String | yes | - | - | - | `"icon.png"` | Filename of app icon (requires global `iconsFolder`). |
163169
| `primaryBackgroundColor` | String | yes | - | - | - | `"#FFA500"` | Primary background color (CSS value). |
164170
| `secondaryBackgroundColor` | String | yes | - | - | - | `"#FF4500"` | Secondary background color (CSS value). |
165171
| `supportedPushLocales` | Array<String> | yes | - | - | - | `["en","fr"]` | Supported locales for push notifications. |
166-
| `columnPreference` | Object | yes | - | - | - | `{"_User":[...]}` | Column visibility/sorting/filtering preferences. |
167-
| `classPreference` | Object | yes | - | - | - | `{"_Role":{...}}` | Persistent filters for all users. |
172+
| `preventSchemaEdits` | Boolean | yes | `false` | - | - | `true` | Prevent schema modifications through the dashboard. |
173+
| `columnPreference` | Object | yes | - | - | - | `{"_User":[...]}` | Column visibility/sorting/filtering preferences. See [column preferences details](#prevent-columns-sorting). |
174+
| `classPreference` | Object | yes | - | - | - | `{"_Role":{...}}` | Persistent filters for all users. See [persistent filters details](#persistent-filters). |
168175
| `enableSecurityChecks` | Boolean | yes | `false` | - | - | `true` | Enable security checks under App Settings > Security. |
169176
| `cloudConfigHistoryLimit` | Integer | yes | `100` | - | - | `200` | Number of historic Cloud Config values (0 to Number.MAX_SAFE_INTEGER). |
170177
| `config` | Object | yes | - | - | - | `{...}` | Settings for storing dashboard config on server. |
171178
| `config.className` | String | yes | - | - | - | `"DashboardConfig"` | Table name for dashboard configuration. |
172179
| `scripts` | Array<Object> | yes | `[]` | - | - | `[{...}]` | Scripts for this app. See [scripts table below](#scripts-configuration). |
173180
| `infoPanel` | Array<Object> | yes | - | - | - | `[{...}]` | Info panel config. See [info panel table below](#info-panel-configuration). |
174181

182+
##### Column Preference Configuration (`apps[].columnPreference.<className>[]`)
183+
184+
Each class in `columnPreference` can have an array of column configurations:
185+
186+
| Parameter | Type | Optional | Default | Example | Description |
187+
|-----------|------|----------|---------|---------|-------------|
188+
| `name` | String | no | - | `"createdAt"` | Column/field name. |
189+
| `visible` | Boolean | yes | `true` | `false` | Whether the column is visible in the data browser. |
190+
| `preventSort` | Boolean | yes | `false` | `true` | Prevent this column from being sortable. |
191+
| `filterSortToTop` | Boolean | yes | `false` | `true` | Sort this column to the top in filter popup. |
192+
175193
##### Scripts Configuration (`apps[].scripts[]`)
176194

177195
| Parameter | Type | Optional | Default | Example | Description |

0 commit comments

Comments
 (0)