SMF2.1:Permissions From Online Manual

Revision as of 11:28, 17 August 2023 by Brynn (talk | contribs) (updating Permissions page to 2.1 - new Post Mod, Settings, About Perm sections (rest of page) copied from temp page)
Jump to: navigation, search
Under construction-48.png Work in progress, expect frequent changes. Under construction-48.png

Please see SMF1.1:Permissions, SMF2.0:Permissions or SMF2.1:Permissions depending on the version of SMF you are using.

Introduction

Permissions are a very powerful tool for managing your forum. It is advisable to only change one permission at a time and to test it prior to changing another one. The reason is because the permissions can often interact with each other in unexpected ways, resulting in untested changes having unintended consequences. If you need help beyond the information provided on this page, please feel free to investigate other support options, which are found on this page: https://support.simplemachines.org/.

There are 2 separate sets of permissions. While these permission sets do not overlap, they certainly can interact, depending on how they are used. All permissions are given to people, or website visitors, and managed using membergroups. But these two sets are allocated and utilized differently.

  • The General Permissions are applied to membergroups. So for example, you can give those people who belong to certain groups the ability to do things which those in other groups can't. Permissions can be applied to custom membergroups just the same as the original membergroups.
  • The Board Permissions are also applied to membergroups. But these permissions are managed using profiles, one of which is assigned to each board. So for example, you can allow people or membergroups to have certain pemissions on one board, but not on another. There are four profiles and you can create custom profiles as well.


In the Admin Center > Members > Permissions sub-menu, there are 5 tabs: General Permissions, Board Permissions, Edit Profiles, Post Moderation, and Settings.

General Permissions

As mentioned above, General Permissions apply to people in membergroups, whether they are the original membergroups or custom groups.

This page shows a table which lists of all membergroups, along with a few statistics. If you have not yet added any custom membergroups, you will see 5 membergroups: Guests, Regular Members, Administrators, Global Moderators, and Moderators. Use the question mark icon on the left to find a definition for each group.

On the right side of the table, beside each membergroup, is a checkbox and a Modify text link. The Modify link allows the administrator to change specific permissions individually. The checkbox allows the administrator to apply the advanced options, which is a way to edit the entire membergroup at once.

Modify

Use the Modify text link to the right of each membergroup name to individually set one or more permissions for the members of this group. The top half of the page offers settings for the General Permissions which are explained in detail below. Please see the page, Moderator for more information on how the Moderator membergroup works. These will help you understand and decide how to set permissions. (The bottom half of the page shows the Board Permissions, which are explained even further below. They are included here with General Permissions for convenience. But they also appear on Board Permissions page.)

Advanced Options

These options allow you to make changes to the whole membergroup at once, using pre-defined permission sets. These are simply sets of permissions which provide generalized types of abilities. To use them, first select one or more membergroups from the table above, by checking the box on the same line with the membergroup name. Then make your choices in the With selection box below the table.

  • Apply pre-defined permission set - Choose one of the four options from the dropdown menu: Restrictive, Standard, Moderator, or Maintenance. The question mark button to the left of each option explains the generalized types of permissions which each option provides.
  • Set permissions like this group - Choose which group has the permissions closest to what you want for this membergroup.
  • (Select a permission) dropdown menu offers all the available permissions which you might want to customize. Make your choice or choices.
  • Add permission dropdown menu offers add permission and clear permission. If you have configured the Deny Permissions option on Members > Permissions > Settings, you will also have the Deny permission option to choose from. Thus you can decide whether you want your chosen membergroup to have each permission, not have it, or have it denied. (See further below more information about Deny Permissions.)

When you have completed your selections, click the Set permissions button to finalize each membergroup's permissions.

List of General Permissions

General

  • View forum statistics - Determines whether this group can view the collected statistics of an SMF forum that can be found using the More Stats button, in the Info Center
  • View the memberlist - Determines whether this group can view the list of all registered members of an SMF forum.
  • View Who's Online - Determines whether this group can view Who's Online section in the Info Center, assuming the option to display the section has been enabled.
  • Search for posts and topics - Determines whether this group can use the Search feature, assuming the feature has been enabled. (If it has not been enabled, no Search button will be seen.)

Calendar

  • View the calendar - Determines whether this group can view the calendar of an SMF forum. It can be found in the navigation bar.
  • Create events in the calendar - Determines whether this group can create new events in the calendar.
  • Edit events in the calendar - Determines whether this group can edit events in the calendar.

Note that the Calendar permissions will not appear if you have not enabled the Calendar feature for your forum.

