Skip to content

Commit 9c07563

Browse files
marc1706marc1706
committed
Update user guide to remove jabber and include webpush
1 parent 2f93794 commit 9c07563

File tree

3 files changed

+29
-27
lines changed

3 files changed

+29
-27
lines changed

‎documentation/content/en/chapters/admin_guide.xml

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -330,30 +330,37 @@
330330
</itemizedlist>
331331
</section>
332332

333-
<section id="acp_client_jabber">
333+
<section id="acp_client_webpush">
334334
<sectioninfo>
335335
<authorgroup>
336336
<author>
337-
<othername>MennoniteHobbit</othername>
337+
<othername>Marc</othername>
338338
</author>
339339
</authorgroup>
340340
</sectioninfo>
341-
<title>Jabber settings</title>
342-
343-
<para>phpBB3 also has the ability to communicate messages to users via <glossterm>Jabber</glossterm>, your board can be configured to board notifications via Jabber. Here, you can enable and control exactly how your board will use Jabber for communication.</para>
341+
<title>Web Push settings</title>
344342

345-
<note>
346-
<para>Some Jabber servers include gateways or transports which allow you to contact users on other networks. Not all servers offer all transports and changes in protocols can prevent transports from operating. Note that it may take several seconds to update Jabber account details, so do not stop the script until it has finished!</para>
347-
</note>
343+
<para>phpBB also has the ability to send notifications to users via <glossterm>Web Push</glossterm>. Your board can be configured to board notifications via Web Push.</para>
348344

349345
<itemizedlist>
350-
<title>Jabber settings</title>
351-
<listitem><para><guilabel>Enable Jabber</guilabel>: Set this to <guilabel>Enabled</guilabel> if you want to enable the use of Jabber for messaging and notifications.</para></listitem>
352-
<listitem><para><guilabel>Jabber server</guilabel>: The Jabber server that your board will use. For a list of public servers, see <ulink url="http://www.jabber.org">jabber.org</ulink>'s <ulink url="http://www.jabber.org/user/publicservers.shtml">list of open, public servers</ulink>.</para></listitem>
353-
<listitem><para><guilabel>Jabber port</guilabel>: The port that the Jabber server specified above is located on. Port 5222 is the most common port; if you are unsure about this, leave this value alone.</para></listitem>
354-
<listitem><para><guilabel>Jabber username or JID</guilabel>: The Jabber username or a complete Jabber ID (looks like an e-mail address) that your board will use when connecting to the specified Jabber server. You must specify an already registered account.</para></listitem>
355-
<listitem><para><guilabel>Jabber password</guilabel>: The password for the Jabber username specified above. If the Jabber username is unregistered, phpBB3 will attempt to register the above Jabber username, with this specified value as the password.</para><important><para>This password will be stored as plain text in the database, visible to everybody who can access your database or who can view this configuration page.</para></important></listitem>
356-
<listitem><para><guilabel>Jabber package size</guilabel>: This is the number of messages that can be sent in one package. If this is set to &quot;0&quot;, messages will be sent immediately and is will not be queued for later sending.</para></listitem>
346+
<title>Web Push settings</title>
347+
<listitem>
348+
<para><guilabel>Enable Web Push</guilabel>: Set this to <guilabel>Yes</guilabel> if you want to enable the use of Web Push for notifications.</para>
349+
</listitem>
350+
<listitem>
351+
<para><guilabel>Server identification public key</guilabel>: The Voluntary Application Server Identification (VAPID) public key is shared to authenticate push messages from your site. You can set this manually or generate the key by clicking on the <guilabel>Generate Identification keys</guilabel> button.</para>
352+
<important><para><emphasis>Caution:</emphasis> Modifying the VAPID public key will automatically render all Web Push subscriptions invalid.</para></important>
353+
</listitem>
354+
<listitem>
355+
<para><guilabel>Server identification private key</guilabel>: The Voluntary Application Server Identification (VAPID) private key is used to generate authenticated push messages dispatched from your site. The VAPID private key must form a valid public-private key pair alongside the VAPID public key. You can set this manually or generate the key by clicking on the <guilabel>Generate Identification keys</guilabel> button.</para>
356+
<important><para><emphasis>Caution:</emphasis> Modifying the VAPID private key will automatically render all Web Push subscriptions invalid.</para></important>
357+
</listitem>
358+
<listitem>
359+
<para><guilabel>Enable all user-based web push notification options by default</guilabel>: When this setting is enabled, users who subscribe and allow browser notifications will start receiving them automatically. Users only need to visit the UCP Notification settings to disable any unwanted notifications. If this setting is disabled, users will not receive any notifications, even if they have subscribed, until they visit the UCP Notification settings to enable the specific notification options they wish to receive.</para>
360+
</listitem>
361+
<listitem>
362+
<para><guilabel>Show “Subscribe” button in notification dropdown</guilabel>: Display a “Subscribe” button in the Notification dropdown, allowing users to easily subscribe to push notifications from anywhere in the forum.</para>
363+
</listitem>
357364
</itemizedlist>
358365
</section>
359366
</section>

