Merge pull request #1595 from nextcloud/extend-notification-testing

Extend notification testing docs

docs/notifications.md

@@ -1,34 +1,95 @@
+# Debugging push notifications
+
 This list is intended to help users that have problems to receive talk notifications on their android phone. It may 
 not be complete. Please contribute to this list as you gain new knowledge. Just create an issue with the 
 "notification" label or create a pull request for this document. 
 
-# for users
-- please install the app from google playstore. The f-droid version doesn't support notifications.
-- only talk notifications will be delivered by the talk app, for all other notifications install the nextcloud files app from google playstore.
+# 📱 Users
+- Please make sure to install the app from the Google PlayStore. The f-droid version doesn't support push notifications.
   
-## check android settings
-Please take into account that the android settings might be different for each manufacturer. It might be worth it to check what other messaging apps recommend to get their apps running on a certain smartphone and adapt this to the talk app.
+  [<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
+  alt="Download from Google Play"
+  height="80">](https://play.google.com/store/apps/details?id=com.nextcloud.talk2)
+- Only talk notifications will be delivered by the Talk app, for all other notifications install the Nextcloud Files 
+  app from Google PlayStore.
   
-- check that your phone is not in "do not disturb" mode and has internet access
-- check the android settings like "energy saving" and "notifications" regulary as they might be reset by android!
-- energy saving options
-	- example for xiaomi redmi:
-		- go to "settings" - "Battery & performance" - "App battery saver" - tap on the Talk app - set "No restrictions"
-- notification options
-	- example for xiaomi redmi:
-		- go to "settings" - "Notifications" - tap on the Talk app - enable "Show notifications" and if you like enable "Lock screen notifications"
-
-## check talk app settings
-- in the settings, check if ringtones are set for calls and notifications and if vibration is activated if you would like so.
-- in the conversation settings (in the upper right corner of a conversation), check that notifications are set to "Always notify" or "Notify when mentioned"
-	- be aware that is is a per conversation setting. set it to every conversation differently depending on your needs.
+  [<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
+  alt="Download from Google Play"
+  height="80">](https://play.google.com/store/apps/details?id=com.nextcloud.client)
 
 If your problem still occurs after checking all these hints, create an issue at https://github.com/nextcloud/talk-android/issues
 
-# for developers/testers
-- be aware that the "qa"-versions that you can install by scanning the QR-code in a github pull request don't support notifications!
+## 🤖 Check android settings
+
+Please take into account that the android settings might be different for each manufacturer. It might be worth it to check what other messaging apps recommend to get their apps running on a certain smartphone and adapt this to the talk app.
+
+- Check that your phone is not in "do not disturb" mode
+- Check that your phone has internet access
+- Check the android settings like "energy saving" and "notifications" regularly as they might be reset by android at 
+  any time!
+    - Energy saving options example for Xiaomi RedMi:
+		- go to "Settings" 
+        - "Battery & performance"
+        - "App battery saver"
+        - tap on the Talk app 
+        - set "No restrictions"
+    - Notification options example for Xiaomi RedMi:
+		- go to "Settings" 
+        - "Notifications" 
+        - tap on the Talk app 
+        - enable "Show notifications" and if you like 
+          enable "Lock screen notifications"
+
+## 🗨️ Check talk app settings
+- In the settings, check if ringtones are set for calls and notifications and if vibration is activated if you would 
+  like so.
+- In the conversation settings (in the upper right corner of a conversation), check that notifications are set to 
+  "Always notify" or "Notify when mentioned"
+	- Be aware that this is a per conversation setting. Set it for every conversation differently depending on your 
+      needs.
+- Also be aware that notifications are not generated when you have an active session for a conversation. This also applies for tabs that are open in the background, etc.
+
+## 🖥 Check server settings
+
+
+
+*Note: If the command is not available, make sure you have the https://github.com/nextcloud/notifications app installed on your instance. It is shipped and enabled by default, but could be missing in development environments or being disabled manually.*
+
+Run the `notification:test-push` command for the user:
+
+```bash
+sudo -u www-data php /var/www/html/occ notification:test-push --talk admin
+```
+
+It should print something like the following:
+```
+Trying to push to 2 devices
+  
+Language is set to en
+Private user key size: 1704
+Public user key size: 451
+Identified 1 Talk devices and 1 others.
+
+Device token:156850
+Device public key size: 451
+Data to encrypt is: {"nid":525210,"app":"admin_notification_talk","subject":"Testing push notifications","type":"admin_notifications","id":"614aeee4"}
+Signed encrypted push subject
+Push notification sent successfully
+```
+
+If it prints something like
+```
+sudo -u www-data php /var/www/html/occ notification:test-push --talk admin
+No devices found for user
+```
+
+try to remove the account from Nextcloud Talk app and create it again. Afterwards try to run the command again.
+
+# 🦺 Developers/testers
+- Be aware that the "qa"-versions that you can install by scanning the QR-code in a github pull request don't 
+  support notifications!
 
 - When starting the talk app within Android Studio, make sure to select the "gplayDebug" build variant:
 ![gplay debug build variant](/docs/gplayDebugBuildVariant.png "gplay debug build variant")
 
-- especially after reinstalling the app, make sure to always check the android settings as they might be reset.
+- Especially after reinstalling the app, make sure to always check the android settings as they might be reset.