Forum Administration

  • Administrate forum and database - Determines whether this group can change database connection properties, edit server settings, and perform other administrative functions.
  • Manage boards and categories - Determines whether this group can create, modify, and/or delete boards and categories.
  • Manage attachments and avatars - Determines whether this group can manage and delete attachments on the forum.
  • Manage smileys and message icons - Determines whether this group can change smiley sets, delete smileys, and change smiley options. This includes message icons.
  • Edit news - Determines whether this group can edit the forum's news.
  • Access the moderation center - Determines whether this group can see the Moderation center.

Member Administration

  • Moderate forum members - Determines whether this group can perform moderation tasks, such as register users manually, track IP addresses, online status, etc.
  • Manage and assign membergroups - Determines whether this group can create, manage, or delete membergroups.
  • Manage permissions - Determines whether this group can manage member permissions.
  • Manage ban list - Determines whether this group can ban other members and/or discontinue bans.
  • Send a forum email to members - Determines whether this group can send an e-mail in bulk to all members or individual membergroups; this keeps the users from having to reveal their own e-mail addresses.
  • Issue warnings to members - Determines whether this group can send warnings to other members of the forum.

Personal Messaging

  • Read personal messages - Determines whether this group can view personal messages.
  • Send personal messages - Determines whether this group can send personal messages to other members.
  • Save drafts of personal messages - Determines whether this group can save drafts of personal messages, so they can finish or send them later.

Member Profiles

  • View other members' profile summary and stats pages - Determines whether this group can view profile summaries and member stats.
  • Allow Forum Profile edits - Determines whether this group can edit their profiles and/or other members' profiles.
  • Edit additional profile settings - Determines whether this group can edit other profile settings for avatars, theme preferences, notifications and Personal Messages; for themselves and/or others.
  • 'Edit signatures - Determines whether this group can edit the signature field in their profile and/or other members' profiles.
  • Edit website - Determines whether this group can edit the website field in their profile and/or other members' profiles.
  • Edit custom title - Determines whether this group can edit their custom title, in their profile and/or other members' profiles.
  • Edit personal text - Determines whether this group can edit their custom text, in their profile and/or other members' profiles.
  • Select an avatar from the server - Determines whether this group can select an avatar which is stored on the forum server.
  • Upload an avatar to the server - Determines whether this group can upload an avatar to the forum's server.
  • Choose a remotely stored avatar - Determines whether this group can choose an avatar from an external server. Because avatars might influence the page creation time negatively, it is possible to disallow certain membergroups to use avatars from external servers.
  • Report users' profiles - Determines whether this group can report other members' profiles. Allowing this helps prevent spam in the forum.

Member Accounts

  • Edit account settings - Determines whether this group can edit their own account's settings as well as the account settings of all members.
  • Edit displayed name - Determines whether this group can edit the displayed name field in their profile and/or other members' profiles.
  • Change password - Determines whether this group can change their password or secret question in their own profile, and/or in other members' profiles.
  • Delete account - Determines whether this group can delete their account or other members' accounts.
  • View warning status - Determines whether this group can view their own warning status and/or other members' warning status.

Mentions

  • Mention others via @name - Determines whether this group can mention other members by their @name.

Board Permissions

As mentioned above, Board Permissions are also applied to membergroups. But they are managed with profiles, one of which is applied to each board. With these profiles, an admin could allow users to have permissions on one board that the same users might not have on another board. Combine these Board Permissions with the General Permissions, and you can begin to see how complex this feature can be!

These are the four profiles which are written into the program, but admins can also create their own custom profiles.

  • Default - Initially this is a configuration which developers set up for general use, on all boards. It can be customized or even replaced with a different profile.
  • No Polls - In boards with this profile, users can neither create nor participate in polls. This profile cannot be directly edited or customized. But you can create a new profile based on this one, and customize it.
  • Reply Only - In boards with this profile, users cannot start new topics, but they can only reply to them. This profile cannot be directly edited or customized. But you can create a new profile based on this one, and customize it.
  • Read Only - In these boards, users can only read, but not participate in topics. This profile cannot be directly edited or customized. But you can create a new profile based on this one, and customize it.

Change a Board's Profile

On the Board Permissions page, you can see a table which lists all the boards in your forum, along with the profile assigned to each board. To switch to a different profile on a particular board, click on the name of the board. On the next page, find the Permission Profile option and choose another profile from the dropdown menu. Then at the bottom of the page, click Modify button. When you get back to Board Permissions page, you'll see the new profile listed for that board.

Before moving on to editing the board permission profiles, below is the list of all the individual Board Permissions. These will help you understand and decide how to configure new profiles.

List of Board Permissions

