@gemforce/gemforce-dashboard

中文文档
4.2.0-alpha.25发布于 2023/02/17SEE LICENSE IN LICENSECommonJS近 30 天下载 2万

宝石出炉板

中文使用文档
文档目录28 节
  1. 兼容性
  2. 解析服务器
  3. 节点.js
  4. 配置剖析板
  5. 文件
  6. 环境变量
  7. 管理多个应用程序
  8. 图QL 播放场
  9. App 图标配置
  10. App 背景颜色配置
  11. 其他配置选项
  12. 防止列排序
  13. 过滤器弹出中的自定义顺序
  14. 准备部署
  15. 安全考虑
  16. 配置基本认证
  17. 多功能认证( 一次性密码)
  18. 根据用户身份分隔 App 访问
  19. 使用只读主键
  20. 对所有用户只做一个应用程序
  21. 让用户只读
  22. 让用户的应用程序只读
  23. 配置本地化按键通知
  24. 与 Docker 运行
  25. 浏览为用户
  26. 更改指针键
  27. 限制
  28. CSV 导出

parse-repository-header-dashboard


Build Status Build Status Build Status Snyk Badge

Node Version auto-release

npm latest version npm beta version npm alpha version

Backers on Open Collective Sponsors on Open Collective License Forum Twitter


解析 Dashboard 是管理您的独立仪表板 解析服务器 应用程序.


开始

安装仪表板 npm。 。 。 .

npm install -g parse-dashboard

您可以通过提供应用程序ID, 主密钥, URL, 以及这样的名称, 启动一个具有单一命令的应用程序的仪表盘 :

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

您可以通过提供 --host, (中文(简体) ), --port 财务报告和审定财务报表 --mountPath 选项来解析磁盘。 您可以使用任何您想要的应用程序名称, 也可以不使用该应用程序 ID .

这个 --dev 参数禁用生产准备的安全特性。 此参数在 Docker 上运行 Parse Dashboard 时有用. 使用此参数将 :

  • 允许从任何地方建立不安全的 http 连接, 绕过选项 allowInsecureHTTP
  • 允许解析服务器 masterKey 在不加密的情况下以清晰文本传送
  • 允许没有用户认证的仪表板访问

QQ 在生产环境中部署 Parse Dashboard 时不要使用此参数 .

在启动仪表板后,您可以在浏览器中访问http://localhost:4040:

Parse Dashboard

兼容性

解析服务器

解析Dashboard与以下解析服务器版本相兼容.

解析板版本解析服务器版本兼容
(单位:千美元)>= 2.1.4对

节点.js

解析 Dashboard 与最近发布的Node.js 不断被测试,以确保兼容性. 我们跟着 长期支助计划 并且只对官方支持的版本进行测试,并且没有达到其报废日期.

版本最新版本临终时兼容
节点.js 1414.20.1 国家2023年4月 (中文(简体) )对
节点.js 1616.17.0 (简体中文)2024年4月 (英语)对
节点.js 1818.9.0 (中文(简体) )2025年5月 (中文(简体) )对

配置剖析板

文件

也可以从命令行起用配置文件启动仪表板. 要做到这一点,请创建名为新文件 parse-dashboard-config.json 在您的本地 Parse Dashboard 目录等级中。 文件应匹配以下格式:

{
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp"
    }
  ]
}

然后可以使用 parse-dashboard --config parse-dashboard-config.json。 。 。 .

环境变量

这只在应用启动时有效 parse-dashboard 命令

还有两种方法可以使用环境变量来配置仪表板.

多个应用程序

在 PARSE_DASHBOARD_CONFIG 它会被解析 就像配置文件.

单一应用程序

也可以单独定义每个配置选项.

HOST: "0.0.0.0"
PORT: "4040"
MOUNT_PATH: "/"
PARSE_DASHBOARD_TRUST_PROXY: undefined // Or "1" to trust connection info from a proxy's X-Forwarded-* headers
PARSE_DASHBOARD_SERVER_URL: "https://localhost/parse"
PARSE_DASHBOARD_MASTER_KEY: "myMasterKey"
PARSE_DASHBOARD_APP_ID: "myAppId"
PARSE_DASHBOARD_APP_NAME: "MyApp"
PARSE_DASHBOARD_USER_ID: "user1"
PARSE_DASHBOARD_USER_PASSWORD: "pass"
PARSE_DASHBOARD_SSL_KEY: "sslKey"
PARSE_DASHBOARD_SSL_CERT: "sslCert"
PARSE_DASHBOARD_CONFIG: undefined // Only for reference, it must not exist
PARSE_DASHBOARD_COOKIE_SESSION_SECRET: undefined // set the cookie session secret, defaults to a random string. Use this option if you want sessions to work across multiple servers, or across restarts

