File: docs/index.md

Recommend this page to a friend!

docs/index.md

File:	`docs/index.md`
Role:	Auxiliary data
Content type:	`text/markdown`
Description:	Auxiliary data
Class:	Binkterm PHP Bulletin board system based on the Web
Author:	By Matthew Asham
Last change:
Date:	5 days ago
Size:	`10,841 bytes`

BinktermPHP Documentation

Complete reference for sysops and developers. New here? Start with Getting Started or Installation. Developers should begin at Architecture and Developer Guide.

Getting Started ? New sysop walkthrough: installation through first working FTN connection
Installation ? System requirements, web server configuration (Caddy, Nginx, Apache), cron setup, and network port reference
Configuration Reference ? Environment variables, .env settings, and core configuration options
Command Line Interface ? All CLI scripts: binkp_server, binkp_poll, maintenance tools
Maintenance ? Routine maintenance procedures, log rotation, database cleanup
Dashboard ? User dashboard, activity cards, and quick access to platform features
Analytics ? Activity stats, AI usage, ad analytics, and content-sharing reports
Registration ? How to register, premium features, and license installation

Joining and Configuring an FTN ? Connect a node to an FTN, configure its uplink, and bring network mail into the platform
Echo Areas ? Message areas where inbound FTN echomail becomes visible to web and terminal users
Echo Digests ? Scheduled email digests of echomail areas
File Areas ? File area configuration, uploads, and management
FREQ ? File request (FREQ) serving and requesting: modes, magic names, routing, and CLI tools
LovlyNet ? LovlyNet network file sharing and FileFix integration
AreaFix / FileFix ? Managing echomail and file-area subscriptions with hub uplinks

Nodelist ? Importing and searching the FTN nodelist: file area rules, URL downloader, node browser, map view, and crashmail routing
BBS Directory ? Public BBS listing: echomail robot, scheduled imports, file area rules, admin management, and geocoding

Terminal Server ? Terminal access layer for BBS-style sessions over text protocols
Telnet Daemon ? Telnet access method setup, configuration, and troubleshooting
SSH Server ? Secure shell access method for terminal users
PacketBBS Gateway ? Packet/mesh access method for low-bandwidth nodes using compact text commands
FTP Server ? Standalone passive FTP daemon for QWK exchange and file-area transfers
QWK Offline Mail ? Download and upload QWK/QWKE packets for offline message reading in external readers
Gemini Capsule ? Gemini access method for lightweight capsule browsing

AI Providers and Usage ? AI provider setup, request accounting, and the admin usage dashboard
AI Assistant ? Reader-side helper that uses MCP-backed tool access to explain, summarize, and navigate message content
AI Bots ? Configuring AI chat bots, the middleware pipeline, writing custom middleware, and cost management
MCP Server ? AI and automation integration layer exposing selected platform capabilities to MCP-compatible clients
MCP Client Help ? Configure Claude, Anything LLM, OpenAI, and other MCP clients
Matterbridge ? Bidirectional bridge between local chat rooms and external platforms (Discord, Slack, IRC, etc.)

Doors Overview ? Overview of door types and how to install them
DOS Doors ? Running classic DOS door games
Native Doors ? Native Linux/Unix door games
PubTerm ? Built-in browser terminal door: setup, terminal size, guest access, and known limitations
WebDoors ? Browser-native door runtime that connects games and utilities to BinktermPHP users, sessions, and APIs
WebDoor Tutorial ? Step-by-step guide to building your first WebDoor
JS-DOS Doors ? Browser-side DOS game emulation via js-dos/DOSBox WASM
C64 Doors ? Commodore 64 door games
DOSBox Headless Mode ? Running DOSBox without a display for DOS doors

Local Chat ? Real-time room chat and direct messages: rooms, moderation, Matterbridge bridging, and AI bots
MRC Chat ? Multi-Relay Chat protocol integration
Shoutbox ? Public message wall: posting, moderation, and dashboard card
Bulletins ? Sysop notices shown at login and on demand: scheduling, display modes, and terminal rendering
Voting Booth ? User polls: creating, voting, results, and terminal access

Media in Messages ? Inline images, video, audio, platform embeds, retro audio, and text art in echomail and netmail
Message Sharing ? Public share links for echomail and netmail: token and friendly URLs, Open Graph preview images, AI summaries, referrer tracking
Markdown and Markup Formatting ? Markdown and StyleCodes compose editor, MARKUP kludge, LSC-001 reference, and rendering details
ANSI Support ? ANSI art rendering in messages and files
ANSI Ads Generator ? Generating ANSI-art advertisements
RIPScrip Support ? RIPscrip vector graphics rendering in echomail and file areas
Sixel Support ? DEC Sixel bitmap graphics in messages and file previews
Pipe Code Support ? BBS pipe color code rendering

Credit Economy Setup ? Sysop guide: designing a balanced credit economy, tuning rewards and costs, monetization considerations
Credit System ? User credit economy: earning, spending, and configuration
Interests ? Topic-based echo area groups users can subscribe to
Advertising ? Ad banners, Broadcast Manager, and display configuration
Weather Reports ? Automated weather report generation and echomail posting

Robots ? Echomail robot automation and response bots
Auto Feed ? RSS/Atom and Bluesky auto feeder: posts new items to echo areas on a cron schedule
File Area Rules ? Automated processing rules for incoming files
Anti-Virus ? File scanning integration for uploaded files

Docker ? Docker and docker-compose deployment
Performance Tuning ? php-fpm sizing, PostgreSQL tuning, BinkStream transport selection, opcache, and capacity planning
Customizing ? Themes, shells, and appearance customization
Localization ? Internationalization (i18n) and locale configuration
PWA and Service Worker Caching ? Installable PWA, asset caching, cache invalidation, and developer bump rules

Specifications published by the LovlyNet Standards Council.

LSC-001: MARKUP Kludge ? FTN kludge for inline markup and styling in echomail and netmail
LSC-002: FILEREF Kludge ? FTN kludge for file-referenced echomail threads

Architecture ? Ecosystem map showing how access methods, realtime delivery, FTN networking, doors, MCP, and AI fit together
Data Model ? Key database tables, their relationships, and conceptual model for developers
Developer Guide ? Coding conventions, database migrations, and project structure
PostgreSQL Dependency Inventory ? Living list of PostgreSQL-specific dependencies, code locations, and future compatibility notes
Terminal Server Developer Guide ? Shell abstraction, style profile, widget reference, handler patterns, and session internals for contributors
Configuration System ? How features read configuration at runtime: Config::env(), BbsConfig, AppearanceConfig, BinkpConfig, door configs, and per-user settings
Admin Daemon ? Wire protocol, command reference, and how to add new daemon commands
API Reference ? HTTP endpoint reference for the public API
BinkStream Back-Channel ? BinkStream shared realtime event infrastructure used by chat, notifications, doors, and live UI updates
Admin Terminal ? Floating xterm.js terminal for admins: live event stream, wall/msg commands, command history, and state persistence
Gateway Token Authentication ? Server-to-server token verification for remote door servers and third-party integrations
Contributing ? Git workflow, PR process, coding standards, and pre-commit checklist