diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index c366c8fa..33702016 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -25,7 +25,6 @@ - [Access Condition System (ACS)]({{ site.baseurl }}{% link configuration/acs.md %}) - Scheduled jobs - - File Base - [About]({{ site.baseurl }}{% link filebase/index.md %}) - [Configuring a File Area]({{ site.baseurl }}{% link filebase/first-file-area.md %}) @@ -70,6 +69,9 @@ - [User List]({{ site.baseurl }}{% link modding/user-list.md %}) - [Message Conference List]({{ site.baseurl }}{% link modding/msg-conf-list.md %}) - [Message Area List]({{ site.baseurl }}{% link modding/msg-area-list.md %}) + + - Administration + - [oputil]({{ site.baseurl }}{% link admin/oputil.md %}) - [Oputil]({{ site.baseurl }}{% link oputil/index.md %}) diff --git a/docs/admin/oputil.md b/docs/admin/oputil.md new file mode 100644 index 00000000..9935ea68 --- /dev/null +++ b/docs/admin/oputil.md @@ -0,0 +1,47 @@ +--- +layout: page +title: oputil +--- +## The oputil CLI +ENiGMA½ comes with `oputil.js` henceforth known as `oputil`, a command line interface (CLI) tool for sysops to perform general system and user administration. You likely used oputil to do the initial ENiGMA configuration. + +Let's look the main help output as per this writing: + +``` +usage: optutil.js [--version] [--help] + [] + +global args: + -c, --config PATH specify config path (./config/) + -n, --no-prompt assume defaults/don't prompt for input where possible + +commands: + user user utilities + config config file management + fb file base management + mb message base management +``` + +Commands break up operations by groups. Type `./oputil.js --help` for additional help on a particular command. The next sections will describe them. + +## User +``` +usage: optutil.js user [] + +actions: + pw USERNAME PASSWORD set password to PASSWORD for USERNAME + rm USERNAME permanantely removes USERNAME user from system + activate USERNAME sets USERNAME's status to active + deactivate USERNAME sets USERNAME's status to deactive + disable USERNAME sets USERNAME's status to disabled + group USERNAME [+|-]GROUP adds (+) or removes (-) USERNAME from GROUP +``` + +| Action | Description | Examples | Aliases | +|-----------|-------------------|---------------------------------------|-----------| +| `pw` | Set password | `./oputil.js user pw joeuser s3cr37` | `pass`, `passwd`, `password` | +| `rm` | Removes user | `./oputil.js user del joeuser` | `remove`, `del`, `delete` | +| `activate` | Activates user | `./oputil.js user activate joeuser` | N/A | +| `deactivate` | Deactivates user | `./oputil.js user deactivate joeuser` | N/A | +| `disable` | Disables user (user will not be able to login) | `./oputil.js user disable joeuser` | N/A | +| `group` | Modifies users group membership | Add to group: `./oputil.js user group joeuser +derp`
Remove from group: `./oputil.js user group joeuser -derp` | N/A |