管理多个应用程序

从同一个仪表板管理多个应用程序也是可能的. 简单地在 parse-dashboard-config.json 文档 "apps" 数组 :

{
  "apps": [
    {
      "serverURL": "https://localhost/parse", // Self-hosted Parse Server
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App"
    },
    {
      "serverURL": "https://localhost/parse2", // Self-hosted Parse Server
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App 2"
    }
  ]
}

图QL 播放场

解析 Dashboard 有内置的 GraphQL 游戏场, 用于播放自动生成的游戏 解析图QL API。 。 。 .

您可以通过传递 GraphQL 游戏场设置 --graphQLServerURL 选项 parse-dashboard CLI: 爱丽丝

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

这个 graphQLServerURL 选项也可以通过一个叫做 PARSE_DASHBOARD_GRAPHQL_SERVER_URL数字 :

HOST: "0.0.0.0"
PORT: "4040"
MOUNT_PATH: "/"
PARSE_DASHBOARD_SERVER_URL: "https://localhost/parse"
PARSE_DASHBOARD_GRAPHQL_SERVER_URL: "https://localhost/graphql"
PARSE_DASHBOARD_MASTER_KEY: "myMasterKey"
PARSE_DASHBOARD_APP_ID: "myAppId"
PARSE_DASHBOARD_APP_NAME: "MyApp"

您也可以在您的 GraphQL 游戏场设置 parse-dashboard-config.json 文件 :

{
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "graphQLServerURL": "https://localhost/graphql",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App"
    },
    {
      "serverURL": "https://localhost/parse2",
      "graphQLServerURL": "https://localhost/graphql2",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App 2"
    }
  ]
}

在启动仪表板后,您可在浏览器中访问 http://0.0.0.0:4040/apps/MyTestApp/api console/graphql:

Parse Dashboard GraphQL Playground

App 图标配置

解析 Dashboard 支持为每个应用程序添加一个可选图标,这样可以在列表中更容易识别出它们. 要这样做,你 必须 使用配置文件,定义一个 iconsFolder 在其中,并界定 iconName 每个应用程序的参数(包括扩展名). 道路的走向 iconsFolder 相对配置文件。 如果您已经在全球安装了 ParseDashboard, 您需要使用完整路径作为值 iconsFolder. 以下列例子来体现其含义: icons 是位于配置文件同一目录下的目录 :

{
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App",
      "iconName": "MyAppIcon.png",
    }
  ],
  "iconsFolder": "icons"
}

App 背景颜色配置

解析 Dashboard 支持为每个应用程序添加可选的背景颜色,这样可以在列表中更容易识别出. 要这样做,你 必须 使用配置文件,定义一个 primaryBackgroundColor 财务报告和审定财务报表 secondaryBackgroundColor 在其中,每个应用程序的参数。 没错 CSS style. 以下列例子来体现其含义: backgroundColor 是配置文件 :

{
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App",
      "primaryBackgroundColor": "#FFA500", // Orange
      "secondaryBackgroundColor": "#FF4500" // OrangeRed
    },
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App [2]",
      "primaryBackgroundColor": "rgb(255, 0, 0)", // Red
      "secondaryBackgroundColor": "rgb(204, 0, 0)" // DarkRed
    }
  ]
}

其他配置选项

你可以设置 appNameForURL 在每个应用程序的配置文件中控制您应用程序在仪表板中的url。 这可以更容易地在您的仪表板上使用书签或共享链接.

将应用程序改为生产,只需设定 production 改为 true 在您的配置文件中。 如果未指定, 默认值为虚假 .

防止列排序

您可以通过添加来防止一些列的排序 preventSort 选择每个应用程序配置中的选项


"apps": [
  {
    "appId": "local_app_id",
    "columnPreference": {
        "_User": [
          {
            "name": "createdAt",
            "visible": true,
            "preventSort": true
          },
          {
            "name": "updatedAt",
            "visible": true,
            "preventSort": false
          },
        ]
      }
    }
]

