Oxide permissions 101 Print

Configuring Oxide Permissions: A Comprehensive Guide

Oxide provides a robust permissions system for your Rust server, enabling fine-grained control over player actions. This guide will walk you through the essentials of configuring Oxide permissions, from basic commands to advanced techniques.

Understanding the Basics

Oxide permissions revolve around users, groups, and permissions.

• Users: Individual players on your server.
• Groups: Collections of users who share the same set of permissions. This simplifies administration by allowing you to manage permissions for multiple players at once.
• Permissions: Specific actions or abilities granted to users or groups, such as building, using certain commands, or accessing specific areas.

Essential Oxide Commands

Oxide offers a variety of commands for managing permissions. Here are the core commands:

User Management

• oxide.grant user <username> <permission>: Grants a specific permission to a user.
• oxide.revoke user <username> <permission>: Revokes a permission from a user.
• oxide.show user <username>: Displays the permissions assigned to a user.

Group Management

• oxide.group add <groupname> ["Title"] <rank>: Creates a new group with an optional title and rank.
• oxide.group set <groupname> ["Title"] <rank>: Modifies an existing group's title and/or rank.
• oxide.group remove <groupname>: Deletes a group.
• oxide.grant group <groupname> <permission>: Grants a permission to a group.
• oxide.revoke group <groupname> <permission>: Revokes a permission from a group.
• oxide.show group <groupname>: Displays the members and permissions of a group.

User-Group Management

• oxide.usergroup add <username> <groupname>: Adds a user to a group.

• oxide.usergroup remove <username> <groupname>: Removes a user from a group.

Permission Inspection

• oxide.show perm <permission>: Shows which users and groups have a specific permission.
• oxide.show groups: Lists all existing groups on the server.
• oxide.show perms: Lists all available permissions.

Advanced Techniques

Wildcards: Use the asterisk (*) as a wildcard to grant or revoke multiple permissions at once. For example, oxide.grant group admin * grants all permissions to the "admin" group.

Parent Groups: Create a hierarchy of groups by assigning parent groups. Child groups inherit all permissions from their parent group. Use oxide.group parent <parentgroup> <childgroup> to set a parent group.

Plugin Permissions: Many plugins introduce their own specific permissions. Refer to the plugin's documentation to learn about its available permissions.

Best Practices

• Plan your permission structure: Before configuring permissions, consider the different roles you want on your server (e.g., moderators, VIPs) and the permissions they should have.
• Use groups effectively: Groups simplify permission management by allowing you to apply permissions to multiple users at once.
• Start with minimal permissions: Grant only the necessary permissions to users and groups. You can always add more later.
• Document your permissions: Keep a record of your permission configuration for future reference and troubleshooting.
• Regularly review and update: As your server evolves, revisit your permission setup to ensure it remains effective and secure.

Example Scenario

Let's say you want to create a "moderator" group with the following permissions:

• Kick players
• Ban players
• Use the server chat in a different color

1. Create the group: oxide.group add moderator "Moderators" 1
2. Grant permissions:
   • oxide.grant group moderator kick
   • oxide.grant group moderator ban
   • oxide.grant group moderator chat.color

Now, any user added to the "moderator" group will automatically inherit these permissions.

By mastering Oxide's permission system, you can create a customized and secure environment for your Rust server. Remember to consult the official Oxide documentation and individual plugin documentation for further details and advanced configurations.