Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalyster/mod_smacks_notifications
APNS/GCM module for Prosody XMPP server
https://github.com/vitalyster/mod_smacks_notifications
Last synced: 21 days ago
JSON representation
APNS/GCM module for Prosody XMPP server
- Host: GitHub
- URL: https://github.com/vitalyster/mod_smacks_notifications
- Owner: vitalyster
- Created: 2014-08-22T08:18:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-09-17T09:53:39.000Z (about 9 years ago)
- Last Synced: 2023-03-16T15:10:23.491Z (over 1 year ago)
- Language: Lua
- Homepage:
- Size: 164 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
mod_smacks_notifications
========================
Apple Push Notifications and Google Cloud Messaging module for Prosody
Requirements and installation
-----------------------------
1. [LuaPack](http://lua-users.org/wiki/LuaPack) module for Lua
2. [Prosody](http://prosody.im)
3. [mod_smacks](https://code.google.com/p/prosody-modules/wiki/mod_smacks)
4. `smacks_hibernation_time` should be set much higher than default value, e.g. `86400` (session will stay 24 hours)
5. patch for mod_smacks:
```lua
--- mod_smacks.lua.orig 2015-05-19 10:50:08 +0300
+++ mod_smacks.lua 2015-05-19 10:58:00 +0300
@@ -83,6 +83,9 @@
queue[#queue+1] = cached_stanza;
session.log("debug", "#queue = %d", #queue);
if session.hibernating then
+ if stanza.name == "message" and stanza:get_child("body") ~= nil then
+ module:fire_event("smacks-message", {origin = session, stanza = stanza});
+ end
session.log("debug", "hibernating, stanza queued");
return ""; -- Hack to make session.send() not return nil
end
```
Configuration parameters
------------------------
`gcm_api_key` - Google Cloud Messaging key for your Android application (you should generate it in Google API Console)
`apn_key_file` and `apn_certificate` - APNS key and certificate for your iOS application
Usage
-----
### Determining server support
When server have `mod_smacks_notifications` enabled it will advertise
`http://sawim.ru/notifications#gcm` and `http://sawim.ru/notifications#apn` features:
```xml
C:
C:
C:
S:
S: [...]
S:
S:
S: [...]
S:
```
Of course, server and client should also supports [Stream Management](http://xmpp.org/extensions/xep-0198.html) protocol and it *must* be enabled in the client session before it can enable push notifications
### Registering device for receiving notifications
Android client must send `deviceid` received when he register Cloud Messaging session
```xml
C:
C:
C:
```
And iOS client must send similar device token received when he registered APNS notifications
```xml
C:
C:
C:
```
### Preferences
User may want to filter events to receive.
At now you can select `groupchat`, `roster` or `off`:
```xml
C:
C:
C:
C:
C:
```
In this case user will receive only roster messages.
You can also temporarily disable notifications with `prefs="off"`
or completely unregister device
```xml
C:
C:
C:
```
In all cases you must receive `result` or `error` from server in reply to each query:
```xml
S:
```