Unverified Commit a703a703 authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot
Browse files

GitBook: [master] 673 pages modified

parent 164a6b66
......@@ -183,8 +183,7 @@
* [Custom sounds](guides/administrator-guides/custom-sounds.md)
* [Restoring an Admin User](guides/administrator-guides/restoring-an-admin.md)
* [Permissions](guides/administrator-guides/permissions.md)
* [Notifications](guides/administrator-guides/notifications/README.md)
* [Push Notifications](guides/administrator-guides/notifications/push-notifications.md)
* [Notifications](guides/administrator-guides/notifications.md)
* [Database Migration](guides/administrator-guides/database-migration.md)
* [Retention Policies](guides/administrator-guides/retention-policies.md)
* [Engagement Dashboard](guides/administrator-guides/engagement-dashboard.md)
......@@ -212,7 +211,8 @@
* [Tags](guides/omnichannel-guides/omnichannel-manger-guides/tags.md)
* [Priorities](guides/omnichannel-guides/omnichannel-manger-guides/priority-queue.md)
* [Mobile Guides](guides/mobile-guides/README.md)
* [Push Notifications](guides/mobile-guides/push-notifications.md)
* [Push Notifications](guides/mobile-guides/push-notifications-1/README.md)
* [Push Notifications Admin Guide](guides/mobile-guides/push-notifications-1/push-notifications-admin-guide.md)
* [Security and Compliance Guides](guides/security/README.md)
* [Compliance Resources and Certifications](guides/security/compliance-resources.md)
* [Security fixes and updates](guides/security/security-updates.md)
......
# Notifications
Use the **Bell** icon to configure notifications within your channel or room. Other preferences are available in the`Personel Settings`dialog. Make sure your preferences include Receiving unread messages to get notifications.
## Desktop
Upon starting Rocket.Chat, you are asked to allow desktop notifications. Notifications appear as small boxes on the right corner, depending on the general or per-room settings.
## Mobile
Depending on your settings per room or channel, you receive notifications on your mobile device for all messages or only if somebody mentions you. Notifications in rooms are only sent when the desktop client goes with no use for more than five minutes. Currently, changing your status to "Away" does not speed up the countdown.
Depending on the privacy settings set by the administrator, you will see the sender, room name or the first line of the message as a notification on your mobile device.
## Emails
Notifications of direct messages or mentions by @username are sent by Email to your E-Mail address, but only if no web-client is connected.
## Mentions
@username - notifies this person @all - notifies all members of this room or channel @here - notifies all members of this room or channel who are online
# Push Notifications
There are two ways to set up push notifications with Rocket.Chat:
* Push Gateway
* Self Configured
## Push Gateway
If you and your users intend to use the official Rocket.Chat mobile applications you need to choose this option.
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.
## Self Configured
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.
Then also you will need to add your keys to Rocket.Chat.
Then you will have to compile for iOS and Android and submit them to the appropriate app stores for review.
Finally, you would direct your users to download your custom version of the Rocket.Chat mobile applications.
### Configuring for Android
The Rocket.Chat native application for Android supports the FCM system. Here's how you configure it:
1. Create a Firebase project in the Firebase console, if you don't already have one. Click Add project. If you already have an existing Google project associated with your mobile app, select it from the Project name drop-down menu. Otherwise, enter a project name to create a new project.
2. _Optional:_ Edit your Project ID. Your project is given a unique ID automatically, and it's used in publicly visible Firebase features such as database URLs and your Firebase Hosting subdomain. You can change it now if you want to use a specific subdomain.
3. Follow the remaining setup steps and click Create a project \(or Add Firebase if you're using an existing project\) to begin provisioning resources for your project. This typically takes a few minutes. When the process completes, you'll be taken to the project overview.
Now that you have a project, you can add your Android app to it:
1. Click Add Firebase to your Android app and follow the setup steps. If you're importing an existing Google project, this may happen automatically and you can just [download the config file](http://support.google.com/firebase/answer/7015592).
2. When prompted, enter your app's package name. It's important to enter the package name your app is using; this can only be set when you add an app to your Firebase project.
3. During the process, you'll download a `google-services.json` file. You can [download this file](http://support.google.com/firebase/answer/7015592) again at any time.
4. After you add the initialization code, run your app to send verification to the Firebase console that you've successfully installed Firebase.
### Configuring for iOS
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](https://github.com/raix/push/blob/v3.x/docs/IOS.md)
### Configuring Rocket.Chat
* Go to "Administration", then "Push"
* Set the Enable Gateway to False, then plug the information obtained from Apple and Google
* Restart server \(without this it will not work\)
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. You should see a test notification after you pressed the send button.
## Privacy
Rocket.Chat allows for additional privacy configurations on push notifications:
* Show Channel/Group/Username in Notification: Default is "TRUE", disabling this setting prevents the Channel, Group, Discussion, and Username from being sent to the push notification gateway
* Show Message in Notification: Default is "TRUE", disabling this setting prevents the message content from being sent to the push notification gateway
If both settings are set to "FALSE", the user will receive a push notification without contextual information, as no such contextual information is sent to the push notification gateway in the first place. The user can then access the contextual information by opening the Rocket.Chat application. This is helpful in compliance-sensitive requirements like HIPAA to prevent sensitive information from being disclosed via push notification.
## General Observations
* If you don't want notifications you can just disable the gateway and not provide keys.
* You cannot compile your own applications and use the Rocket.Chat push gateway.
* 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
* Once everything is configured on the admin settings, the server must be restarted
## FAQ
### I am getting "Server notifications are misconfigured!"
If you are getting this message and are using our push gateway please make sure:
1. Your server version is greater or equal to 0.74.3
2. Registered \(you can check this by going to `http://yourserver/admin/cloud`\)
_Thanks to @lvh1 and @lunitic for starting this doc_
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment