2433 lines
24 KiB
HTML
2433 lines
24 KiB
HTML
<!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>Configuring a File Base | ENiGMA½ BBS Software</title>
|
||
<meta name="generator" content="Jekyll v4.2.1" />
|
||
<meta property="og:title" content="Configuring a File Base" />
|
||
<meta property="og:locale" content="en_US" />
|
||
<meta name="description" content="Configuring a File Base ENiGMA½ offers a powerful and flexible file base. Configuration of file the file base and areas is handled via the fileBase section of config.hjson." />
|
||
<meta property="og:description" content="Configuring a File Base ENiGMA½ offers a powerful and flexible file base. Configuration of file the file base and areas is handled via the fileBase section of config.hjson." />
|
||
<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="Configuring a File Base" />
|
||
<script type="application/ld+json">
|
||
{"description":"Configuring a File Base ENiGMA½ offers a powerful and flexible file base. Configuration of file the file base and areas is handled via the fileBase section of config.hjson.","headline":"Configuring a File Base","url":"/enigma-bbs/filebase/first-file-area.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/filebase/first-file-area.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 class="active-nav">Configuring a File Base</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 & 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><a href="/enigma-bbs/modding/wfc.html">Waiting For Caller (WFC)</a></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/filebase/index.html">« About File Areas</a>
|
||
|
||
<a href="#sidebar" class="btn menu_button">MENU</a>
|
||
|
||
<a class="btn" style="float: right;margin-left: 20px" href="/enigma-bbs/filebase/acs.html">ACS »</a>
|
||
|
||
<br clear="both">
|
||
</div>
|
||
|
||
<div class="page">
|
||
<h1 class="page-title">Configuring a File Base</h1>
|
||
<h2 id="configuring-a-file-base">Configuring a File Base</h2>
|
||
<p>ENiGMA½ offers a powerful and flexible file base. Configuration of file the file base and areas is handled via the <code class="language-plaintext highlighter-rouge">fileBase</code> section of <code class="language-plaintext highlighter-rouge">config.hjson</code>.</p>
|
||
|
||
<h2 id="enigma-file-base-key-concepts">ENiGMA½ File Base Key Concepts</h2>
|
||
<p>First, there are some core concepts you should understand:</p>
|
||
<ul>
|
||
<li>Storage Tags</li>
|
||
<li>Area Tags</li>
|
||
</ul>
|
||
|
||
<h3 id="storage-tags">Storage Tags</h3>
|
||
<p><em>Storage Tags</em> define paths to physical (filesystem) storage locations that are referenced in a file <em>Area</em> entry. Each entry may be either a fully qualified path or a relative path. Relative paths are relative to the value set by the <code class="language-plaintext highlighter-rouge">fileBase.areaStoragePrefix</code> key (defaults to <code class="language-plaintext highlighter-rouge">/path/to/enigma-bbs/file_base</code>).</p>
|
||
|
||
<p>Below is an example defining some storage tags using the relative and fully qualified forms:</p>
|
||
|
||
<pre><code class="language-hjson">storageTags: {
|
||
retro_pc_dos: "dos" // relative
|
||
retro_pc_bbs: "pc/bbs" // still relative!
|
||
bbs_stuff: "/path/to/bbs_stuff_storage" // fully qualified
|
||
}
|
||
</code></pre>
|
||
|
||
<p><img class="emoji" title=":memo:" alt=":memo:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png" height="20" width="20"> On their own, storage tags don’t do anything — they are simply pointers to storage locations on your system.</p>
|
||
|
||
<p><img class="emoji" title=":warning:" alt=":warning:" src="https://github.githubassets.com/images/icons/emoji/unicode/26a0.png" height="20" width="20"> Remember that paths are case sensitive on most non-Windows systems!</p>
|
||
|
||
<h3 id="areas">Areas</h3>
|
||
<p>File base <em>Areas</em> are configured using the <code class="language-plaintext highlighter-rouge">fileBase.areas</code> configuration block in <code class="language-plaintext highlighter-rouge">config.hjson</code>. Each entry’s block starts with an <em>area tag</em>. Valid members for an area are as follows:</p>
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Item</th>
|
||
<th>Required</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="language-plaintext highlighter-rouge">name</code></td>
|
||
<td><img class="emoji" title=":+1:" alt=":+1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20"></td>
|
||
<td>Friendly area name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="language-plaintext highlighter-rouge">desc</code></td>
|
||
<td><img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"></td>
|
||
<td>Friendly area description.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="language-plaintext highlighter-rouge">storageTags</code></td>
|
||
<td><img class="emoji" title=":+1:" alt=":+1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20"></td>
|
||
<td>An array of storage tags for physical storage backing of the files in this area. If uploads are enabled for this area, <strong>first</strong> storage tag location is utilized!</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="language-plaintext highlighter-rouge">sort</code></td>
|
||
<td><img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"></td>
|
||
<td>If present, provides the sort key for ordering. <code class="language-plaintext highlighter-rouge">name</code> is used otherwise.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="language-plaintext highlighter-rouge">hashTags</code></td>
|
||
<td><img class="emoji" title=":-1:" alt=":-1:" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" height="20" width="20"></td>
|
||
<td>Set to an array of strings or comma separated list to provide <em>default</em> hash tags for this area.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<p>Example areas section:</p>
|
||
|
||
<pre><code class="language-hjson">areas: {
|
||
retro_pc: { // an area tag!
|
||
name: Retro PC
|
||
desc: Oldschool PC/DOS
|
||
storageTags: [ "retro_pc_dos", "retro_pc_bbs" ]
|
||
hashTags: ["retro", "pc", "dos" ]
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p>The above example defines an area called “Retro PC” which is referenced via the <em>area tag</em> of <code class="language-plaintext highlighter-rouge">retro_pc</code>. Two storage tags are used: <code class="language-plaintext highlighter-rouge">retro_pc_dos</code>, and <code class="language-plaintext highlighter-rouge">retro_pc_bbs</code>. These storage tags can be seen in the Storage Tags example above.</p>
|
||
|
||
<h2 id="example-configuration">Example Configuration</h2>
|
||
<p>This combines the two concepts described above. When viewing the file areas from ENiGMA½ a user will only see the “Retro PC” area, but the files in the area are stored in the two locations defined in the <code class="language-plaintext highlighter-rouge">storageTags</code> section. We also show a uploads area. Uploads are allowed due to the <a href="/enigma-bbs/filebase/acs.html">ACS</a> block. See <a href="/enigma-bbs/filebase/uploads.html">Uploads</a> for more information.</p>
|
||
|
||
<pre><code class="language-hjson">fileBase: {
|
||
// override the default relative location
|
||
areaStoragePrefix: /enigma-bbs/file_base
|
||
|
||
storageTags: {
|
||
retro_pc_dos: "dos"
|
||
retro_pc_bbs: "pc/bbs"
|
||
}
|
||
|
||
areas: {
|
||
retro_pc: {
|
||
name: Retro PC
|
||
desc: Oldschool PC/DOS
|
||
storageTags: [ "retro_pc_dos", "retro_pc_bbs" ]
|
||
}
|
||
|
||
uploads: {
|
||
name: Uploads
|
||
desc: User uploads
|
||
acs: {
|
||
// allow any user to upload here
|
||
write: GM[users]
|
||
}
|
||
storageTags: [ "user_uploads" ]
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
|
||
<h2 id="importing-areas">Importing Areas</h2>
|
||
<p>Areas can also be imported using <a href="/enigma-bbs/admin/oputil.html">oputil</a> using proper FileGate “RAID” aka <code class="language-plaintext highlighter-rouge">FILEBONE.NA</code> style files. After importing areas, you may wish to tweak configuration such as better <code class="language-plaintext highlighter-rouge">desc</code> fields, ACS, or sorting.</p>
|
||
|
||
<h2 id="importing-files-scan-for-new-files">Importing Files (Scan For New Files)</h2>
|
||
<p>A common task is to <em>import</em> existing files to area(s). Consider a collection of retro BBS files in the area “Retro PC” (tag: <code class="language-plaintext highlighter-rouge">retro_pc</code> above) under the storage tag of <code class="language-plaintext highlighter-rouge">retro_pc_bbs</code>. You might choose to scan for new files in this area (and thus import new entries) as follows with <a href="/enigma-bbs/admin/oputil.html">oputil</a>’s <code class="language-plaintext highlighter-rouge">fb scan</code>:</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>./oputil.js fb scan <span class="nt">--quick</span> <span class="nt">--tags</span> retro,bbs,pc retro_pc@retro_pc_bbs
|
||
</code></pre></div></div>
|
||
|
||
<p>Here we have asked <a href="/enigma-bbs/admin/oputil.html">oputil</a> to scan the file base area by it’s tag <code class="language-plaintext highlighter-rouge">retro_pc</code> and only include the storage tag of <code class="language-plaintext highlighter-rouge">retro_pc_bbs</code>. Note that the storage tag could be omitted, and if so, all of <code class="language-plaintext highlighter-rouge">retro_pc</code> would be scanned. We have also indicated to #hashtag new entries with the tags “retro”, “bbs”, and “pc”.</p>
|
||
|
||
<p>Please see <a href="/enigma-bbs/admin/oputil.html">oputil</a> for more information.</p>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="PageNavigation">
|
||
|
||
<a class="btn" style="float:left;margin-right: 20px;" href="/enigma-bbs/filebase/index.html">« About File Areas</a>
|
||
|
||
|
||
<a class="btn" style="float: right;margin-left: 20px" href="/enigma-bbs/filebase/acs.html">ACS »</a>
|
||
|
||
<br clear="both">
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</body>
|
||
</html>
|