‎documentation/content/en/chapters/glossary.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -180,13 +180,6 @@
180180
</listitem>
181181
</varlistentry>
182182

183-
<varlistentry>
184-
<term>Jabber</term>
185-
<listitem>
186-
<para>Jabber is the former name of Extensible Messaging and Presence Protocol (XMPP) an open-source protocol that can be used for instant messenging. For more information on XMPP's role in phpBB, see <xref linkend="acp_client_jabber" />.</para>
187-
</listitem>
188-
</varlistentry>
189-
190183
<varlistentry>
191184
<term>Listener</term>
192185
<listitem>
@@ -330,6 +323,13 @@
330323
<para>Usergroups are a way of grouping users. This makes it easier to set permissions to many people at the same time (e.g. create a moderator group and give it moderating permissions to a certain forum instead of giving lots of individual people moderating permissions separately). A usergroup has a usergroup moderator (a leader, essentially), who has the ability to add or delete users from the group. Usergroups can be set to hidden, closed or open. If a usergroup is open, users can try requesting membership via the proper page within the <link linkend="user_control_panel">group control panel</link>. phpBB 3.3 has six pre-defined usergroups.</para>
331324
</listitem>
332325
</varlistentry>
326+
327+
<varlistentry>
328+
<term>Web Push</term>
329+
<listitem>
330+
<para>Web Push notifications are messages sent by a website to a user's browser, even when the user is not actively browsing the site. They deliver notifications to all subscribed devices in real-time. For more information on Web Push notifications in phpBB, see <xref linkend="acp_client_webpush" />.</para>
331+
</listitem>
332+
</varlistentry>
333333
</variablelist>
334334
</section>
335335
</chapter>

‎documentation/content/en/chapters/user_guide.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,6 @@
146146
<title>Personal settings</title>
147147
<para>Personal settings control the information that is displayed when a user views your profile. </para>
148148
<itemizedlist>
149-
<listitem><para><guilabel>ICQ Number</guilabel>: Your account number associated with <ulink url="http://www.icq.com/">ICQ</ulink> system.</para></listitem>
150-
<listitem><para><guilabel>AOL Instant Messenger</guilabel>: Your screen name associated with <ulink url="http://aim.com">AOL Instant Messenger</ulink> system.</para></listitem>
151-
<listitem><para><guilabel>Windows Live Messenger</guilabel>: Your email address associated with the <ulink url="http://home.live.com/">Windows Live</ulink> service.</para></listitem>
152-
<listitem><para><guilabel>Yahoo Messenger</guilabel>: Your username associated with the <ulink url="http://messenger.yahoo.com/">Yahoo Messenger</ulink> service.</para></listitem>
153-
<listitem><para><guilabel>Jabber Address</guilabel>: Your username associated with the <ulink url="http://www.jabber.org/">Jabber</ulink> service.</para></listitem>
154149
<listitem><para><guilabel>Facebook</guilabel>: Your unique username/page name associated with the <ulink url="https://www.facebook.com/">Facebook</ulink> service.</para></listitem>
155150
<listitem><para><guilabel>Twitter</guilabel>: Your username associated with the <ulink url="https://twitter.com/">Twitter</ulink> service.</para></listitem>
156151
<listitem><para><guilabel>Skype</guilabel>: Your username associated with the <ulink url="http://www.skype.com/">Skype</ulink> service.</para></listitem>

0 commit comments

Comments
 (0)