[][open-collective-link] [][open-collective-link] [![License][license-svg]][license-link]

Parse Dashboard is a standalone dashboard for managing your Parse Server apps.

• Getting Started
• Compatibility
  • Parse Server
  • Node.js
• Configuring Parse Dashboard
  • Options
  • Root Options
    • App Options
    • Column Options
    • Script Options
    • Info Panel Options
    • User Options
  • CLI \& Server Options
  • Helper CLI Commands
  • File
  • Environment variables
  • Multiple apps
  • Single app
• Managing Multiple Apps
• GraphQL Playground
• App Icon Configuration
• App Background Color Configuration
• Other Configuration Options
  • Prevent columns sorting
  • Custom order in the filter popup
  • Persistent Filters
  • Keyboard Shortcuts
  • Resource Cache
• Running as Express Middleware
• Browser Control API (Development Only)
  • ⚠️ Security Requirements
  • Configuration
  • Usage
• Deploying Parse Dashboard
• Preparing for Deployment
• Security Considerations
  • Security Checks
  • Configuring Basic Authentication
  • Multi-Factor Authentication (One-Time Password)
  • Running Multiple Dashboard Replicas
  • Using a Custom Session Store
• Use Read-Only masterKey
  • Making an app read-only for all users
  • Makings users read-only
  • Making user's apps readOnly
• Configuring Localized Push Notifications
• Run with Docker
• Features
• Data Browser
  • Filters
  • Info Panel
  • Response
    • Segments
    • Text Item
    • Key-Value Item
    • Table Item
    • Image Item
    • Video Item
    • Audio Item
    • Button Item
    • Panel Item
  • Auto-Scroll
  • Prefetching
  • Scripts
  • Script Response Form
    • Response Fields
    • Form Elements
    • Drop-Down
    • Checkbox
    • Toggle
    • Text Input
  • Graph
  • Calculated Values
  • Formula Operator
    • Arithmetic Operators
    • Comparison Operators
    • Conditional Operator
    • Math Functions
  • Freeze Columns
  • Browse as User
  • Change Pointer Key
  • Limitations
  • Data Export
  • Data Import
• AI Agent
  • Configuration
  • Providers
  • OpenAI
• Views
  • Data Sources
  • Aggregation Pipeline
  • Cloud Function
  • View Table
  • Pointer
  • Link
  • Image
  • Video
• Contributing

Getting Started

Install the dashboard from npm.

npm install -g parse-dashboard

You can launch the dashboard for an app with a single command by supplying an app ID, master key, URL, and name like this:

parse-dashboard --dev --appId yourAppId --masterKey yourMasterKey --serverURL "https://example.com/parse" --appName optionalName

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.

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:

Compatibility

Parse Server

Parse Dashboard is compatible with the following versions of Parse Server.

Parse Dashboard automatically checks the Parse Server version when connecting and displays a warning if the server version does not meet the minimum required version. The required Parse Server version is defined in the supportedParseServerVersion field in package.json.

Node.js

Parse Dashboard is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the Node.js Long Term Support plan and only test against versions that are officially supported and have not reached their end-of-life date.

Configuring Parse Dashboard

Options

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.

Root Options

App Options