File

mod_cloud_notify: Update Readme diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md --- a/mod_cloud_notify/README.md +++ b/mod_cloud_notify/README.md @@ -1,109 +1,106 @@ ---- -labels: -- 'Stage-Beta' -summary: 'XEP-0357: Cloud push notifications' ---- +# Introduction -Introduction -============ +This module enables support for sending "push notifications" to clients +that need it, typically those running on certain mobile devices. -This module enables support for sending "push notifications" to clients that -need it, typically those running on certain mobile devices. +As well as this module, your client must support push notifications (the +apps that need it generally do, of course) and the app developer's push +gateway must be reachable from your Prosody server (this happens over a +normal XMPP server-to-server 's2s' connection). -As well as this module, your client must support push notifications (the apps -that need it generally do, of course) and the app developer's push gateway -must be reachable from your Prosody server (this happens over a normal XMPP -server-to-server 's2s' connection). - -Details -======= +# Details Some platforms, notably Apple's iOS and many versions of Android, impose -limits that prevent applications from running or accessing the network in the -background. This makes it difficult or impossible for an XMPP application to -remain reliably connected to a server to receive messages. - -In order for messaging and other apps to receive notifications, the OS vendors -run proprietary servers that their OS maintains a permanent connection to in -the background. Then they provide APIs to application developers that allow -sending notifications to specific devices via those servers. +limits that prevent applications from running or accessing the network +in the background. This makes it difficult or impossible for an XMPP +application to remain reliably connected to a server to receive +messages. -When you connect to your server with an app that requires push notifications, -it will use this module to set up a "push registration". When you receive -a message but your device is not connected to the server, this module will -generate a notification and send it to the push gateway operated by your -application's developers). Their gateway will then connect to your device's -OS vendor and ask them to forward the notification to your device. When your -device receives the notification, it will display it or wake up the app so it -can connect to XMPP and receive any pending messages. +In order for messaging and other apps to receive notifications, the OS +vendors run proprietary servers that their OS maintains a permanent +connection to in the background. Then they provide APIs to application +developers that allow sending notifications to specific devices via +those servers. -This protocol is described for developers in [XEP-0357: Push Notifications]. +When you connect to your server with an app that requires push +notifications, it will use this module to set up a "push registration". +When you receive a message but your device is not connected to the +server, this module will generate a notification and send it to the push +gateway operated by your application's developers). Their gateway will +then connect to your device's OS vendor and ask them to forward the +notification to your device. When your device receives the notification, +it will display it or wake up the app so it can connect to XMPP and +receive any pending messages. -For this module to work reliably, you must have [mod_smacks], [mod_mam] and -[mod_carbons] also enabled on your server. +This protocol is described for developers in \[XEP-0357: Push +Notifications\]. + +For this module to work reliably, you must have \[mod_smacks\], +\[mod_mam\] and \[mod_carbons\] also enabled on your server. -Some clients, notably Siskin and Snikket iOS need some additional extensions -that are not currently defined in a standard XEP. To support these clients, -see [mod_cloud_notify_extensions]. +Some clients, notably Siskin and Snikket iOS need some additional +extensions that are not currently defined in a standard XEP. To support +these clients, see \[mod_cloud_notify_extensions\]. -Configuration -============= +# Configuration - Option Default Description - ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- - `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty - `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled - `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) - `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) - `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. - `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. + Option Default Description + -------------------------------------- ---------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty + `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled + `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) + `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) + `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. + `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. -(\*) There are privacy implications for enabling these options. +(\*) There are privacy implications for enabling these options.[^1] -Internal design notes -===================== +# Internal design notes -App servers are notified about offline messages, messages stored by [mod_mam] -or messages waiting in the smacks queue. -The business rules outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2]. +App servers are notified about offline messages, messages stored by +\[mod_mam\] or messages waiting in the smacks queue. The business rules +outlined +[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) +are all honored[^2]. -To cooperate with [mod_smacks] this module consumes some events: -`smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`. -These events allow this module to send out notifications for messages received -while the session is hibernated by [mod_smacks] or even when smacks -acknowledgements for messages are delayed by a certain amount of seconds -configurable with the [mod_smacks] setting `smacks_max_ack_delay`. +To cooperate with \[mod_smacks\] this module consumes some events: +`smacks-ack-delayed`, `smacks-hibernation-start` and +`smacks-hibernation-end`. These events allow this module to send out +notifications for messages received while the session is hibernated by +\[mod_smacks\] or even when smacks acknowledgements for messages are +delayed by a certain amount of seconds configurable with the +\[mod_smacks\] setting `smacks_max_ack_delay`. -The `smacks_max_ack_delay` setting allows to send out notifications to clients -which aren't already in smacks hibernation state (because the read timeout or -connection close didn't already happen) but also aren't responding to acknowledgement -request in a timely manner. This setting thus allows conversations to be smoother -under such circumstances. +The `smacks_max_ack_delay` setting allows to send out notifications to +clients which aren't already in smacks hibernation state (because the +read timeout or connection close didn't already happen) but also aren't +responding to acknowledgement request in a timely manner. This setting +thus allows conversations to be smoother under such circumstances. -The new event `cloud-notify-ping` can be used by any module to send out a cloud -notification to either all registered endpoints for the given user or only the endpoints -given in the event data. +The new event `cloud-notify-ping` can be used by any module to send out +a cloud notification to either all registered endpoints for the given +user or only the endpoints given in the event data. -The config setting `push_notification_important_body` can be used to specify an alternative -body text to send to the remote pubsub node if the stanza is encrypted or has a body. -This way the real contents of the message aren't revealed to the push appserver but it -can still see that the push is important. -This is used by Chatsecure on iOS to send out high priority pushes in those cases for example. +The config setting `push_notification_important_body` can be used to +specify an alternative body text to send to the remote pubsub node if +the stanza is encrypted or has a body. This way the real contents of the +message aren't revealed to the push appserver but it can still see that +the push is important. This is used by Chatsecure on iOS to send out +high priority pushes in those cases for example. -Compatibility -============= - -**Note:** This module should be used with Lua 5.2 and higher. Using it with -Lua 5.1 may cause push notifications to not be sent to some clients. +# Compatibility ------- ----------------------------------------------------------------------------- - trunk Works - 0.12 Works - 0.11 Works - 0.10 Works - 0.9 Support dropped, use last supported version [675726ab06d3](//hg.prosody.im/prosody-modules/raw-file/675726ab06d3/mod_cloud_notify/mod_cloud_notify.lua) ------- ----------------------------------------------------------------------------- +**Note:** This module should be used with Lua 5.2 and higher. Using it +with Lua 5.1 may cause push notifications to not be sent to some +clients. + ------- ----------------------------------------------------------------- + trunk Works as of 25-06-13 + 13 Works + 0.12 Works + ------- ----------------------------------------------------------------- -[^1]: The service which is expected to forward notifications to something like Google Cloud Messaging or Apple Notification Service -[^2]: [business_rules.markdown](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.markdown) +[^1]: The service which is expected to forward notifications to + something like Google Cloud Messaging or Apple Notification Service + +[^2]: [business_rules.md](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md)