Topics

  • Post new topics, without requiring approval - Determines whether users in this membergroup can post new topics without moderator or administrator approval.
  • Post new topics, but hide until approved - Determines whether users in this membergroup can post new topics which are only visible to moderators with the necessary permissions or administrators, but not other users.
  • Post replies to topics, without requiring approval - Determines whether users in this membergroup can post replies to topics without moderator or administrator approval. This can be set for the users' own topic, any topic, or no topics.
  • Post replies to topics, but hide until approved - Determines whether users in this membergroup can post replies to topics which are only visible to moderators with the necessary permissions or administrators, but not other users. This can be set for the users' own topic, any topic, or no topics.
  • Save drafts of new posts - Determines whether users in this membergroup can save drafts of their new posts, so they can post or finish them later.
  • Merge any topic - Determines whether users in this membergroup can merge topics.
  • Split any topic - Determines whether users in this membergroup can split topics.
  • Make topics sticky - Determines whether users in this membergroup can make some topics sticky topics.
  • Move topic - Determines whether users in this membergroup can move their own topics, any topics, or no topics, to another board.
  • Lock topics - Determines whether users in this membergroup can lock their own topics, any topics, or no topics.
  • Remove topics - Determines whether users in this membergroup can remove topics.
  • Modify replies to own topics - Determines whether users in this membergroup can modify replies to their own topics.
  • Delete replies to own topics - Determines whether users in this membergroup can delete replies to their own topics.
  • Announce topic - Determines whether users in this membergroup can send a message by email, announcing the topic.

Posts

  • Delete posts - Determines whether users in this membergroup can delete their own posts, any posts, or no posts.
  • Modify posts - Determines whether users in this membergroup can modify their own posts, any posts, or no posts.
  • Report posts to the moderators - Determines whether users in this membergroup will be able to report inappropriate posts to the forum moderators.

General

  • Moderate board - Determines whether users in this membergroup can moderate the boards they have access to. With this permission users can reply to locked topics, change poll expiration time and view poll results.
  • Approve items awaiting moderation - Determines whether users in this membergroup can approve topics, posts, or attachments which need to be approved. Post moderation must be enabled for this to be displayed.

Polls

  • View polls - Determines whether users in this membergroup will be able to view polls.
  • Vote in polls - Determines whether users in this membergroup will be able to vote in polls they can see.
  • Post Polls - Determines whether users in this membergroup will be able to create their own polls.
  • Add poll to topics - Determines whether users in this membergroup are allowed to add polls to their own existing topics, any existing topics, or no topics. The user must also have permission to edit topics, to be able to add a poll.
  • Edit polls - Determines whether users in this membergroup can edit their polls, any polls, or no polls at all. This permission allows a user to edit the polls options, reset the poll, edit the maximum number of votes, and edit the expiration time of the poll. A user must also have the 'Moderate board' permission for this.
  • Lock polls - Determines whether users in this membergroup can lock their own polls, any polls, or no polls at all.
  • Remove polls - Determines whether users in this membergroup can remove their own polls, any polls, or no polls at all.

Attachments

  • View Attachments - Determines whether users in this membergroup can view attachments.
  • Post Attachments - Determines whether users in this membergroup can post attachments on topics.
  • Post attachments, but hide until approved - Determines whether users in this membergroup can post attachments which are visible only to moderators with the necessary permissions or administrators, but not other users.
  • Post attachments, without requiring approval - Determines whether users in this membergroup can post attachments without moderator or administrator approval.

Edit Profiles

This page provides ways to create new Board Permission Profiles and edit, delete, or rename existing profiles. All the existing profiles are listed along with the number of boards using each profile.

Only the Default profile, and any custom profiles you might create, can be edited. If you want to edit one, click on it. You will see a table which lists all the membergroups, and gives the number of members in each group and the number of permissions for each group. To the right is a Modify text link for each membergroup. By clicking on that, you can customize the permissions individually for each membergroups in that profile. Or you can use the checkbox on the right, with the Advanced Options below, to edit the permissions all at once for each membergroup.

Duplicate, or New Profiles

The other profiles (No Polls, Read Only, Reply Only) cannot be edited or customized directly. But you can create duplicate profiles, and edit those. From the Edit Profiles page, look below the table which lists all the profiles. There you can create a new profile which is based on whichever existing profile you choose.

  1. Profile Name - Enter a name for your new or duplicate profile.
  2. Copy Permissions From - Choose which existing profile you want to base your new profile on.
  3. Click Create button

Now you will see your new profile name in the list above. Click on it and you will see the table with all the membergroups listed. Click on Modify to edit permissions individually for each membergroup in your custom profile. Or you can use the checkbox on the right, together with the Advanced Options below, to edit the permissions all at once for each membergroup in your new profile.

