Skip to content

Commit 38fbd9b

Browse files
Add push FAQ and refactor doc some (RocketChat#1090)
* Add new message to faq and refactor doc some * Update README.md * Update README.md * change version string to plain english * Update README.md * Update README.md * Fix lint errors... Try RocketChat#1
1 parent db3b573 commit 38fbd9b

File tree

1 file changed

+37
-12
lines changed
  • administrator-guides/notifications/push-notifications

1 file changed

+37
-12
lines changed
Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
# Push Notifications
22

3-
Mobile Notifications Gateway Configuration
3+
There are two ways to setup push notifications with Rocket.Chat:
44

5-
The following description, from community member @lvh1 and updated by @lunitic, describes how to configure mobile notification gateways using the latest edition of Rocket.Chat.
5+
* Push Gateway
6+
* Self Configured
67

7-
## Android
8+
## Push Gateway
9+
10+
If you and your users intend to use the official Rocket.Chat mobile applications you need to choose this option.
11+
12+
To allow push notifications to be received on our official mobile application by any server, we had to establish a push gateway containing our keys. In doing so, we protect our secret keys required to send through Apple(APN) and Google(FCM) to send you and your users notifications.
13+
14+
## Self Configured
15+
16+
When you choose to self configure the push notifications, things become a bit more complicated. First, you need to get keys from both Apple and Google, and compile/release your own mobile applications to the app stores so your public keys will be distributed to your users.
17+
18+
Then also you will need to add your keys to Rocket.Chat.
19+
20+
Then you will have to compile for iOS and Android and submit them to the appropriate app stores for review.
21+
22+
Finally you would direct your users to download your custom version of the Rocket.Chat mobile applications.
23+
24+
### Configuring for Android
825

926
The Rocket.Chat native application for Android supports FCM system. Here's how you configure it:
1027

@@ -24,25 +41,33 @@ Now that you have a project, you can add your Android app to it:
2441

2542
4. After you add the initialization code, run your app to send verification to the Firebase console that you've successfully installed Firebase.
2643

27-
## Rocket.Chat Cordova
28-
29-
Fill in GCM Project Number in the file www/shared/js/android_sender_id.js, replace "YOUR-ANDROID-ID-HERE" with your GCM Project Number
30-
31-
## iOS
44+
### Configuring for iOS
3245

3346
For iOS you need an apple developer account that costs US$99 per year. Follow instructions here: <https://github.com/raix/push/blob/v3.x/docs/IOS.md>
3447

35-
## Rocket.Chat
48+
### Configuring Rocket.Chat
3649

3750
- Go to "Administration", then "Push"
38-
- Set the Enable Gateway to False, then you will use your own Rocket.Chat as gateway instead of the <https://rocket.chat> server
39-
- Restart server
51+
- Set the Enable Gateway to False, then plug the information obtained from Apple and Google
52+
- Restart server (with out this it will not work)
4053

4154
Now you should be able to Send a test message. Make sure that you have logged in to the server once, and then closed the app.
4255
You should see a test notification after you pressed the send button.
4356

4457
## General Observations
4558

46-
- You don't *need* to use a push gateway, if you don't want notifications. Adding certificates and checking to *not* user a gateway is enough
59+
- If you don't want notifications you can just disable gateway and not provide keys.
60+
- You cannot compile your own applications and use the Rocket.Chat push gateway.
4761
- For iOS, you need to [convert](https://github.com/raix/push/blob/master/docs/IOS.md) both the .cer and .p12 files into .pem files
4862
- Once everything is configured on the admin settings, the server must be restarted
63+
64+
## FAQ
65+
66+
### I am getting "Server notifications are misconfigured!"
67+
68+
If you are getting this message and are using our push gateway please make sure:
69+
70+
1. Your server version is greater or equal to 0.74.3
71+
2. Registered (you can check this by going to `http://yourserver/admin/cloud`)
72+
73+
_Thanks to @lvh1 and @lunitic for starting this doc_

0 commit comments

Comments
 (0)