parseplatform/parse-dashboard

Parse Dashboard 中文技术文档

镜像概述和主要用途

Parse Dashboard 是一个独立的仪表板工具，用于管理 https://github.com/ParsePlatform/parse-server 应用。它提供可视化界面，支持数据浏览、用户管理、推送通知配置、GraphQL 调试等核心功能，适用于开发和生产环境中对 Parse Server 应用的集中管理。

核心功能和特性

• 多应用管理：支持同时管理多个 Parse Server 应用，集中查看和操作不同应用数据
• GraphQL 集成：内置 GraphQL Playground，可直接调试 Parse Server 自动生成的 GraphQL API
• 自定义标识：支持为每个应用配置图标和背景色，便于快速识别
• 安全访问控制：提供基本认证（Basic Authentication），支持用户权限分离和应用访问限制
• 只读权限：通过只读 Master Key 限制用户或应用的写操作，增强数据安全性
• 本地化推送：支持配置多语言推送通知，适配国际化需求
• 灵活部署：可作为独立服务运行，或集成到 Express 应用作为中间件
• 列排序控制：支持配置特定数据列是否允许排序，优化数据浏览体验

使用场景和适用范围

• 开发环境：本地调试 Parse Server 应用，实时查看数据变更和 API 调用
• 生产环境：远程监控应用数据，管理用户和推送通知，进行安全审计
• 多应用管理：统一管理多个 Parse Server 实例或不同环境（开发/测试/生产）的应用
• 团队协作：通过用户权限配置，限制不同成员对应用的访问和操作权限

详细使用方法和配置说明

环境要求

• Node.js 版本 ≥ 8.9
• Parse Server 版本 ≥ 2.1.4
• 生产环境需配置 HTTPS（确保 Master Key 安全）

本地安装

安装方式

通过 npm 全局安装：

bash
npm install -g parse-dashboard

快速启动（单应用）

直接通过命令行参数启动，适用于快速测试：

bash
parse-dashboard --appId 你的AppId --masterKey 你的MasterKey --serverURL "https://example.com/parse" --appName "应用名称"

注意：--dev 参数会禁用生产环境安全特性，仅用于本地开发，生产环境切勿使用。

配置方式

Parse Dashboard 支持通过配置文件或环境变量进行配置，推荐生产环境使用配置文件。

配置文件（推荐）

创建 JSON 格式配置文件（如 parse-dashboard-config.json），支持单应用或多应用配置。

单应用配置示例

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",  // Parse Server 地址
      "appId": "myAppId",                          // 应用 ID
      "masterKey": "myMasterKey",                  // Master Key
      "appName": "MyApp",                          // 应用名称（显示用）
      "production": false                          // 是否为生产环境（默认 false）
    }
  ]
}

通过配置文件启动：

bash
parse-dashboard --config parse-dashboard-config.json

多应用配置示例

在 apps 数组中添加多个应用配置：

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "appId": "app1Id",
      "masterKey": "app1MasterKey",
      "appName": "应用1"
    },
    {
      "serverURL": "http://localhost:1337/parse2",
      "appId": "app2Id",
      "masterKey": "app2MasterKey",
      "appName": "应用2"
    }
  ]
}

环境变量配置

仅支持通过 parse-dashboard 命令启动时使用，分为单应用和多应用两种模式。

单应用环境变量

多应用环境变量

通过 PARSE_DASHBOARD_CONFIG 环境变量传入完整 JSON 配置（与配置文件格式一致）：

bash
export PARSE_DASHBOARD_CONFIG='{"apps":[{"serverURL":"http://localhost:1337/parse","appId":"app1","masterKey":"key1","appName":"应用1"},{"serverURL":"http://localhost:1337/parse2","appId":"app2","masterKey":"key2","appName":"应用2"}]}'
parse-dashboard

高级配置

应用标识自定义

应用图标配置

