Added icons to the dashboard

vegidio · vegidio · commit 751765446623 · 2020-07-10T12:55:30.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 # User-specific stuff:
 .idea/
 build/
+icons/
 
 ## File-based project format:
 *.iws
diff --git a/.run/Run Dashboard.run.xml b/.run/Run Dashboard.run.xml
@@ -6,7 +6,7 @@
             <env name="TS_NODE_FILES" value="true"/>
             <env name="SERVER_URL" value="http://localhost"/>
             <env name="MASTER_KEY" value="12345678"/>
-            <env name="APP_IDS" value="app1"/>
+            <env name="APP_IDS" value="test"/>
             <env name="DASHBOARD_USERNAME" value="username"/>
             <env name="DASHBOARD_PASSWORD" value="password"/>
         </envs>
diff --git a/.run/Run Parse.run.xml b/.run/Run Parse.run.xml
@@ -1,17 +1,17 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Parse" type="NodeJSConfigurationType" node-parameters="--require ts-node/register --trace-warnings" path-to-js-file="src/parse.ts" working-dir="$PROJECT_DIR$">
-    <envs>
-      <env name="TS_NODE_FILES" value="true" />
-      <env name="NODE_PORT" value="9001" />
-      <env name="SERVER_URL" value="http://localhost" />
-      <env name="MASTER_KEY" value="12345678" />
-      <env name="APP_ID" value="app1" />
-      <env name="DB_HOST" value="mongodb://db_host:27017" />
-      <env name="DB_USERNAME" value="db_username" />
-      <env name="DB_PASSWORD" value="db_password" />
-      <env name="LIVE_QUERIES" value="Movie" />
-      <env name="DELETE_ORPHANS" value="Movie" />
-    </envs>
-    <method v="2" />
-  </configuration>
+    <configuration default="false" name="Run Parse" type="NodeJSConfigurationType"
+                   node-parameters="--require ts-node/register --trace-warnings" path-to-js-file="src/parse.ts"
+                   working-dir="$PROJECT_DIR$">
+        <envs>
+            <env name="TS_NODE_FILES" value="true"/>
+            <env name="NODE_PORT" value="9001"/>
+            <env name="SERVER_URL" value="http://localhost"/>
+            <env name="MASTER_KEY" value="12345678"/>
+            <env name="APP_ID" value="test"/>
+            <env name="DB_URL" value="mongodb://username:password@localhost:27017"/>
+            <env name="LIVE_QUERIES" value="Movie"/>
+            <env name="DELETE_ORPHANS" value="Movie"/>
+        </envs>
+        <method v="2"/>
+    </configuration>
 </component>
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/vegidio/parse.svg)](https://hub.docker.com/r/vegidio/parse)
 [![ISC License](https://img.shields.io/npm/l/vimdb?color=important)](LICENSE.txt)
 
-A Docker image for the [Parse Server](https://parseplatform.org/) with Dashboard pre-installed and a new feature to delete orphan files when a document associated with them is removed from the database.
+A Docker image for the [Parse Server](https://parseplatform.org/) with Dashboard pre-installed and a new feature to delete orphan files when an object associated with them is removed from the database.
 
 It's based on [Express](https://expressjs.com) and supports single and multiple applications per instance.
 
@@ -19,11 +19,9 @@ Run the container using the image **vegidio/parse**:
 ```
 $ docker run -d \
     -e SERVER_URL=http://hostname \
+    -e DB_URL=mongodb://db_host:27017 \
     -e MASTER_KEY=12345678 \
     -e APP_IDS=app1,app2 \
-    -e DB_HOST=mongodb://database_host:27017 \
-    -e DB_USERNAME=db_username \
-    -e DB_PASSWORD=db_password \
     -e LIVE_QUERIES='app1:Movie,Actor|app2:Post' \
     -e DELETE_ORPHANS='app1:Review|app2:Comment' \
     -e DASHBOARD_USERNAME=dashboard_username \
@@ -34,12 +32,20 @@ $ docker run -d \
 
 The full list of environment variables and how they can be used to configure your Parse Server can be found in the [Parameters](#-parameters) section.
 
-### Multiple applications
+### Multiple Applications
 
 If you want to run more than one application in the same instance then you just need to add them in the environment variable `APP_IDS`, in a single string separated by comma `,`.
 
 For example, the environment variable `-e APP_ID=app1,app2,app3` will create 3 apps called `app1`, `app2` and `app3`.
 
+### URLs
+
+* __Apps:__ each app in the Parse Server can be accessed through the URL [server_url/app/`app_id`]().
+* __GraphQL:__ each app can also be accessed through GraphQL with the URL [server_url/app/`app_id`/graphql]().
+* __Dashboard:__ The Parse Dashboard can be accessed through the URL [server_url/dashboard]().
+
+## ✨ Special Features
+
 ### Live Query
 
 To enable **Live Queries** you must specify during the initialization of your Parse Server exactly what applications and classes should have this feature enabled. To do that, add the environment variable `LIVE_QUERIES` with a content with this format:
@@ -56,37 +62,50 @@ where:
 
 For example, the environment variable `-e LIVE_QUERIES='app1:Movie,Actor|app2:Post'` will enable Live Queries in the classes `Movie` and `Actor` that belong to `app1`; and it will also enable Live Queries in the class `Post` that belong to `app2`.
 
-### URLs
+### Delete Orphan Files
 
-* __Apps:__ each app in the Parse Server can be accessed through the URL [hostname/app/`app_id`]().
-* __GraphQL:__ each app can also be accessed through GraphQL with the URL [hostname/app/`app_id`/graphql]().
-* __Dashboard:__ The Parse Dashboard can be accessed through the URL [hostname/dashboard]().
+By default, when a file is saved in the Parse Server and later deleted, only the file reference is actually removed from the database, but the file itself remains there. After some adding and removing files in the Parse Server, you will end up with many orphan files saved that are only occupying space.
 
-## 🧩 Parameters
+To avoid this problem you can set the environment variable `DELETE_ORPHANS` with the names of the classes that must automatically removed any orphan files when an object is deleted or updated. This variable must have the following format:
 
-Here is the full list of parameters used by the Parse Server:
+```
+<appId1>:<ClassA>,<ClassB>|<appId2>:<ClassC>,<ClassD>
+```
 
-### Database Authentication
+where:
 
-If your database requires authentication then you need to set the parameters below when you run the Parse Server, otherwise they can be ignored:
+- `<appId>`: is the unique ID of your parse application, followed by the colon sign (`:`).
+- `<Class>`: is the name of the class where the orphan files must be removed. If you want to remove orphan files from more than one class then each class must be separated by a comma (`,`).
+- Each application and its classes must be separated by a pipe sign (`|`).
 
-- `DB_USERNAME`: the username used to login in the database. This user must have access to create new schemas.
-- `DB_PASSWORD`: the password used to login in the database.
+For example, the environment variable `-e DELETE_ORPHANS='app1:Movie,Actor|app2:Post'` will remove orphan files from the classes `Movie` and `Actor` that belong to `app1`; and it will also delete orphan files from the class `Post` that belong to `app2`.
 
-### Optional
+## 🧩 Parameters
 
-- `LIVE_QUERIES`: please see [Live Query](#live-query) above.
-- `DELETE_ORPHANS`: TBD
+Here is the full list of parameters used by the Parse Server:
 
 ### Mandatory
 
-- `DB_HOST`: the hostname and port where the database is hosted. You **must** include here the protocol `mongodb://` or `postgres://`, according to the database that you are using.
-- `SERVER_URL`: the remote URL to access your Parse Server. You **must** include the protocol (`http://` or `https://`) here and the port, if needed.
+- `SERVER_URL`: the remote URL to access your Parse Server. You **must** include the protocol here (`http://` or `https://`) and the port, if needed.
+- `DB_URL`: the connection URL to the database. You **must** include here the protocol (`mongodb://` or `postgres://`) according to the database that you are using. If your database requires authentication, don't forget to include username and password as well. For example: `mongodb://username:password@localhost:27017`.
 - `MASTER_KEY`: the key used to grant access to the users that want to access the Parse API.
 - `APP_IDS`: one ore more unique IDs, separated by comma `,` to identify your apps. These IDs will also be used to form the URLs of your Parse apps.
 - `DASHBOARD_USERNAME`: the username used to login in the Parse Dashboard.
 - `DASHBOARD_PASSWORD`: the password used to login in the Parse Dashboard.
 
+### Optional
+
+- `LIVE_QUERIES`: please see [Live Query](#live-query) above.
+- `DELETE_ORPHANS`: please see [Delete Orphan Files](#delete-orphan-files) above.
+
+## 🛠 Build the image
+
+If you prefer to build this image yourself, instead of using the pre-built image available on [Docker Hub](https://hub.docker.com/r/vegidio/parse), then enter the following command in terminal, in the project's root directory:
+
+```
+$ docker build -t vegidio/parse --build-arg VERSION=1.2.3 .
+```
+
 ## 📝 License
 
 **vegidio/parse** is released under the ISC License. See [LICENSE](LICENSE.txt) for details.
diff --git a/apps.config.js b/apps.config.js
@@ -46,13 +46,11 @@ parseArray.forEach(appId => {
         cwd: '/var/www/parse',
         exec_mode: 'cluster',
         env: {
-            APP_ID: appId,
             NODE_PORT: port,
             SERVER_URL: process.env.SERVER_URL,
+            DB_URL: process.env.DB_URL,
             MASTER_KEY: process.env.MASTER_KEY,
-            DB_HOST: process.env.DB_HOST,
-            DB_USERNAME: process.env.DB_USERNAME,
-            DB_PASSWORD: process.env.DB_PASSWORD,
+            APP_ID: appId,
             LIVE_QUERIES: liveQueryClasses,
             DELETE_ORPHANS: deleteOrphanClasses
         }
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -7,9 +7,7 @@ services:
       - SERVER_URL=http://localhost
       - MASTER_KEY=123456
       - APP_IDS=app1,app2
-      - DB_HOST=mongodb://mongo:27017
-      - DB_USERNAME=username
-      - DB_PASSWORD=password
+      - DB_URL=mongodb://username:password@mongo:27017
       - LIVE_QUERIES=app1:Movie|app2:Actor
       - DELETE_ORPHANS=app1:Movie|app2:Actor
       - DASHBOARD_USERNAME=username
diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
         "@types/http-proxy-middleware": "latest",
         "express": "latest",
         "http-proxy-middleware": "latest",
+        "jdenticon": "latest",
         "parse-dashboard": "latest",
         "parse-server": "latest",
         "winston": "latest"
diff --git a/src/dashboard.ts b/src/dashboard.ts
@@ -1,5 +1,7 @@
+import * as fs from 'fs'
 import * as express from 'express'
 import * as ParseDashboard from 'parse-dashboard'
+import * as jdenticon from 'jdenticon'
 import { createProxyMiddleware } from 'http-proxy-middleware'
 import logger from './logger'
 
@@ -17,11 +19,18 @@ parseArray.forEach(appId => {
     apps.push({
         appId: appId,
         appName: appId,
+        iconName: `${appId}.svg`,
         serverURL: `${process.env.SERVER_URL}/app/${appId}`,
-        graphQLServerURL: `http://${process.env.SERVER_URL}/app/${appId}/graphql`,
+        graphQLServerURL: `${process.env.SERVER_URL}/app/${appId}/graphql`,
         masterKey: process.env.MASTER_KEY,
     })
 
+    // Creating app icon
+    const icon = jdenticon.toSvg(appId, 56)
+    const iconFolder = 'icons'
+    if(!fs.existsSync(iconFolder)) fs.mkdirSync(iconFolder)
+    fs.writeFileSync(`${iconFolder}/${appId}.svg`, icon)
+
     // Create friendly path to the app, without the port
     app.use(`/app/${appId}`, createProxyMiddleware({
         target: `http://0.0.0.0:${appPort}`,
@@ -33,6 +42,7 @@ parseArray.forEach(appId => {
 // Dashboard configuration
 const dashboard = new ParseDashboard({
     apps: apps,
+    iconsFolder: 'icons',
     users: [{ 'user': process.env.DASHBOARD_USERNAME, 'pass': process.env.DASHBOARD_PASSWORD }]
 }, {
     allowInsecureHTTP: true
diff --git a/src/database.ts b/src/database.ts
diff --git a/src/parse.ts b/src/parse.ts
@@ -1,6 +1,5 @@
 import * as express from 'express'
 import ParseServer, { ParseGraphQLServer } from 'parse-server'
-import db from './database'
 import cloud from './cloud'
 import logger from './logger'
 
@@ -15,7 +14,7 @@ const parseServer = new ParseServer({
     appId: appId,
     serverURL: `http://0.0.0.0:${port}`,
     publicServerURL: `${process.env.SERVER_URL}/app/${appId}`,
-    databaseURI: db.buildConnectionUrl(process.env),
+    databaseURI: `${process.env.DB_URL}/parse_${appId}?authSource=admin`,
     masterKey: process.env.MASTER_KEY,
     liveQuery: { classNames: liveQueryArray }
 })
