You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+15Lines changed: 15 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,20 @@
1
1
## Parse Dashboard Changelog
2
2
3
+
### 1.0.10
4
+
5
+
* Add the ability to specify icons for your app, thanks to [Natan Rolnik](https://github.com/natanrolnik)
6
+
* Fix sending push with JSON data
7
+
8
+
### 1.0.9
9
+
10
+
* Add the ability to mount the dashboard express app on a custom mount path, thanks to [hpello](https://github.com/hpello) with bugfixes from [mamaso](https://github.com/mamaso)
11
+
* Add ability to restrict certain users to certain apps, thanks to [Felipe Andrade](https://github.com/felipemobile)
12
+
* Fix Dockerfile, thanks to [Kakashi Liu](https://github.com/kkc)
13
+
* Display Parse Dashboard version, thanks to [Aayush Kapoor](https://github.com/xeoneux) and [gateway](https://github.com/gateway)
14
+
* Add a refresh button to the data browser, thanks to [TylerBrock](https://github.com/TylerBrock)
15
+
* Add logs viewer
16
+
* Misc. performance improvements and bugfixes, thanks to [Pavel Ivanov](https://github.com/pivanov)
17
+
3
18
### 1.0.8
4
19
5
20
* Allow Dashboard to be mounted as Express middleware, thanks to [Florent Vilmart](https://github.com/flovilmart)
Parse Dashboard is a standalone dashboard for managing your Parse apps. You can use it to manage your [Parse Server](https://github.com/ParsePlatform/parse-server) apps and your apps that are running on [Parse.com](https://Parse.com).
*[Separating App Access Based on User Identity](#separating-app-access-based-on-user-identity)
18
+
*[Run with Docker](#run-with-docker)
19
+
*[Contributing](#contributing)
20
+
5
21
# Getting Started
6
22
7
-
[Node.js](https://nodejs.org) version >= 4.3 is required to run the dashboard. You also need to be using Parse Server version 2.1.4 or higher. Install the dashboard from `npm`.
23
+
[Node.js](https://nodejs.org) version >= 4.3 is required to run the dashboard. You also need to be using Parse Server version 2.1.4 or higher.
24
+
25
+
# Local Installation
26
+
27
+
Install the dashboard from `npm`.
8
28
9
29
```
10
30
npm install -g parse-dashboard
@@ -16,11 +36,16 @@ You can launch the dashboard for an app with a single command by supplying an ap
You can then visit the dashboard in your browser at http://localhost:4040. 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.
39
+
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.
20
40
21
-
If you want to manage multiple apps from the same dashboard, you can start the dashboard with a config file. For example, you could put your info into a file called `parse-dashboard-config.json` and then start the dashboard using `parse-dashboard --config parse-dashboard-config.json`. The file should match the following format:
41
+
After starting the dashboard, you can visit http://localhost:4040 in your browser:
22
42
23
-
```
43
+
44
+
45
+
## Configuring Parse Dashboard
46
+
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:
47
+
48
+
```json
24
49
{
25
50
"apps": [
26
51
{
@@ -33,13 +58,19 @@ If you want to manage multiple apps from the same dashboard, you can start the d
33
58
}
34
59
```
35
60
36
-
You can also manage apps that on Parse.com from the same dashboard. In your config file, you will need to add the `restKey` and `javascriptKey` as well as the other paramaters, which you can find on `dashboard.parse.com`. Set the serverURL to `http://api.parse.com/1`:
61
+
You can then start the dashboard using `parse-dashboard --config parse-dashboard-config.json`.
37
62
38
-
```
63
+
## Managing Multiple Apps
64
+
65
+
Managing multiple apps from the same dashboard is also possible. Simply add additional entries into the `parse-dashboard-config.json` file's `"apps"` array.
66
+
67
+
You can manage self-hosted [Parse Server](https://github.com/ParsePlatform/parse-server) apps, *and* apps that are hosted on [Parse.com](http://parse.com/) from the same dashboard. In your config file, you will need to add the `restKey` and `javascriptKey` as well as the other paramaters, which you can find on `dashboard.parse.com`. Set the serverURL to `http://api.parse.com/1`:
68
+
69
+
```json
39
70
{
40
71
"apps": [
41
72
{
42
-
"serverURL": "https://api.parse.com/1",
73
+
"serverURL": "https://api.parse.com/1",// Hosted on Parse.com
43
74
"appId": "myAppId",
44
75
"masterKey": "myMasterKey",
45
76
"javascriptKey": "myJavascriptKey",
@@ -48,7 +79,7 @@ You can also manage apps that on Parse.com from the same dashboard. In your conf
48
79
"production": true
49
80
},
50
81
{
51
-
"serverURL": "http://localhost:1337/parse",
82
+
"serverURL": "http://localhost:1337/parse",// Self-hosted Parse Server
52
83
"appId": "myAppId",
53
84
"masterKey": "myMasterKey",
54
85
"appName": "My Parse Server App"
@@ -57,22 +88,48 @@ You can also manage apps that on Parse.com from the same dashboard. In your conf
57
88
}
58
89
```
59
90
60
-
91
+
## App Icon Configuration
61
92
62
-
# Advanced Usage
93
+
Parse Dashboard supports adding an optional icon for each app, so you can identify them easier in the list. To do so, you *must* use the configuration file, define an `iconsFolder` in it, and define the `iconName` parameter for each app (including the extension). The path of the `iconsFolder` is relative to the configuration file. To visualize what it means, in the following example `icons` is a directory located under the same directory as the configuration file:
63
94
64
-
## Other options
95
+
```json
96
+
{
97
+
"apps": [
98
+
{
99
+
"serverURL": "http://localhost:1337/parse",
100
+
"appId": "myAppId",
101
+
"masterKey": "myMasterKey",
102
+
"appName": "My Parse Server App",
103
+
"iconName": "MyAppIcon.png",
104
+
}
105
+
],
106
+
"iconsFolder": "icons"
107
+
}
108
+
```
109
+
110
+
## Other Configuration Options
111
+
112
+
You can set `appNameForURL` in the config file for each app to control the url of your app within the dashboard. This can make it easier to use bookmarks or share links on your dashboard.
113
+
114
+
To change the app to production, simply set `production` to `true` in your config file. The default value is false if not specified.
65
115
66
-
You can set `appNameForURL` in the config file for each app to control the url of your app within the dashboard. This can make it easier to use bookmarks or share links on your dashboard. To change the app to production, simply set `production` to `true` in your config file. Defaults to false if not specified.
116
+
# Deploying Parse Dashboard
67
117
68
-
## Deploying the dashboard
118
+
## Preparing for Deployment
69
119
70
120
Make sure the server URLs for your apps can be accessed by your browser. If you are deploying the dashboard, then `localhost` urls will not work.
71
121
72
-
In order to securely deploy the dashboard without leaking your apps master key, you will need to use HTTPS and Basic Auth. You can do this by adding usernames and passwords for HTTP Basic Auth to your configuration file.
73
-
```
122
+
## Security Considerations
123
+
In order to securely deploy the dashboard without leaking your apps master key, you will need to use HTTPS and Basic Authentication.
124
+
125
+
The deployed dashboard detects if you are using a secure connection. If you are deploying the dashboard behind a load balancer or proxy that does early SSL termination, then the app won't be able to detect that the connection is secure. In this case, you can start the dashboard with the `--allowInsecureHTTP=1` option. You will then be responsible for ensureing that your proxy or load balancer only allows HTTPS.
126
+
127
+
### Configuring Basic Authentication
128
+
You can configure your dashboard for Basic Authentication by adding usernames and passwords your `parse-dashboard-config.json` configuration file:
129
+
130
+
```json
74
131
{
75
-
"apps": [...],
132
+
"apps": [{"...": "..."}],
76
133
"users": [
77
134
{
78
135
"user":"user1",
@@ -86,7 +143,33 @@ In order to securely deploy the dashboard without leaking your apps master key,
86
143
}
87
144
```
88
145
89
-
The deployed dashboard detects if you are using a secure connection. If you are deploying the dashboard behind a load balancer or proxy that does early SSL termination, then the app won't be able to detect that the connection is secure. In this case, you can start the dashboard with the `--allowInsecureHTTP=1` option. You will then be responsible for ensureing that your proxy or load balancer only allows HTTPS.
146
+
### Separating App Access Based on User Identity
147
+
If you have configured your dashboard to manage multiple applications, you can restrict the management of apps based on user identity.
148
+
149
+
To do so, update your `parse-dashboard-config.json` configuration file to match the following format:
When `user1` logs in, he/she will be able to manage `appId1` and `appId2` from the dashboard.
170
+
171
+
When *`user2`* logs in, he/she will only be able to manage *`appId1`* from the dashboard.
172
+
90
173
91
174
## Run with Docker
92
175
@@ -110,8 +193,8 @@ In this example, we want to run the application in production mode at port 80 of
110
193
docker run -d -p 80:8080 -v host/path/to/config.json:/src/Parse-Dashboard/parse-dashboard-config.json parse-dashboard --port 8080
111
194
```
112
195
113
-
If you are not familiar with Docker, ``--port 8080``with be passed in as argument to the entrypoint to form the full command ``npm start -- --port 8080``. The application will start at port 8080 inside the container and port ``8080`` will be mounted to port ``80`` on your host machine.
196
+
If you are not familiar with Docker, ``--port 8080``will be passed in as argument to the entrypoint to form the full command ``npm start -- --port 8080``. The application will start at port 8080 inside the container and port ``8080`` will be mounted to port ``80`` on your host machine.
114
197
115
-
##Contributing
198
+
# Contributing
116
199
117
200
We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the [Contributing to Parse Dashboard guide](CONTRIBUTING.md).
0 commit comments