1. 在配置文件中指定图标目录（iconsFolder，相对于配置文件路径）
2. 为每个应用设置 iconName（包含文件扩展名）

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp",
      "iconName": "app-icon.png"  // 图标文件名
    }
  ],
  "iconsFolder": "icons"  // 图标目录（存放 app-icon.png 等文件）
}

应用背景色配置

通过 primaryBackgroundColor 和 secondaryBackgroundColor 配置应用列表中的背景色（支持 CSS 颜色格式）：

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp",
      "primaryBackgroundColor": "#FFA500",    // 主背景色（橙色）
      "secondaryBackgroundColor": "#FF4500"  // 次背景色（橙红色）
    }
  ]
}

GraphQL Playground 配置

若 Parse Server 启用了 GraphQL API，可通过以下方式在 Dashboard 中集成 GraphQL Playground：

• 命令行参数：--graphQLServerURL "https://example.com/graphql"
• 环境变量：PARSE_DASHBOARD_GRAPHQL_SERVER_URL="https://example.com/graphql"
• 配置文件：在应用配置中添加 graphQLServerURL 字段

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "graphQLServerURL": "http://localhost:1337/graphql",  // GraphQL API 地址
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp"
    }
  ]
}

启动后可通过 http://localhost:4040/apps/应用名称/api_console/graphql 访问 Playground。

列排序控制

通过 columnPreference 配置特定数据类的列是否允许排序（preventSort: true 禁用排序）：

json
{
  "apps": [
    {
      "appId": "myAppId",
      "columnPreference": {
        "_User": [  // 对 _User 类配置
          {
            "name": "createdAt",  // 字段名
            "visible": true,      // 是否显示
            "preventSort": true   // 禁用排序
          },
          {
            "name": "updatedAt",
            "visible": true,
            "preventSort": false  // 允许排序
          }
        ]
      }
    }
  ]
}

运行作为 Express 中间件

可将 Parse Dashboard 集成到现有 Express 应用中，作为中间件运行：

javascript
const express = require('express');
const ParseDashboard = require('parse-dashboard');

// 配置 Dashboard
const dashboard = new ParseDashboard({
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp"
    }
  ]
});

const app = express();
app.use('/dashboard', dashboard);  // 将 Dashboard 挂载到 /dashboard 路径

// 启动服务
const httpServer = require('http').createServer(app);
httpServer.listen(4040, () => {
  console.log('Parse Dashboard 运行在 http://localhost:4040/dashboard');
});

若需同时运行 Parse Server 和 Dashboard，可将两者作为中间件挂载到同一 Express 应用：

javascript
const express = require('express');
const ParseServer = require('parse-server').ParseServer;
const ParseDashboard = require('parse-dashboard');

// 配置 Parse Server
const api = new ParseServer({
  databaseURI: 'mongodb://localhost:27017/dev',
  appId: 'myAppId',
  masterKey: 'myMasterKey',
  serverURL: 'http://localhost:4040/parse'
});

// 配置 Dashboard
const dashboard = new ParseDashboard({
  "apps": [{"appId": "myAppId", "masterKey": "myMasterKey", "serverURL": "http://localhost:4040/parse", "appName": "MyApp"}]
});

const app = express();
app.use('/parse', api);        // Parse Server 挂载到 /parse
app.use('/dashboard', dashboard);  // Dashboard 挂载到 /dashboard

httpServer.listen(4040);

Docker 部署方案

官方镜像信息

• 镜像名称：parseplatform/parse-dashboard
• 官方仓库：https://hub.docker.com/r/parseplatform/parse-dashboard

基础部署（单应用）

通过命令行参数直接启动，适用于快速测试：

bash
docker run -d -p 4040:4040 \
  parseplatform/parse-dashboard \
  --appId 你的AppId \
  --masterKey 你的MasterKey \
  --serverURL "https://example.com/parse" \
  --appName "应用名称"

配置文件部署（推荐）

挂载本地配置文件到容器中，支持复杂配置（多应用、认证等）：

1. 本地创建配置文件 parse-dashboard-config.json（参考上文配置文件格式）
2. 启动容器并挂载配置文件：