Rename Profiles

You can rename permission profiles that you have created, but the four default permission profiles (Default, No Polls, Reply Only, and Read Only) cannot be renamed.

Place a check in the box to the right of the profile you want to rename. Then click the Rename All button at the bottom of the list. That will create a field where you can edit the name. When finished, click Save Changes button at the bottom right of the list.

Remove Profiles

You can delete any permission profile that you have created. The four default permission profiles (Default, No Polls, Reply Only, and Read Only) cannot be removed. Select the checkbox on the same line as the profile you wish to remove, and then click the Remove Selected button. Note that you can only delete a permission profile if it is not currently assigned to a board.

Post Moderation

If you would like admins and/or moderators to view messages or attachments, and approve or disapprove them before other members can see them, then place a checkmark in the Enable Post Moderation box. If you install a gallery mod at some point, this may also extend to images uploaded to the gallery (read the gallery mod's faqs to verify). In a way, this allows admins to set even more detailed board permissions regarding posting messages and attachments for each membergroup.

Enabling post moderation will cause a form with detailed options to show up below. Only the Default and any new, custom profiles you have created, can be customized here. First, select which profile you want to customize with post moderation. To the far right of the Legend, in the top, right corner of the form, choose the profile from the dropdown menu at Select Profile and click the Go button.

For each membergroup, there are four User Actions for which post moderation permissions can be set: posting New Topics, the member's Own Replies, Any Replies, and posting Attachments. These are interactive with the relevant board permissions. There are three possible moderation options for each:


  • Blue-document--plus.png - Can Create: members can perform this action without moderation
  • Blue-document--exclamation.png - Can Create but Requires Approval: members can perform the action, but approval is required before the item becomes visible to all other members
  • Blue-document--minus.png - Cannot Create: members cannot perform this action


User Action Blue-document--plus.png Blue-document--exclamation.png Blue-document--minus.png
New Topics Post new topics, without requiring approval Post new topics, but hide until approved Neither allowed
Own Replies Post replies to own topics, without requiring approval Post replies to own topics, but hide until approved Neither allowed
Any Replies Post replies to any topics, without requiring approval Post replies to any topics, but hide until approved Neither allowed
Attachments Post attachments, without requiring approval Post attachments, but hide until approved Neither allowed

Post moderation cannot be used to set deny permissions even if deny is enabled. The 'cannot create' option in post moderation is only ever disallow.

Settings

  • Membergroups allowed to manage permissions - Administrators can select which membergroups are allowed to manage permissions.
  • Enable the option to deny permissions - Once enabled along with granting permissions it will be possible also to deny any permission. Denied permissions are not allowed even if the member belongs to another membergroup for which the permission is granted.
  • Enable permissions for post count based groups - Determines whether or not membergroups based on post count can be used to manage permissions. After you enable this option, all the post count based groups will appear below the original 5 membergroups - for both General and Board Permissions. Then you can edit their permissions, just like with the original membergroups.

About Permissions

Options

SMF's permissions are so powerful because it's possible to have three options set for each individual permission, rather than just on or off.

  • A - This option gives user current permission
  • X - This option does not give the user current permission
  • D - This option denies the user current permission

Note that Deny is not available by default. The administrator needs to enable it in Members > Permissions > Settings.

Things get really interesting when a user belongs to 2 or more membergroups with different options (A, X or D) for the same permission.

Member belongs to 2 membergroups

In this example a member belongs to only 2 different membergroups with different options for some permissions:

permissions option from group A option from group B Result for permission explanation
permission 1 A A allowed obviously
permission 2 A X allowed A beats X
permission 3 A D not allowed D beats A
permission 4 X X not allowed obvious too
permission 2 X D not allowed D beats X
permission 3 D D not allowed is this obvious or what?

In short: D beats A which beats X

Member belongs to 3 or more membergroups

  • If you want a permission to be allowed, then you must have option A in at least one group and no D.
  • If you want a permission to be disallowed, then you must have all options X, or
  • If you want a permission to be disallowed, you must have option D in at least one group. It does not matter if other options are A or X.

You should not use D too much. Its a good idea to use special private membergroups just to Deny some permissions. If you don't want some members to use e.g. private messages, you can set up a private membergroup with a descriptive name like "no-pm" and for that membergroup, set the permissions for pm to D. Every member of that group is not allowed pm's regardless of the other groups they belong. If you change your mind about that setting you can find easily which membergroup restricts PMs and reset it.




Main

Configuration

Forum

Members

Maintenance

Miscellaneous

Retrieved from "https://wiki.simplemachines.org/w/index.php?title=SMF2.1:Permissions&oldid=32040"


Advertisement: