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: README.md
+4-20Lines changed: 4 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,7 @@ To use Firebase Cloud Messaging(FCM), you will need to configure the following p
124
124
| fcmserver.serverkey | Server Key from FCM. Can be found in the FCM project settings | NA | Yes |
125
125
| fcmserver.fcmsender | The Sender to use for sending messages. There is a choice of using XMPP or FCM Admin SDK. |`org.radarbase.fcm.downstream.XmppFcmSender`| No |
126
126
127
-
**Note:** Only sending messages via XMPP protocol supports Delivery Receipts on FCM.
127
+
**Note:** Only sending messages via XMPP protocol supports Delivery Receipts on FCM.
128
128
129
129
### AdminSDK
130
130
To configure AdminSDK, follow the official Firebase [documentation](https://firebase.google.com/docs/admin/setup#initialize-sdk) till you setup the enviroment variable. In the properties file, you would need to change `fcmserver.fcmsender` to `org.radarbase.fcm.downstream.AdminSdkFcmSender` and set `fcmserver.xmpp.upstream.enable` to `false`.
@@ -144,7 +144,7 @@ The same can be achieved by running as a docker-compose service. Just specify th
144
144
```yml
145
145
services:
146
146
appserver:
147
-
image: radarbase/radar-appserver:0.0.1
147
+
image: radarbase/radar-appserver:1.1.0
148
148
restart: always
149
149
ports:
150
150
- 8080:8080
@@ -356,7 +356,7 @@ To enable security of specific provider, please read the sections below.
356
356
### Management Portal
357
357
To enable security via the [RADAR Management Portal](https://github.com/RADAR-base/ManagementPortal), set the following property -
358
358
```ini
359
-
managementportal.security.enabled=true
359
+
security.radar.managementportal.url=true
360
360
```
361
361
This will instantiate all the classes needed for security using the management portal. Per endpoint level auth is controlled using Pre and Post annotations for each permission.
362
362
All the classes are located in [/src/main/java/org/radarbase/appserver/auth/managementportal](/src/main/java/org/radarbase/appserver/auth/managementportal).
@@ -480,20 +480,4 @@ This will run checkstyle, PMD, spot bugs, unit tests and integration tests.
480
480
- Uses [lombok.data](https://projectlombok.org/) in most places to reduce boiler plate code and make it more readable.
481
481
- Has support for Auditing of database entities.
482
482
- Uses and extends the Spring XMPP integration library for implementing the XMPP protocol.
483
-
- Extends `XmppConnectionFactoryBean` with support for Reconnection and connection draining implementation using a Back-off strategy.
484
-
485
-
### TODO
486
-
487
-
- Add better documentation.
488
-
- Add validation of notification requests using the protocol and enrolment date of the user.
489
-
- Add endpoint to filter notifications based on different params.
490
-
-~~Update lastOpened metric for user when a request is received.~~
491
-
-~~Add batch scheduling of notifications.~~
492
-
- Add Management Portal service for getting any missing info not present in a request.
493
-
- Add support for sending messages via Firebase Admin SDK.
494
-
-~~Make the Xmpp Connection more robust by adding reconnection logic.~~
495
-
- Break out the org.radarbase.fcm package into its own module to be used as a library.
496
-
-~~Add docker builds.~~
497
-
- Add a Angular UI to view, update and schedule/send notifications to subjects.
498
-
- Investigate the feasibility of adding as an integration to the Management Portal for various tasks. (For instance, a new token can be sent via push notification using a button on MP to the device if the token has expired).
499
-
-~~Add security to the application using MP OAuth client resource.~~
483
+
- Extends `XmppConnectionFactoryBean` with support for Reconnection and connection draining implementation using a Back-off strategy.
0 commit comments