过滤器弹出中的自定义顺序

如果你有很多列的课,并且经常用相同的列过滤这些课,你可以通过扩展列向上排序这些课 columnPreference 设置 filterSortToTop 选项 :

"apps": [
  {
    "columnPreference": {
        "_User": [
          {
            "name": "objectId",
            "filterSortToTop": true
          },
          {
            "name": "email",
            "filterSortToTop": true
          }          
        ]
      }
    }
]

作为快取中件运行

与其以 CLI 开始解析 Dashboard , 您还可以以 a 表达式 中间软件.

var express = require('express');
var ParseDashboard = require('parse-dashboard');

var dashboard = new ParseDashboard({
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp"
    }
  ]
});

var app = express();

// make the Parse Dashboard available at /dashboard
app.use('/dashboard', dashboard);

var httpServer = require('http').createServer(app);
httpServer.listen(4040);

如果你想同时运行 解析服务器 您可以在同一个服务器/端口上解析 Dashboard, 将它们作为快件运行 :

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

var api = new ParseServer({
    // Parse Server settings
});

var options = { allowInsecureHTTP: false };

var dashboard = new ParseDashboard({
    // Parse Dashboard settings
}, options);

var app = express();

// make the Parse Server available at /parse
app.use('/parse', api);

// make the Parse Dashboard available at /dashboard
app.use('/dashboard', dashboard);

var httpServer = require('http').createServer(app);
httpServer.listen(4040);

部署解析板

准备部署

确保您的应用程序的服务器 URL 可以被您的浏览器访问 。 如果你正在部署仪表板,那么 localhost urls不会工作.

安全考虑

为了安全地部署仪表板而不泄露您的应用程序主密钥,您需要使用HTTPS和 Basic Authority.

部署的仪表盘检测到是否使用安全连接. 如果您在负载平衡器或前置代理机后部署仪表板,那么应用程序将无法检测连接是否安全. 这样的话,你可以启动仪表板 --trustProxy=1 选项(或将 PARSE DASHBOARD TRUST PROXY 配置 var 设置为 1),以依赖 X-Forwarded-* 头来维护客户端的连接安全。 这对Heroku这样的服务托管有用,你可以信任所提供的代理信头来正确判断您是使用HTTP还是HTTPS. 您也可以在使用仪表板时打开此设置 表达式 中间软件 :

var trustProxy = true;
var dashboard = new ParseDashboard({
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "MyApp"
    }
  ],
  "trustProxy": 1
});

配置基本认证

您可以通过添加用户名和密码来配置基本认证的仪表板 parse-dashboard-config.json 配置文件 :

{
  "apps": [{"...": "..."}],
  "users": [
    {
      "user":"user1",
      "pass":"pass"
    },
    {
      "user":"user2",
      "pass":"pass"
    }
  ],
  "useEncryptedPasswords": true | false
}

您可以将密码存储在任意一个 plain text 或者说 bcrypt 格式。 用来使用 bcrypt 格式,您必须设置配置 useEncryptedPasswords 参数改为 true。 。 。 . 您可以通过使用 parse-dashboard --createUser,并在用户配置中粘贴结果.

多功能认证( 一次性密码)

您可以通过要求用户登录多要素认证(MFA)来为用户账户添加一层安全.

随着MFA的启用,用户除了提供登录密码外,还必须提供通常与物理设备相接的一次性密码. 这意味着除了知道登录密码外,用户还需要实际访问一个设备以生成一次性密码. 这个一次性密码是基于时间的(TOTP),并且只在短的时间内有效,一般为30秒,直到失效.

用户需要认证程序才能生成一次性密码. 这些应用程序是由许多3个政党提供的,并且大多是免费的.

如果您通过运行创建新用户 parse-dashboard --createUser,将询问您是否想要为新用户启用 MFA 。 为使外交部能够帮助现有用户, 运行 parse-dashboard --createMFA 生成一个 mfa 隐藏,然后添加到现有的用户配置中,例如:

{
  "apps": [{"...": "..."}],
  "users": [
    {
      "user":"user1",
      "pass":"pass",
      "mfa": "lmvmOIZGMTQklhOIhveqkumss"
    }
  ]
}

解析 Dashboard 遵循行业标准并支持常用的 OTP 算法 SHA-1 默认,以兼容大多数认证程序。 如果您对 TOTP 特性( 算法, 数字长度, 时间段) 有特定的安全要求, 您可以使用上面提到的引导配置来自定义它们 .

