TORRUS_ACLEDIT(8)

✨ TORRUS_ACLEDIT(8) ✨

okay bestie, this is acledit from the torrus manual — the little command that runs the whole guest list for your Torrus setup 💅

---

🎀 NAME 🎀

acledit — manage Torrus access control lists (ACLs). yes, the bouncer. the VIP list. the whole thing. 👑

---

🌸 SYNOPSIS 🌸

torrus acledit [options...]

---

🦋 DESCRIPTION 🦋

so this command is the one that manages the Torrus access control lists, fr fr. every user is identified by a user ID, and every user has a little set of attributes attached. right now the supported attributes are "cn" (the common name, aka the cute display name) and "userPasswordMD5" (which is the MD5 digest of the user's password, no cap).

every user belongs to one or several groups. every group has its own set of privileges. a privilege is identified by a privilege name and an object name. currently there's only one privilege name supported: "DisplayTree", and the object name is the name of the tree that this group is allowed to browse. iconic. 🌳

and listen — user authorization in the web interface is controlled by the $Torrus::CGI::authorizeUsers variable in torrus-siteconfig.pl. that's the switch, bestie. remember it. ✨

---

💖 GROUP MANAGEMENT OPTIONS 💖

• --addgroup=GROUP — creates a brand new group with the name you gave it. new group, who dis 🫶
• --delgroup=GROUP — deletes the group with that name. bye bestie 💀
• --modgroup=GROUP — modifies the group you named.
• --permit=PRIVILEGE — grants the privilege to the group(s). the privileges supported right now are "DisplayTree" (for displaying a datasource tree) and "DisplayAdmInfo" (for displaying the administrative information, aka all the significant parameters for a given datasource leaf). letting them in 🔥
• --deny=PRIVILEGE — revokes the privilege from the group(s). not you anymore 🙈
• --for=OBJECT — the object the privileges are being granted or revoked for. right now it has to be the name of the tree that the "DisplayTree" and "DisplayAdmInfo" privilegs are granted or revoked for. and if you drop an asterisk (*) instead of an object name, that assigns the privilege for all objects. the whole tree. periodt. ⭐

---

🌈 USER MANAGEMENT OPTIONS 🌈

• --adduser=UID — creates a new user with the given user ID. welcome to the party 🎀
• --addhost=HOST — creates a new user for host-based authentication. HOST should be an IPv4 or IPv6 address of the HTTP client. the new username is that address with all non-alphanumeric characters swapped out for underscores. the host password gets changed by the <--hostpassword> option.
• --deluser=UID — deletes the user with the given user ID. uninvited 💅
• --moduser=UID — modifies the user attributes for the given user ID.
• --addtogroup=GROUP — adds the user to the given group.
• --delfromgroup=GROUP — deletes the user from the given group.
• --password=PASSWORD — sets the user's password.
• --hostpassword=PASSWORD — sets the password for host-based authentication. the HTTP client should add a "hostauth" parameter with the password as its value. iykyk 🔐
• --cn=NAME — sets the user's common name.
• --showuser=UID — displays the info for a given user. doxxing, but make it authorized 👑

---

🧚 GENERAL OPTIONS 🧚

• --export=FILE — exports the ACL configuration to a given file.
• --template=FILE — uses the given template file when exporting. the default value is aclexport.xml. ✨
• --import=FILE — imports the ACL configuration from the given file.
• --clear — deletes all user and privileges configuration. like, all of it. gone. dramatic but true 😭
• --list — lists all users and the groups they belong to.
• --debug — sets the log level to debug.
• --verbose — sets the log level to info.
• --help — displays a help message.

---

🌟 EXAMPLES 🌟

  torrus acledit --addgroup=staff --permit=DisplayTree \
    --for=main --for=thecustomer
  torrus acledit --adduser=jsmith --password=mysecretpassword \
    --cn="John Smith" --addtogroup=staff
  torrus acledit --addgroup=admin --permit=DisplayTree --for='*'

so this example creates a group staff and gives every single one of its members the permission to browse the datasource trees main and thecustomer. the next command creates a user jsmith and addts it to this group. the user name will be displayed as John Smith, and it will be let in with the given password. and the third command creates a group admin which is allowed o browse all existing trees. ate and left no crumbs 💅

---

🍓 FILES 🍓

• /etc/torrus/conf/torrus-siteconfig.pl — the Torrus site configuration script.
• /usr/share/torrus/templates/aclexport.xml — the default template for the exports of ACL configuration.

---

👑 SEE ALSO 👑

torrus(8)

---

💜 NOTES 💜

see more documentation at the Torrus home page: http://torrus.org 🌈

---

🫶 AUTHOR 🫶

Stanislav Sinyagin <ssinyagin@k-open.com>

---

okay that's the whole page bestie, every flag, every default, every path, nothing skipped, no cap 💖

and a lil sign-off from us: this was torrus 3.00, dated 2023-05-02 — the TORRUS_ACLEDIT(8) page, rewritten with love, glitter, and a truly unhinged number of emoji 🦋✨🌸🎀