overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10672 Commits
12 Branches
657 MiB
 
 
Tree: bab0f8639c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bab0f8639c'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-ntfy.pot

274 lines
15 KiB
Raw Blame History 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members

  3. # This file is distributed under the same license as the matrix-docker-ansible-deploy package.

  4. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

  9. "Project-Id-Version: matrix-docker-ansible-deploy \n"

  10. "Report-Msgid-Bugs-To: \n"

  11. "POT-Creation-Date: 2025-11-06 23:09+0900\n"

  12. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

  13. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

  14. "Language-Team: LANGUAGE <LL@li.org>\n"

  15. "MIME-Version: 1.0\n"

  16. "Content-Type: text/plain; charset=UTF-8\n"

  17. "Content-Transfer-Encoding: 8bit\n"

  18. 

  19. #: ../../../docs/configuring-playbook-ntfy.md:12

  20. msgid "Setting up the ntfy push notifications server (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-ntfy.md:14

  24. msgid "The playbook can install and configure the [ntfy](https://ntfy.sh/) (pronounced \"notify\") push notifications server for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-ntfy.md:16

  28. msgid "ntfy lets you send push notifications to your phone or desktop via scripts from any computer, using simple HTTP PUT or POST requests. It makes it possible to send/receive notifications, without relying on servers owned and controlled by third parties."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-ntfy.md:18

  32. msgid "With the [UnifiedPush](https://unifiedpush.org) standard, ntfy also enables self-hosted push notifications from Matrix (and other) servers to UnifiedPush-compatible Matrix client apps running on Android devices."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-ntfy.md:20

  36. msgid "See the project's [documentation](https://docs.ntfy.sh/) to learn what ntfy does and why it might be useful to you."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-ntfy.md:22

  40. msgid "The [Ansible role for ntfy](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring ntfy, you can check them via:"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-ntfy.md:23

  44. msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md) online"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-ntfy.md:24

  48. msgid "📁 `roles/galaxy/ntfy/docs/configuring-ntfy.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-ntfy.md:26

  52. msgid "**Note**: this playbook focuses on setting up a ntfy server for getting it send push notifications with UnifiedPush to Matrix-related services that this playbook installs, while the installed server will be available for other non-Matrix apps like [Tusky](https://tusky.app/) and [DAVx⁵](https://www.davx5.com/) as well. This playbook does not intend to support all of ntfy's features. If you want to use them as well, refer the role's documentation for details to configure them by yourself."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-ntfy.md:28

  56. msgid "Improve push notification's privacy with ntfy"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-ntfy.md:30

  60. msgid "By default, push notifications received on Matrix apps on Android/iOS act merely as \"wake-up calls\" for the application, which contain only event IDs, and do not transmit actual message payload such as text message data."

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-ntfy.md:32

  64. msgid "While your messages remain private even without ntfy, it makes it possible to improve privacy and sovereignty of your Matrix installation, offering greater control over your data, by avoiding routing these \"application wake-up calls\" through Google or Apple servers and having them pass through the self-hosted ntfy instance on your Matrix server."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-ntfy.md:34

  68. msgid "How ntfy works with UnifiedPush"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-ntfy.md:36

  72. msgid "⚠️ [UnifiedPush does not work on iOS.](https://unifiedpush.org/users/faq/#will-unifiedpush-ever-work-on-ios)"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-ntfy.md:38

  76. msgid "ntfy implements UnifiedPush, the standard which makes it possible to send and receive push notifications without using Google's Firebase Cloud Messaging (FCM) service."

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-ntfy.md:40

  80. msgid "Working as a **Push Server**, a ntfy server can forward messages via [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/) as a **Distributor** to a UnifiedPush-compatible Matrix client such as Element Android and FluffyChat Android (see [here](https://unifiedpush.org/users/distributors/#definitions) for the definition of the Push Server and the Distributor)."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-ntfy.md:42

  84. msgid "Note that UnifiedPush-compatible applications must be able to communicate with the ntfy Android app which works as the Distributor on the same device, in order to receive push notifications from the Push Server."

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-ntfy.md:44

  88. msgid "As the ntfy Android app functions as the Distributor, you do not have to install something else on your device, besides a UnifiedPush-compatible Matrix client."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-ntfy.md:46

  92. msgid "Adjusting DNS records"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-ntfy.md:48

  96. msgid "By default, this playbook installs ntfy on the `ntfy.` subdomain (`ntfy.example.com`) and requires you to create a CNAME record for `ntfy`, which targets `matrix.example.com`."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-ntfy.md:50

  100. msgid "When setting, replace `example.com` with your own."

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-ntfy.md:52

  104. msgid "Adjusting the playbook configuration"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-ntfy.md:54

  108. msgid "To enable a ntfy server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-ntfy.md:72

  112. msgid "As the most of the necessary settings for the role have been taken care of by the playbook, you can enable the ntfy server on your Matrix server with this minimum configuration."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-ntfy.md:74

  116. msgid "See the role's documentation for details about configuring ntfy per your preference (such as [setting access control with authentication](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#enable-access-control-with-authentication-optional))."

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-ntfy.md:76

  120. msgid "Adjusting the ntfy URL (optional)"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-ntfy.md:78

  124. msgid "By tweaking the `ntfy_hostname` variable, you can easily make the service available at a **different hostname** than the default one."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-ntfy.md:80

  128. msgid "Example additional configuration for your `vars.yml` file:"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-ntfy.md:87

  132. msgid "After changing the domain, **you may need to adjust your DNS** records to point the ntfy domain to the Matrix server."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-ntfy.md:89

  136. msgid "Enable web app (optional)"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-ntfy.md:91

  140. msgid "The ntfy server can be accessed via its web app where you can subscribe to and push to \"topics\" from the browser. The web app may be helpful to troubleshoot notification issues or to use ntfy for other purposes than getting ntfy send UnifiedPush notifications to your Matrix-related services."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-ntfy.md:93

  144. msgid "**Note**: subscribing to a topic is not necessary for using the nfty server as the Push Server for UnifiedPush."

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-ntfy.md:95

  148. msgid "To enable the web app, add the following configuration to your `vars.yml` file:"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-ntfy.md:101

  152. msgid "See [the official documentation](https://docs.ntfy.sh/subscribe/web/) for details about how to use it."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-ntfy.md:103

  156. msgid "Installing"

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-ntfy.md:105

  160. msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-ntfy.md:112

  164. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-ntfy.md:114

  168. msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-ntfy.md:116

  172. msgid "Usage"

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-ntfy.md:118

  176. msgid "To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distributor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notifications are \"distributed\" from it."

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-ntfy.md:120

  180. msgid "For details about installing and configuring the ntfy Android app, take a look at [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#install-the-ntfy-androidios-app) on the role's documentation."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-ntfy.md:122

  184. msgid "⚠️ Though the ntfy app is available for iOS ([App Store](https://apps.apple.com/us/app/ntfy/id1625396347); the app's source code can be retrieved from [here](https://github.com/binwiederhier/ntfy-ios)), **any Matrix clients for iOS currently do not support ntfy** due to [technical limitations of the iOS platform](https://github.com/binwiederhier/ntfy-ios/blob/main/docs/TECHNICAL_LIMITATIONS.md). If you develop your own Matrix client app for iOS, you may need to use the [Sygnal](configuring-playbook-sygnal.md) push gateway service to deliver push notifications to it."

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-ntfy.md:124

  188. msgid "Setting up a UnifiedPush-compatible Matrix client"

  189. msgstr ""

  190. 

  191. #: ../../../docs/configuring-playbook-ntfy.md:126

  192. msgid "Having configured the ntfy Android app, you can configure a UnifiedPush-compatible Matrix client on the same device."

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-ntfy.md:128

  196. msgid "Steps needed for specific Matrix clients:"

  197. msgstr ""

  198. 

  199. #: ../../../docs/configuring-playbook-ntfy.md:130

  200. msgid "FluffyChat-Android: this should auto-detect and use the app. No manual settings required."

  201. msgstr ""

  202. 

  203. #: ../../../docs/configuring-playbook-ntfy.md:132

  204. msgid "SchildiChat-Android:"

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-ntfy.md:133

  208. msgid "enable `Settings` -> `Notifications` -> `UnifiedPush: Force custom push gateway`."

  209. msgstr ""

  210. 

  211. #: ../../../docs/configuring-playbook-ntfy.md:134

  212. msgid "choose `Settings` -> `Notifications` -> `UnifiedPush: Re-register push distributor`. *(For info, a more complex alternative to achieve the same is: delete the relevant unifiedpush registration in the ntfy Android app, force-close SchildiChat, re-open it.)*"

  213. msgstr ""

  214. 

  215. #: ../../../docs/configuring-playbook-ntfy.md:135

  216. msgid "verify `Settings` -> `Notifications` -> `UnifiedPush: Notification targets` as described below in the \"Troubleshooting\" section."

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-ntfy.md:137

  220. msgid "Element-Android v1.4.26+:"

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-ntfy.md:138

  224. msgid "choose `Settings` -> `Notifications` -> `Notification method` -> `ntfy`"

  225. msgstr ""

  226. 

  227. #: ../../../docs/configuring-playbook-ntfy.md:139

  228. msgid "verify `Settings` -> `Troubleshoot` -> `Troubleshoot notification settings`"

  229. msgstr ""

  230. 

  231. #: ../../../docs/configuring-playbook-ntfy.md:141

  232. msgid "If the Matrix client asks, \"Choose a distributor: FCM Fallback or ntfy\", then choose \"ntfy\"."

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-ntfy.md:143

  236. msgid "If the Matrix client doesn't seem to pick it up, try restarting it and try the Troubleshooting section below."

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-ntfy.md:145

  240. msgid "Troubleshooting"

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-ntfy.md:147

  244. msgid "The simple [UnifiedPush troubleshooting](https://unifiedpush.org/users/troubleshooting/) app [UP-Example](https://f-droid.org/en/packages/org.unifiedpush.example/) can be used to manually test UnifiedPush registration and operation on an Android device."

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-ntfy.md:149

  248. msgid "Check the Matrix client"

  249. msgstr ""

  250. 

  251. #: ../../../docs/configuring-playbook-ntfy.md:151

  252. msgid "Make sure that the Matrix client you are using supports UnifiedPush. There may well be different variants of the app."

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-ntfy.md:153

  256. msgid "To check if UnifiedPush is correctly configured on the client device, look at \"Settings -> Notifications -> Notification Targets\" in Element Android or SchildiChat Android, or \"Settings -> Notifications -> Devices\" in FluffyChat. There should be one entry for each Matrix client that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL."

  257. msgstr ""

  258. 

  259. #: ../../../docs/configuring-playbook-ntfy.md:155

  260. msgid "In the \"Notification Targets\" screen in Element Android or SchildiChat Android, two relevant URLs are shown, \"push\\_key\" and \"Url\", and both should begin with your ntfy server's URL. If \"push\\_key\" shows your server but \"Url\" shows an external server such as `up.schildi.chat` then push notifications will still work but are being routed through that external server before they reach your ntfy server. To rectify that, in SchildiChat (at least around version 1.4.20.sc55) you must enable the `Force custom push gateway` setting as described in the \"Usage\" section above."

  261. msgstr ""

  262. 

  263. #: ../../../docs/configuring-playbook-ntfy.md:157

  264. msgid "If it is not working, useful tools are \"Settings -> Notifications -> Re-register push distributor\" and \"Settings -> Notifications -> Troubleshoot Notifications\" in SchildiChat Android (possibly also Element Android). In particular the \"Endpoint/FCM\" step of that troubleshooter should display your ntfy server's URL that it has discovered from the ntfy client app."

  265. msgstr ""

  266. 

  267. #: ../../../docs/configuring-playbook-ntfy.md:159

  268. msgid "Check the service's logs"

  269. msgstr ""

  270. 

  271. #: ../../../docs/configuring-playbook-ntfy.md:161

  272. msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#check-the-services-logs) on the role's documentation for details."

  273. msgstr ""