根据用户身份分隔 App 访问

如果您已经配置了您的仪表板来管理多个应用程序,您可以根据用户身份限制应用程序的管理.

要做到这一点,更新你的 parse-dashboard-config.json 要匹配以下格式的配置文件 :

{
  "apps": [{"...": "..."}],
  "users": [
     {
       "user":"user1",
       "pass":"pass1",
       "apps": [{"appId": "myAppId1"}, {"appId": "myAppId2"}]
     },
     {
       "user":"user2",
       "pass":"pass2",
       "apps": [{"appId": "myAppId1"}]
     }  ]
}

这种配置的效果如下:

何时 user1 登录,heshe将能够管理 myAppId1 财务报告和审定财务报表 myAppId2 从仪表板.

何时 user2 登录,heshe只能管理 myAppId1 从仪表板.

使用只读主键

2.6.5 开始提供 readOnlyMasterKey 用于解析服务器,以防止客户端对对象的突变. 如果你想用这个功能保护你的仪表板,只需使用 readOnlyMasterKey 代替 masterKey所有写作电话都会失败.

对所有用户只做一个应用程序

开始 parse-server 与

{
"masterKey": "YOUR_MASTER_KEY_HERE",
"readOnlyMasterKey": "YOUR_READ_ONLY_MASTER_KEY",
}

然后在您的仪表板配置中:

var trustProxy = true;
var dashboard = new ParseDashboard({
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "YOUR_READ_ONLY_MASTER_KEY",
      "appName": "MyApp"
    }
  ],
  "trustProxy": 1
});

让用户只读

请指定 readOnlyMasterKey 用于在“apps”配置中使用只读功能的应用程序. 您可以将用户标记为只读用户 :

{
  "apps": [
    {
      "appId": "myAppId1",
      "masterKey": "myMasterKey1",
      "readOnlyMasterKey": "myReadOnlyMasterKey1",
      "serverURL": "myURL1",
      "port": 4040,
      "production": true
    },
    {
      "appId": "myAppId2",
      "masterKey": "myMasterKey2",
      "readOnlyMasterKey": "myReadOnlyMasterKey2",
      "serverURL": "myURL2",
      "port": 4041,
      "production": true
    }
  ],
  "users": [
    {
      "user":"user1",
      "pass":"pass1",
      "readOnly": true,
      "apps": [{"appId": "myAppId1"}, {"appId": "myAppId2"}]
    },
    {
      "user":"user2",
      "pass":"pass2",
      "apps": [{"appId": "myAppId1"}]
    }
  ]
}

这边 user1 只能读取 myAppId1 财务报告和审定财务报表 myAppId2

让用户的应用程序只读

请指定 readOnlyMasterKey 用于在“apps”配置中使用只读功能的应用程序. 您可以只给用户每个应用程序的读取权限 :

{
  "apps": [
    {
      "appId": "myAppId1",
      "masterKey": "myMasterKey1",
      "readOnlyMasterKey": "myReadOnlyMasterKey1",
      "serverURL": "myURL",
      "port": 4040,
      "production": true
    },
    {"...": "..."}
  ],
  "users": [
    {
      "user":"user",
      "pass":"pass",
      "apps": [{"appId": "myAppId", "readOnly": true}, {"appId": "myAppId2"}]
    }
  ]
}

使用此配置, 用户1 将只读取访问 myAppId1 并阅读/写入访问权限 myAppId2。 。 。 .

配置本地化按键通知

与最新版本的 仪表板,可以发送本地化消息用于推动通知. 您可以为您的仪表板用户提供您想要支持的地方或语言列表 .

{
  "apps": [
    {
      "serverURL": "https://localhost/parse",
      "appId": "myAppId",
      "masterKey": "myMasterKey",
      "appName": "My Parse Server App",
      "iconName": "MyAppIcon.png",
      "supportedPushLocales": ["en", "ru", "fr"]
    }
  ],
  "iconsFolder": "icons"
}

与 Docker 运行

官方嵌入器图像发布于 插头枢纽

用您的图像运行图像 config.json 作为音量挂起

docker run -d -p 8080:4040 -v host/path/to/config.json:/src/Gemforce-Dashboard/parse-dashboard-config.json parseplatform/parse-dashboard --dev

您也可以通过 appId, masterKey 和 serverURL 作为参数 :