bash
docker run -d -p 4040:4040 \
  -v /本地路径/parse-dashboard-config.json:/src/Parse-Dashboard/parse-dashboard-config.json \
  parseplatform/parse-dashboard \
  --config /src/Parse-Dashboard/parse-dashboard-config.json

生产环境部署

生产环境需注意：

• 禁用 --dev 参数
• 配置 HTTPS（通过反向代理如 Nginx 或直接挂载 SSL 证书）
• 设置强密码认证

示例（指定端口和生产配置）：

bash
docker run -d -p 80:8080 \
  -v /本地路径/parse-dashboard-config.json:/src/Parse-Dashboard/parse-dashboard-config.json \
  parseplatform/parse-dashboard \
  --config /src/Parse-Dashboard/parse-dashboard-config.json \
  --port 8080  # 容器内端口，映射到主机 80 端口

安全配置

基本认证

通过配置文件添加用户，支持明文密码或 bcrypt 加密密码（useEncryptedPasswords: true 启用加密）：

json
{
  "apps": [{"...": "..."}],
  "users": [
    {
      "user": "admin",       // 用户名
      "pass": "$2b$10$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"  // bcrypt 加密密码
    },
    {
      "user": "viewer",
      "pass": "viewer123"    // 明文密码（不推荐生产环境）
    }
  ],
  "useEncryptedPasswords": true  // 启用 bcrypt 加密验证
}

用户权限分离

限制用户可管理的应用，通过 apps 字段指定用户可访问的应用 ID：

json
{
  "apps": [
    {"appId": "app1", "masterKey": "key1", "appName": "应用1"},
    {"appId": "app2", "masterKey": "key2", "appName": "应用2"}
  ],
  "users": [
    {
      "user": "admin",
      "pass": "admin123",
      "apps": [{"appId": "app1"}, {"appId": "app2"}]  // 可管理 app1 和 app2
    },
    {
      "user": "app1-viewer",
      "pass": "viewer123",
      "apps": [{"appId": "app1"}]  // 仅可管理 app1
    }
  ]
}

只读权限控制

应用级只读

使用 Parse Server 的 readOnlyMasterKey（需 Parse Server ≥ 2.6.5），在 Dashboard 配置中替换 masterKey 为 readOnlyMasterKey：

json
{
  "apps": [
    {
      "serverURL": "http://localhost:1337/parse",
      "appId": "myAppId",
      "masterKey": "只读MasterKey",  // 使用只读 Key
      "appName": "只读应用"
    }
  ]
}

用户级只读

在用户配置中添加 readOnly: true，限制该用户对所有应用的写操作：

json
{
  "users": [
    {
      "user": "viewer",
      "pass": "viewer123",
      "readOnly": true,  // 只读用户
      "apps": [{"appId": "app1"}, {"appId": "app2"}]
    }
  ]
}

应用级用户只读

指定用户对特定应用的只读权限（需应用配置中提供 readOnlyMasterKey）：

json
{
  "apps": [
    {
      "appId": "app1",
      "masterKey": "完整权限Key",
      "readOnlyMasterKey": "只读Key",  // 应用级只读 Key
      "serverURL": "http://localhost:1337/parse"
    }
  ],
  "users": [
    {
      "user": "viewer",
      "pass": "viewer123",
      "apps": [{"appId": "app1", "readOnly": true}]  // 对 app1 只读
    }
  ]
}

生产环境安全建议

1. 启用 HTTPS：通过反向代理（如 Nginx）或直接配置 SSL 证书（--sslKey 和 --sslCert 参数）
2. 信任代理配置：若部署在负载均衡或代理后，设置 --trustProxy=1 以正确识别客户端连接（依赖 X-Forwarded-* 头）
3. 强密码策略：使用 bcrypt 加密存储密码，避免明文
4. 限制访问来源：通过网络策略或防火墙限制 Dashboard 访问 IP
5. 定期更新：保持镜像和依赖版本最新，修复安全漏洞