|
10 | 10 | </chapterinfo> |
11 | 11 | <title>Administration Guide</title> |
12 | 12 | <abstract> |
13 | | - <para>This chapter describes the phpBB 3.3 admin controls.</para> |
| 13 | + <para>This chapter describes the phpBB admin controls.</para> |
14 | 14 | </abstract> |
15 | 15 | <section id="admin_control_panel"> |
16 | 16 | <sectioninfo> |
|
21 | 21 | </authorgroup> |
22 | 22 | </sectioninfo> |
23 | 23 | <title>The Administration Control Panel</title> |
24 | | - <para>Even more so than its predecessor, phpBB 3.3 "Proteus" is highly configurable. You can tune, adjust, or turn off almost all features. To make this load of settings as accessible as possible, we redesigned the Administration Control Panel (ACP) completely. </para> |
| 24 | + <para>Even more so than its predecessor, phpBB is highly configurable. You can tune, adjust, or turn off almost all features. To make this load of settings as accessible as possible, we redesigned the Administration Control Panel (ACP) completely. </para> |
25 | 25 | <para>Click on the <guilabel>Administration Control Panel</guilabel> link on the bottom of the default forum style to visit the <acronym>ACP</acronym>.</para> |
26 | 26 | <para>The <acronym>ACP</acronym> has seven different sections by default with each containing a number of subsections. We will discuss each section in this Admin Guide. </para> |
27 | 27 |
|
|
146 | 146 | <title>Private Messaging</title> |
147 | 147 | <para><glossterm>Private Messages</glossterm> are a way for registered members to communicate privately through your board without the need to fall back to e-mail or instant messaging. </para> |
148 | 148 | <para>You can disable this feature with the <guilabel>Private Messaging</guilabel> setting. This will keep the feature turned off for the whole board. You can disable private messages for selected users or groups with <link linkend="acp_permissions">Permissions</link>. Please see the <link linkend="acp_permissions">Permissions section</link> for more information. </para> |
149 | | - <para>Proteus allows users to create own personal folders to organise Private Messages. The <guilabel>Maximum private message folders</guilabel> setting defines the number of message folders they can create. The default value is 4. You can disable the feature with setting value to 0. </para> |
| 149 | + <para>phpBB allows users to create own personal folders to organise Private Messages. The <guilabel>Maximum private message folders</guilabel> setting defines the number of message folders they can create. The default value is 4. You can disable the feature with setting value to 0. </para> |
150 | 150 | <para><guilabel>Max Private Messages Per Box</guilabel> sets the number of Private Messages each folder can contain. The default value is <guilabel>50</guilabel>, Set it to 0 to allow unlimited messages per folder. </para> |
151 | 151 | <para>If you limit the number of messages users can store in their folders, you need to define a default action that is taken once a folder is full. This can be changed in the "Full Folder Default Action" list. The oldest message gets deleted or the new message will be held back until the folder has place for it. Note that users will be able to choose this for themselves in their PM options and this setting only changes the default value they face. This will not override the action a user chosen. </para> |
152 | 152 | <para>When sending a private message, it is still possible to edit the message until the recipient reads it. After a sent private message has been read, editing the message is no longer possible. To limit the time a message can be edited before the recipient reads it, you can set the <guilabel>Limit Editing Time</guilabel>. The default value is 0, which allows editing until the message is read. Note that you can disallow users or groups to edit Private Messages after sending through <link linkend="acp_permissions">Permissions</link>. If the permission to edit messages is denied, it will override this setting. </para> |
|
330 | 330 | </itemizedlist> |
331 | 331 | </section> |
332 | 332 |
|
333 | | - <section id="acp_client_jabber"> |
| 333 | + <section id="acp_client_webpush"> |
334 | 334 | <sectioninfo> |
335 | 335 | <authorgroup> |
336 | 336 | <author> |
337 | | - <othername>MennoniteHobbit</othername> |
| 337 | + <othername>Marc</othername> |
338 | 338 | </author> |
339 | 339 | </authorgroup> |
340 | 340 | </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> |
344 | 342 |
|
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> |
348 | 344 |
|
349 | 345 | <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 "0", 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> |
357 | 364 | </itemizedlist> |
358 | 365 | </section> |
359 | 366 | </section> |
|
739 | 746 | </authorgroup> |
740 | 747 | </sectioninfo> |
741 | 748 | <title>Subforums</title> |
742 | | - <para>One of the features in phpBB 3.3 is <glossterm>subforums</glossterm>. Especially bulletin boards with a high number of forums will benefit from this. In the simple flat category and forum approach in phpBB 2.0, all forums and categories were listed on the forum index. In Proteus you can now put as many forums, links, or categories as you like inside other forums.</para> |
743 | | - <!-- (TODO: Diagram of a 2.0 / 3.0 comparison) --> |
| 749 | + <para>One of the features in phpBB is <glossterm>subforums</glossterm>. Especially bulletin boards with a high number of forums will benefit from this. In the simple flat category and forum approach in phpBB 2.0, all forums and categories were listed on the forum index. In phpBB you can now put as many forums, links, or categories as you like inside other forums.</para> |
744 | 750 | <para>If you have a forum about pets for instance, you are able to put subforums for cats, dogs, or guinea pigs inside it without making the parent "Pets" forum a category. In this example, only the "Pets" forum will be listed on the index like a normal forum. Its subforums will appear as simple links below the forum description (unless you disabled this).</para> |
745 | 751 |
|
746 | 752 | <figure id="img_acp_subforums_list"> |
|
1899 | 1905 | </authorgroup> |
1900 | 1906 | </sectioninfo> |
1901 | 1907 | <title>Permissions</title> |
1902 | | - <para>On your board, you will need to control what users can and cannot do, and what they can and cannot see. With the flexible and detailed system that Proteus provides, you have an extensive ability to manage permissions. There are five types of permissions in phpBB3:</para> |
| 1908 | + <para>On your board, you will need to control what users can and cannot do, and what they can and cannot see. With the flexible and detailed system that phpBB provides, you have an extensive ability to manage permissions. There are five types of permissions in phpBB:</para> |
1903 | 1909 | <itemizedlist> |
1904 | 1910 | <listitem><para>Global User permissions</para></listitem> |
1905 | 1911 | <listitem><para>Global Moderator permissions</para></listitem> |
|
0 commit comments