docker run -d -p 4040:4040 parseplatform/parse-dashboard --dev --appId $APP_ID --masterKey $MASTER_KEY --serverURL $SERVER_URL

默认情况下,容器会在容器内的4040口启动应用. 然而,您也可以运行自定义命令(参见 Deploying in production 用于自定义设置).

在这个例子中,我们希望在主机的80号端口运行生产模式中的应用程序.

docker run -d -p 80:8080 -v host/path/to/config.json:/src/Gemforce-Dashboard/parse-dashboard-config.json parse-dashboard --port 8080 --dev

如果你对多克不熟悉, --port 8080 将会作为参数传递到切入点,以形成完整命令 npm start -- --port 8080。应用程序将从集装箱和港口内的 第8080端口开始 8080 将挂载到端口 80 在您的主机上.

特征

(以下不是完整的地物列表,而是一个在建全面地物列表的工作. )

浏览为用户

▶️ 核心资源 > 浏览器 > 浏览

此功能允许您使用数据浏览器作为另一个用户,同时尊重该用户的数据权限. 例如,您只看到用户有权限查看的记录和字段.

QQ 作为另一个用户登录将会触发同样的云触发器, 就像用户自己登录时使用其他登录方法一样. 作为另一个用户登录需要输入该用户的密码.

更改指针键

▶️ 核心资源 > 浏览器 > 编辑 > 更改指针密钥

此功能允许您更改指针在浏览器中的表示方式 。 默认情况下,指针由 objectId 显示链接对象。 您可以将此修改为对象类中的任何其他一栏。 例如,如果类 Installation 有包含指向类的字段 User,指针将显示 objectId 默认为用户。 您可以更改此选项以显示字段 email ,使指针显示用户的电子邮件地址.

限制

  • 这对数组指针不起作用;指针总是显示 objectId。 。 。 .
  • 系统列类 createdAt, (中文(简体) ), updatedAt, (中文(简体) ), ACL 无法设置为指针键.
  • 此功能使用浏览器存储; 切换到不同的浏览器将指针键重置到 objectId。 。 。 .

QQ 对于每行的自定义指针密钥,会触发服务器请求来解析自定义指针密钥. 例如,如果浏览器显示一个有50行的类,而每行包含3个自定义指针密钥,则总共会触发150个单独的服务器请求.

CSV 导出

▶️ 核心资源 > 浏览器 > 导出

此特性将带入单个类的所选行或所有行并保存到一个CSV文件,然后下载. CSV头被添加到匹配列名的文件上方.

QQ 当输出所有数据时, 目前有 1万行限制 。 如果班级中出现超过一万行,CSV文件只包含一万行.

捐款

我们真的希望Parse成为你的, 看着它在开源社区中成长和繁荣。 请看 协助解析 Dashboard 指南。 。 。 .


截至2017年4月5日,Parse,LLC已经将这个代码转移到了parse-社区组织,并且将不再为这个代码做出贡献或分发.

版本与发布记录

@gemforce/gemforce-dashboard 共发布 8 个版本,首次发布于 2022/10/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.2.0-alpha.25latest2023/02/173 年前
4.2.0-alpha.242023/01/203 年前
4.2.0-alpha.232022/10/264 年前
4.2.0-alpha.222022/10/224 年前
4.2.0-alpha.212022/10/214 年前
4.2.0-alpha.202022/10/214 年前

关于 @gemforce/gemforce-dashboard 的常见问题

@gemforce/gemforce-dashboard 是什么?

宝石出炉板

如何安装 @gemforce/gemforce-dashboard?

在项目目录运行 npm install @gemforce/gemforce-dashboard,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gemforce-dashboard,可以用 npx gemforce-dashboard 直接运行。

@gemforce/gemforce-dashboard 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gemforce__gemforce-dashboard 是否存在。

@gemforce/gemforce-dashboard 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gemforce/gemforce-dashboard 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=14.20.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gemforce/gemforce-dashboard 可以商用吗?

@gemforce/gemforce-dashboard 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@gemforce/gemforce-dashboard 的下载量有多少?

根据 npm 官方下载统计,@gemforce/gemforce-dashboard 在 2026/10/16 – 2026/11/14 这 30 天内被下载 19,607 次,日均约 654 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gemforce/gemforce-dashboard 还在维护吗?

最新版本 4.2.0-alpha.25 发布于 2023/02/17(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。