enigma-bbs/modding/wfc.html

2531 lines
33 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" sizes="16x16" href="/enigma-bbs/assets/images/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="/enigma-bbs/assets/images/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="32x32" href="/enigma-bbs/assets/images/favicon-32x32.png">
<link rel="stylesheet" href="/enigma-bbs/assets/css/style.css?v=">
<!-- Begin Jekyll SEO tag v2.7.1 -->
<title>Waiting For Caller (WFC) | ENiGMA½ BBS Software</title>
<meta name="generator" content="Jekyll v4.2.1" />
<meta property="og:title" content="Waiting For Caller (WFC)" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="The Waiting For Caller (WFC) Module The wfc.js module provides a Waiting For Caller (WFC) type dashboard from a bygone era. Many traditional features are available including newer concepts for modern times. Node spy is left out as it feels like something that should be left in the past." />
<meta property="og:description" content="The Waiting For Caller (WFC) Module The wfc.js module provides a Waiting For Caller (WFC) type dashboard from a bygone era. Many traditional features are available including newer concepts for modern times. Node spy is left out as it feels like something that should be left in the past." />
<meta property="og:site_name" content="ENiGMA½ BBS Software" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2023-05-11T14:44:08+00:00" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Waiting For Caller (WFC)" />
<script type="application/ld+json">
{"description":"The Waiting For Caller (WFC) Module The wfc.js module provides a Waiting For Caller (WFC) type dashboard from a bygone era. Many traditional features are available including newer concepts for modern times. Node spy is left out as it feels like something that should be left in the past.","headline":"Waiting For Caller (WFC)","url":"/enigma-bbs/modding/wfc.html","dateModified":"2023-05-11T14:44:08+00:00","@type":"BlogPosting","datePublished":"2023-05-11T14:44:08+00:00","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/modding/wfc.html"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="container">
<div class="sidebar" id="sidebar">
<hr class="mobile-divide">
<div class="container">
<a href="/enigma-bbs/"><img src="/enigma-bbs/assets/images/enigma-logo.png" class="logo" alt="Enigma logo"></a>
</div>
<ul>
<li>Installation</li>
<ul>
<li><a href="/enigma-bbs/installation/installation-methods.html">Installation Methods</a></li>
<li><a href="/enigma-bbs/installation/install-script.html">Install Script</a></li>
<li><a href="/enigma-bbs/installation/docker.html">Docker</a></li>
<li><a href="/enigma-bbs/installation/manual.html">Manual Installation</a></li>
<li>OS / Hardware Specific</li>
<ul>
<li><a href="/enigma-bbs/installation/hardware/rpi.html">Raspberry Pi</a></li>
<li><a href="/enigma-bbs/installation/hardware/windows.html">Installation Under Windows</a></li>
</ul>
<li><a href="/enigma-bbs/installation/network.html">Network Setup</a></li>
<li><a href="/enigma-bbs/installation/testing.html">Testing Your Installation</a></li>
<li><a href="/enigma-bbs/installation/production.html">Production Installation</a></li>
</ul>
<li>Configuration</li>
<ul>
<li><a href="/enigma-bbs/configuration/creating-config.html">Creating Initial Config Files</a></li>
<li><a href="/enigma-bbs/configuration/sysop-setup.html">SysOp Setup</a></li>
<li><a href="/enigma-bbs/configuration/config-files.html">Configuration Files</a></li>
<li><a href="/enigma-bbs/configuration/config-hjson.html">System Configuration</a></li>
<li><a href="/enigma-bbs/configuration/hjson.html">HJSON Config Files</a></li>
<li><a href="/enigma-bbs/configuration/menu-hjson.html">Menu HSJON</a></li>
<li><a href="/enigma-bbs/configuration/directory-structure.html">Directory Structure</a></li>
<li><a href="/enigma-bbs/configuration/external-binaries.html">External Support Binaries</a></li>
<li><a href="/enigma-bbs/configuration/archivers.html">Archivers</a></li>
<li><a href="/enigma-bbs/configuration/file-transfer-protocols.html">File Transfer Protocols</a></li>
<li><a href="/enigma-bbs/configuration/email.html">Email</a></li>
<li><a href="/enigma-bbs/configuration/colour-codes.html">Colour Codes</a></li>
<li><a href="/enigma-bbs/configuration/event-scheduler.html">Event Scheduler</a></li>
<li><a href="/enigma-bbs/configuration/acs.html">Access Condition System (ACS)</a></li>
<li><a href="/enigma-bbs/configuration/security.html">Security</a></li>
</ul>
<li>Miscellaneous</li>
<ul>
<li><a href="/enigma-bbs/misc/user-interrupt.html">User Interruptions</a></li>
</ul>
<li>File Base</li>
<ul>
<li><a href="/enigma-bbs/filebase/index.html">About File Areas</a></li>
<li><a href="/enigma-bbs/filebase/first-file-area.html">Configuring a File Base</a></li>
<li><a href="/enigma-bbs/filebase/acs.html">ACS</a></li>
<li><a href="/enigma-bbs/filebase/uploads.html">Uploads</a></li>
<li><a href="/enigma-bbs/filebase/web-access.html">Web Access</a></li>
<li><a href="/enigma-bbs/filebase/tic-support.html">TIC Support</a></li>
<li><a href="/enigma-bbs/filebase/network-mounts-and-symlinks.html">Network Mounts &amp; Symlinks</a></li>
</ul>
<li>Message Areas</li>
<ul>
<li><a href="/enigma-bbs/messageareas/configuring-a-message-area.html">Message Base</a></li>
<li><a href="/enigma-bbs/messageareas/message-networks.html">Message Networks</a></li>
<li><a href="/enigma-bbs/messageareas/bso-import-export.html">BSO Import / Export</a></li>
<li><a href="/enigma-bbs/messageareas/netmail.html">Netmail</a></li>
<li><a href="/enigma-bbs/messageareas/qwk.html">QWK Support</a></li>
<li><a href="/enigma-bbs/messageareas/ftn.html">FidoNet-Style Networks (FTN)</a></li>
</ul>
<li>Art</li>
<ul>
<li><a href="/enigma-bbs/art/general.html">General Art Information</a></li>
<li><a href="/enigma-bbs/art/themes.html">Themes</a></li>
<li><a href="/enigma-bbs/art/mci.html">MCI Codes</a></li>
<li>Views</li>
<ul>
<li><a href="/enigma-bbs/art/views/button_view.html">Button View</a></li>
<li><a href="/enigma-bbs/art/views/edit_text_view.html">Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/full_menu_view.html">Full Menu View</a></li>
<li><a href="/enigma-bbs/art/views/horizontal_menu_view.html">Horizontal Menu View</a></li>
<li><a href="/enigma-bbs/art/views/mask_edit_text_view.html">Mask Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/multi_line_edit_text_view.html">Multi Line Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/spinner_menu_view.html">Spinner Menu View</a></li>
<li><a href="/enigma-bbs/art/views/text_view.html">Text View</a></li>
<li><a href="/enigma-bbs/art/views/toggle_menu_view.html">Toggle Menu View</a></li>
<li><a href="/enigma-bbs/art/views/vertical_menu_view.html">Vertical Menu View</a></li>
</ul>
</ul>
<li>Servers</li>
<ul>
<li>Login Servers</li>
<ul>
<li><a href="/enigma-bbs/servers/loginservers/telnet.html">Telnet Server</a></li>
<li><a href="/enigma-bbs/servers/loginservers/ssh.html">SSH Server</a></li>
<li><a href="/enigma-bbs/servers/loginservers/websocket.html">Web Socket / Web Interface Server</a></li>
</ul>
<li>Content Servers</li>
<ul>
<li><a href="/enigma-bbs/servers/contentservers/web-server.html">Web Server</a></li>
<li><a href="/enigma-bbs/servers/contentservers/gopher.html">Gopher Server</a></li>
<li><a href="/enigma-bbs/servers/contentservers/nntp.html">NNTP Server</a></li>
</ul>
</ul>
<li>Modding</li>
<ul>
<li><a href="/enigma-bbs/modding/local-doors.html">Local Doors</a></li>
<li><a href="/enigma-bbs/modding/door-servers.html">Door Servers</a></li>
<li><a href="/enigma-bbs/modding/telnet-bridge.html">Telnet Bridge</a></li>
<li><a href="/enigma-bbs/modding/existing-mods.html">Existing Mods</a></li>
<li><a href="/enigma-bbs/modding/file-area-list.html">File Area List</a></li>
<li><a href="/enigma-bbs/modding/last-callers.html">Last Callers</a></li>
<li><a href="/enigma-bbs/modding/whos-online.html">Who's Online</a></li>
<li><a href="/enigma-bbs/modding/user-list.html">User List</a></li>
<li><a href="/enigma-bbs/modding/msg-conf-list.html">Message Conference List</a></li>
<li><a href="/enigma-bbs/modding/msg-area-list.html">Message Area List</a></li>
<li><a href="/enigma-bbs/modding/bbs-list.html">BBS List</a></li>
<li><a href="/enigma-bbs/modding/rumorz.html">Rumorz</a></li>
<li><a href="/enigma-bbs/modding/file-transfer-protocol-select.html">File Transfer Protocol Select</a></li>
<li><a href="/enigma-bbs/modding/onelinerz.html">Onelinerz</a></li>
<li><a href="/enigma-bbs/modding/show-art.html">The Show Art Module</a></li>
<li><a href="/enigma-bbs/modding/file-base-download-manager.html">File Base Download Manager</a></li>
<li><a href="/enigma-bbs/modding/file-base-web-download-manager.html">File Base Web Download Manager</a></li>
<li><a href="/enigma-bbs/modding/set-newscan-date.html">Set Newscan Date Module</a></li>
<li><a href="/enigma-bbs/modding/node-msg.html">Node to Node Messaging</a></li>
<li><a href="/enigma-bbs/modding/top-x.html">TopX</a></li>
<li><a href="/enigma-bbs/modding/user-2fa-otp-config.html">2FA/OTP Config</a></li>
<li><a href="/enigma-bbs/modding/autosig-edit.html">Auto Signature Editor</a></li>
<li><a href="/enigma-bbs/modding/menu-modules.html">Menu Modules</a></li>
</ul>
<li>Administration</li>
<ul>
<li><a href="/enigma-bbs/admin/administration.html">Administration</a></li>
</ul>
<li>Modding</li>
<ul>
<li class="active-nav">Waiting For Caller (WFC)</li>
</ul>
<li>Administration</li>
<ul>
<li><a href="/enigma-bbs/admin/oputil.html">oputil</a></li>
<li><a href="/enigma-bbs/admin/updating.html">Updating</a></li>
</ul>
<li>Troubleshooting</li>
<ul>
<li><a href="/enigma-bbs/troubleshooting/monitoring-logs.html">Monitoring Logs</a></li>
</ul>
</ul>
</div>
<div class="main_area">
<div class="container">
<section id="main_content">
<div class="PageNavigation">
<a class="btn" style="float:left;margin-right: 20px;" href="/enigma-bbs/admin/administration.html">« Administration</a>
<a href="#sidebar" class="btn menu_button">MENU</a>
<a class="btn" style="float: right;margin-left: 20px" href="/enigma-bbs/admin/oputil.html">oputil »</a>
<br clear="both">
</div>
<div class="page">
<h1 class="page-title">Waiting For Caller (WFC)</h1>
<h2 id="the-waiting-for-caller-wfc-module">The Waiting For Caller (WFC) Module</h2>
<p>The <code class="language-plaintext highlighter-rouge">wfc.js</code> module provides a Waiting For Caller (WFC) type dashboard from a bygone era. Many traditional features are available including newer concepts for modern times. Node spy is left out as it feels like something that should be left in the past.</p>
<p><img src="/enigma-bbs/assets/images/wfc.png" alt="WFC"><br></p>
<h2 id="accessing-the-wfc">Accessing the WFC</h2>
<p>By default, the WFC may be accessed via the <code class="language-plaintext highlighter-rouge">!WFC</code> main menu command when connected over a secure connection via a user with the proper <a href="/enigma-bbs/configuration/acs.html">ACS</a>. This can be configured as per any other menu in the system. Note that ENiGMA½ does not expose the WFC as a standalone application as this would be much less flexible. To connect locally, simply use your favorite terminal or for example: <code class="language-plaintext highlighter-rouge">ssh -l yourname localhost 8889</code>. See <strong>Security</strong> below for more information.</p>
<h2 id="security">Security</h2>
<p>The system allows any user with the proper security to access the WFC / system operator functionality. The security policy is enforced by ACS with the default of <code class="language-plaintext highlighter-rouge">SCAF2ID1GM[wfc]</code>, meaning the following are true:</p>
<ol>
<li>Securely Connected (such as SSH or Secure WebSocket, but not Telnet)</li>
<li>
<a href="modding/user-2fa-otp-config.md">Auth Factor 2+</a>. That is, the user has 2FA enabled.</li>
<li>User ID of 1 (root/admin)</li>
<li>The user belongs to the <code class="language-plaintext highlighter-rouge">wfc</code> group.</li>
</ol>
<blockquote>
<p><img class="emoji" title=":information_source:" alt=":information_source:" src="https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height="20" width="20"> Due to the above, the WFC screen is <strong>disabled</strong> by default as at a minimum, youll need to add your user to the <code class="language-plaintext highlighter-rouge">wfc</code> group. See also <a href="/enigma-bbs/configuration/security.html">Security</a> for more information on keeping your system secure!</p>
</blockquote>
<p>Adding your user to the <code class="language-plaintext highlighter-rouge">wfc</code> group:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Repalce USERNAME with your leet +op username</span>
./oputil.js user group USERNAME <span class="s2">"+wfc"</span>
</code></pre></div></div>
<p>To change the ACS required, specify a alternative <code class="language-plaintext highlighter-rouge">acs</code> in the <code class="language-plaintext highlighter-rouge">config</code> block. For example:</p>
<pre><code class="language-hjson">mainMenuWaitingForCaller: {
config: {
// initial +op over secure connection only
acs: ID1SC
}
}
</code></pre>
<blockquote>
<p><img class="emoji" title=":bulb:" alt=":bulb:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png" height="20" width="20"> You can add additional co-ops by adjusting the required ACS and/or adding them to an WFC-able group.</p>
</blockquote>
<blockquote>
<p><img class="emoji" title=":lock:" alt=":lock:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f512.png" height="20" width="20"> ENiGMA½ will enforce ACS of at least <code class="language-plaintext highlighter-rouge">SC</code> (secure connection)</p>
</blockquote>
<h2 id="configuration">Configuration</h2>
<h3 id="config-block">Config Block</h3>
<p>The WFC <code class="language-plaintext highlighter-rouge">config</code> block allows for the following keys:
| Key | Required | Description |
|—–|———-|————-|
| <code class="language-plaintext highlighter-rouge">acs</code> | <img class="emoji" title=":+1:" alt=":+1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20"> | See <a href="#security">Security</a> above. |
| <code class="language-plaintext highlighter-rouge">opVisibility</code> | <img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"> | Boolean. Set to <code class="language-plaintext highlighter-rouge">true</code> or <code class="language-plaintext highlighter-rouge">false</code> in order to change visbility when entering the WFC |
| <code class="language-plaintext highlighter-rouge">quickLogLevel</code> | <img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"> | Sets the log level for the quick log view. Defaults to <code class="language-plaintext highlighter-rouge">info</code>. See also <a href="/enigma-bbs/troubleshooting/monitoring-logs.html">Monitoring Logs</a>. |
| <code class="language-plaintext highlighter-rouge">art</code> | <img class="emoji" title=":+1:" alt=":+1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20"> | An Object containing art information: <code class="language-plaintext highlighter-rouge">main</code> for the WFC main view itself and <code class="language-plaintext highlighter-rouge">help</code> for a help screen. |
| <code class="language-plaintext highlighter-rouge">confirmKickNodePrompt</code> | <img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"> | Override the prompt name used for the “Kick selected node?” prompt. Defaults to <code class="language-plaintext highlighter-rouge">confirmKickNodePrompt</code> |
|</p>
<h2 id="theming">Theming</h2>
<p>The following MCI codes are available:</p>
<ul>
<li>
<code class="language-plaintext highlighter-rouge">VM1</code>: Node status list with the following format items available:
<ul>
<li>
<code class="language-plaintext highlighter-rouge">text</code>: Username or <code class="language-plaintext highlighter-rouge">*Pre Auth*</code>.</li>
<li>
<code class="language-plaintext highlighter-rouge">action</code>: Current action/menu.</li>
<li>
<code class="language-plaintext highlighter-rouge">affils</code>: Any affiliations related to the if <code class="language-plaintext highlighter-rouge">authenticated</code>, else “N/A”.</li>
<li>
<code class="language-plaintext highlighter-rouge">authenticated</code>: Boolean rather the node is authenticated (logged in) or not.</li>
<li>
<code class="language-plaintext highlighter-rouge">availIndicator</code>: Indicator of availability (e.g. for messaging)? Displayed via <code class="language-plaintext highlighter-rouge">statusAvailableIndicators</code> or system theme. See also <a href="/enigma-bbs/art/themes.html">Themes</a>.</li>
<li>
<code class="language-plaintext highlighter-rouge">isAvailalbe</code>: Boolean rather the node is availalbe (e.g. for messaging) or not.</li>
<li>
<code class="language-plaintext highlighter-rouge">isSecure</code>: Is the node securely connected (ie: SSL)?</li>
<li>
<code class="language-plaintext highlighter-rouge">isVisible</code>: Boolean rather the node is visible to others or not.</li>
<li>
<code class="language-plaintext highlighter-rouge">node</code>: The node ID.</li>
<li>
<code class="language-plaintext highlighter-rouge">realName</code>: Real name of authenticated user, or “N/A”.</li>
<li>
<code class="language-plaintext highlighter-rouge">serverName</code>: Name of connected server such as “Telnet” or “SSH”.</li>
<li>
<code class="language-plaintext highlighter-rouge">timeOn</code>: How long the node has been connected.</li>
<li>
<code class="language-plaintext highlighter-rouge">timeOnMinutes</code>: How long in <strong>minutes</strong> the node has been connected.</li>
<li>
<code class="language-plaintext highlighter-rouge">userId</code>: User ID of authenticated node, or 0 if not yet authenticated.</li>
<li>
<code class="language-plaintext highlighter-rouge">userName</code>: User name of authenticated user or “<em>Pre Auth</em></li>
<li>
<code class="language-plaintext highlighter-rouge">visIndicator</code>: Indicator of visibility. Displayed via <code class="language-plaintext highlighter-rouge">statusVisibleIndicators</code> or system theme. See also <a href="/enigma-bbs/art/themes.html">Themes</a>.</li>
<li>
<code class="language-plaintext highlighter-rouge">remoteAddress</code>: A friendly formatted remote address such as a IPv4 or IPv6 address.</li>
</ul>
</li>
<li>
<code class="language-plaintext highlighter-rouge">VM2</code>: Quick log with the following format keys available:
<ul>
<li>
<code class="language-plaintext highlighter-rouge">timestamp</code>: Log entry timestamp in <code class="language-plaintext highlighter-rouge">quickLogTimestampFormat</code> format.</li>
<li>
<code class="language-plaintext highlighter-rouge">level</code>: Log entry level from Bunyan.</li>
<li>
<code class="language-plaintext highlighter-rouge">levelIndicator</code>: Level indicators can be overridden with the <code class="language-plaintext highlighter-rouge">quickLogLevelIndicators</code> key (see defaults below)</li>
<li>
<code class="language-plaintext highlighter-rouge">quickLogLevelIndicators</code>: A <strong>map</strong> defaulting to the following`:
<ul>
<li>
<code class="language-plaintext highlighter-rouge">trace</code> : <code class="language-plaintext highlighter-rouge">T</code>
</li>
<li>
<code class="language-plaintext highlighter-rouge">debug</code>: <code class="language-plaintext highlighter-rouge">D</code>
</li>
<li>
<code class="language-plaintext highlighter-rouge">info</code>: <code class="language-plaintext highlighter-rouge">I</code>
</li>
<li>
<code class="language-plaintext highlighter-rouge">warn</code>: <code class="language-plaintext highlighter-rouge">W</code>
</li>
<li>
<code class="language-plaintext highlighter-rouge">error</code>: <code class="language-plaintext highlighter-rouge">E</code>
</li>
<li>
<code class="language-plaintext highlighter-rouge">fatal</code>: <code class="language-plaintext highlighter-rouge">F</code>
</li>
</ul>
</li>
<li>
<code class="language-plaintext highlighter-rouge">nodeId</code>: Node ID.</li>
<li>
<code class="language-plaintext highlighter-rouge">sessionId</code>: Session ID.</li>
<li>
<code class="language-plaintext highlighter-rouge">quickLogLevelMessagePrefixes</code>: A <strong>map</strong> of log level names (see above) to message prefixes. Commonly used for changing message color with pipe codes, such as <code class="language-plaintext highlighter-rouge">|04</code> for red errors.</li>
<li>
<code class="language-plaintext highlighter-rouge">message</code>: Log message.</li>
</ul>
</li>
<li>
<code class="language-plaintext highlighter-rouge">MT3</code> or <code class="language-plaintext highlighter-rouge">ET3</code>: Selected node status information. May be a single or multi line view.
<ul>
<li>Set <code class="language-plaintext highlighter-rouge">nodeStatusSelectionFormat</code> to the format desired including <code class="language-plaintext highlighter-rouge">\n</code> for line feeds in as <code class="language-plaintext highlighter-rouge">MT</code> view. The availalbe format keys are the same as the node status list above.</li>
</ul>
</li>
<li>MCI 10…99: Custom entries with the following format keys available:
<ul>
<li>
<code class="language-plaintext highlighter-rouge">nowDate</code>: Current date in the <code class="language-plaintext highlighter-rouge">dateFormat</code> style, defaulting to <code class="language-plaintext highlighter-rouge">short</code>.</li>
<li>
<code class="language-plaintext highlighter-rouge">nowTime</code>: Current time in the <code class="language-plaintext highlighter-rouge">timeFormat</code> style, defaulting to <code class="language-plaintext highlighter-rouge">short</code>.</li>
<li>
<code class="language-plaintext highlighter-rouge">now</code>: Current date and/or time in <code class="language-plaintext highlighter-rouge">nowDateTimeFormat</code> format.</li>
<li>
<code class="language-plaintext highlighter-rouge">processUptimeSeconds</code>: Process (the BBS) uptime in seconds.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalCalls</code>: Total calls to the system.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalPosts</code>: Total posts to the system.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalUsers</code>: Total users on the system.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalFiles</code>: Total number of files on the system.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalFileBytes</code>: Total size in bytes of the file base.</li>
<li>
<code class="language-plaintext highlighter-rouge">callsToday</code>: Number of calls today.</li>
<li>
<code class="language-plaintext highlighter-rouge">postsToday</code>: Number of posts today.</li>
<li>
<code class="language-plaintext highlighter-rouge">uploadsToday</code>: Number of uploads today.</li>
<li>
<code class="language-plaintext highlighter-rouge">uploadBytesToday</code>: Total size in bytes of uploads today.</li>
<li>
<code class="language-plaintext highlighter-rouge">downloadsToday</code>: Number of downloads today.</li>
<li>
<code class="language-plaintext highlighter-rouge">downloadsBytesToday</code>: Total size in bytes of uploads today.</li>
<li>
<code class="language-plaintext highlighter-rouge">newUsersToday</code>: Number of new users today.</li>
<li>
<code class="language-plaintext highlighter-rouge">currentUserName</code>: Current user name.</li>
<li>
<code class="language-plaintext highlighter-rouge">currentUserRealName</code>: Current users real name.</li>
<li>
<code class="language-plaintext highlighter-rouge">lastLoginUserName</code>: Last login username.</li>
<li>
<code class="language-plaintext highlighter-rouge">lastLoginRealName</code>: Last login users real name.</li>
<li>
<code class="language-plaintext highlighter-rouge">lastLoginDate</code>: Last login date in <code class="language-plaintext highlighter-rouge">dateFormat</code> format.</li>
<li>
<code class="language-plaintext highlighter-rouge">lastLoginTime</code>: Last login time in <code class="language-plaintext highlighter-rouge">timeFormat</code> format.</li>
<li>
<code class="language-plaintext highlighter-rouge">lastLogin</code>: Last login date/time.</li>
<li>
<code class="language-plaintext highlighter-rouge">totalMemoryBytes</code>: Total system memory in bytes.</li>
<li>
<code class="language-plaintext highlighter-rouge">freeMemoryBytes</code>: Free system memory in bytes.</li>
<li>
<code class="language-plaintext highlighter-rouge">systemAvgLoad</code>: System average load.</li>
<li>
<code class="language-plaintext highlighter-rouge">systemCurrentLoad</code>: System current load.</li>
<li>
<code class="language-plaintext highlighter-rouge">newPrivateMail</code>: Number of new <strong>private</strong> mail for current user.</li>
<li>
<code class="language-plaintext highlighter-rouge">newMessagesAddrTo</code>: Number of new messages <strong>addressed to the current user</strong>.</li>
<li>
<code class="language-plaintext highlighter-rouge">availIndicator</code>: Is the current user availalbe? Displayed via <code class="language-plaintext highlighter-rouge">statusAvailableIndicators</code> or system theme. See also <a href="/enigma-bbs/art/themes.html">Themes</a>.</li>
<li>
<code class="language-plaintext highlighter-rouge">visIndicator</code>: Is the current user visible? Displayed via <code class="language-plaintext highlighter-rouge">statusVisibleIndicators</code> or system theme. See also <a href="/enigma-bbs/art/themes.html">Themes</a>.</li>
<li>
<code class="language-plaintext highlighter-rouge">processBytesIngress</code>: Ingress bytes since ENiGMA started.</li>
<li>
<code class="language-plaintext highlighter-rouge">processBytesEgress</code>: Egress bytes since ENiGMA started.</li>
</ul>
</li>
</ul>
<blockquote>
<p><img class="emoji" title=":information_source:" alt=":information_source:" src="https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height="20" width="20"> While <a href="/enigma-bbs/art/mci.html">Standard MCI</a> codes work on any menu, they will <strong>not</strong> refresh. For values that may change over time, please use the custom format values above.</p>
</blockquote>
</div>
<div class="PageNavigation">
<a class="btn" style="float:left;margin-right: 20px;" href="/enigma-bbs/admin/administration.html">« Administration</a>
<a class="btn" style="float: right;margin-left: 20px" href="/enigma-bbs/admin/oputil.html">oputil »</a>
<br clear="both">
</div>
</section>
</div>
</div>
</div>
</body>
</html>