{
  "ref": "refs/heads/dev",
  "before": "3f8b7a2f69c6c891d8ab07700f113103db73faa3",
  "after": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
  "compare_url": "https://codeberg.org/slidge/slidgram/compare/3f8b7a2f69c6c891d8ab07700f113103db73faa3...dd7c6923c788b38312fbc27cffba3b7007d0126e",
  "commits": [
    {
      "id": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
      "message": "build: update pre-commit hooks\n",
      "url": "https://codeberg.org/slidge/slidgram/commit/dd7c6923c788b38312fbc27cffba3b7007d0126e",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-16T13:33:08+01:00",
      "added": [],
      "removed": [],
      "modified": [
        ".pre-commit-config.yaml"
      ]
    },
    {
      "id": "790116333966f395cc268b032c7a6173486955f4",
      "message": "chore: update lockfile\n\nbecause we must",
      "url": "https://codeberg.org/slidge/slidgram/commit/790116333966f395cc268b032c7a6173486955f4",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-13T15:47:16+01:00",
      "added": [
        "uv.lock"
      ],
      "removed": [],
      "modified": []
    },
    {
      "id": "776de82113f8a860408f78c22e8539e73306ac87",
      "message": "ci: use woodpecker\n",
      "url": "https://codeberg.org/slidge/slidgram/commit/776de82113f8a860408f78c22e8539e73306ac87",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-11T15:57:59+01:00",
      "added": [
        ".woodpecker/container-ci.yaml",
        ".woodpecker/container.yaml",
        ".woodpecker/docs.yaml",
        ".woodpecker/package.yaml",
        ".woodpecker/test.yaml"
      ],
      "removed": [
        ".builds/ci.yml",
        ".builds/container.yml",
        ".copier-answers.yml"
      ],
      "modified": [
        ".gitignore",
        "Dockerfile",
        "README.md",
        "docs/Makefile",
        "docs/source/conf.py",
        "pyproject.toml"
      ]
    }
  ],
  "total_commits": 3,
  "head_commit": {
    "id": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
    "message": "build: update pre-commit hooks\n",
    "url": "https://codeberg.org/slidge/slidgram/commit/dd7c6923c788b38312fbc27cffba3b7007d0126e",
    "author": {
      "name": "nicoco",
      "email": "nicoco@nicoco.fr",
      "username": "nicoco"
    },
    "committer": {
      "name": "nicoco",
      "email": "nicoco@nicoco.fr",
      "username": "nicoco"
    },
    "verification": null,
    "timestamp": "2025-01-16T13:33:08+01:00",
    "added": [],
    "removed": [],
    "modified": [
      ".pre-commit-config.yaml"
    ]
  },
  "repository": {
    "id": 301703,
    "owner": {
      "id": 205842,
      "login": "slidge",
      "login_name": "",
      "source_id": 0,
      "full_name": "",
      "email": "",
      "avatar_url": "https://codeberg.org/avatars/aa0eeeb5fe173938bdc665be92bf605efa1e8f4a905bc3327e4d5c7eddf584e5",
      "html_url": "https://codeberg.org/slidge",
      "language": "",
      "is_admin": false,
      "last_login": "0001-01-01T00:00:00Z",
      "created": "2024-08-30T14:16:14Z",
      "restricted": false,
      "active": false,
      "prohibit_login": false,
      "location": "",
      "pronouns": "",
      "website": "https://slidge.im",
      "description": "",
      "visibility": "public",
      "followers_count": 3,
      "following_count": 0,
      "starred_repos_count": 0,
      "username": "slidge"
    },
    "name": "slidgram",
    "full_name": "slidge/slidgram",
    "description": "A feature-rich Telegram to XMPP gateway",
    "empty": false,
    "private": false,
    "fork": false,
    "template": false,
    "parent": null,
    "mirror": false,
    "size": 1561,
    "language": "",
    "languages_url": "https://codeberg.org/api/v1/repos/slidge/slidgram/languages",
    "html_url": "https://codeberg.org/slidge/slidgram",
    "url": "https://codeberg.org/api/v1/repos/slidge/slidgram",
    "link": "",
    "ssh_url": "git@codeberg.org:slidge/slidgram.git",
    "clone_url": "https://codeberg.org/slidge/slidgram.git",
    "original_url": "",
    "website": "",
    "stars_count": 0,
    "forks_count": 1,
    "watchers_count": 3,
    "open_issues_count": 7,
    "open_pr_counter": 0,
    "release_counter": 0,
    "default_branch": "main",
    "archived": false,
    "created_at": "2025-01-10T09:19:40Z",
    "updated_at": "2025-01-16T12:15:22Z",
    "archived_at": "1970-01-01T00:00:00Z",
    "permissions": {
      "admin": true,
      "push": true,
      "pull": true
    },
    "has_issues": true,
    "internal_tracker": {
      "enable_time_tracker": true,
      "allow_only_contributors_to_track_time": true,
      "enable_issue_dependencies": true
    },
    "has_wiki": false,
    "wiki_branch": "main",
    "globally_editable_wiki": false,
    "has_pull_requests": true,
    "has_projects": false,
    "has_releases": true,
    "has_packages": true,
    "has_actions": false,
    "ignore_whitespace_conflicts": false,
    "allow_merge_commits": true,
    "allow_rebase": true,
    "allow_rebase_explicit": true,
    "allow_squash_merge": true,
    "allow_fast_forward_only_merge": true,
    "allow_rebase_update": true,
    "default_delete_branch_after_merge": false,
    "default_merge_style": "merge",
    "default_allow_maintainer_edit": false,
    "avatar_url": "",
    "internal": false,
    "mirror_interval": "",
    "object_format_name": "sha1",
    "mirror_updated": "0001-01-01T00:00:00Z",
    "repo_transfer": null,
    "topics": [
      "bridge",
      "chat",
      "gateway",
      "instant-messaging",
      "slidge",
      "telegram",
      "telegram-userbot",
      "xmpp"
    ]
  },
  "pusher": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 1,
    "following_count": 0,
    "starred_repos_count": 3,
    "username": "nicoco"
  },
  "sender": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 1,
    "following_count": 0,
    "starred_repos_count": 3,
    "username": "nicoco"
  }
}