Welcome to x/84’s documentation!

Read the pdf version

Contents:

• Introduction
  • Quickstart
  • Documentation, Support, Issue Tracking
• Project Details
  • Compatible Clients
  • Binding to port 23
    • Linux
    • Solaris 10
    • BSD
    • Other
  • Other Telnet BBS Systems
    • How x/84 compares
  • History
  • What does x/84 mean?
  • Future Directions
• Running a message server
  • Configuring a hub
  • Configuring a leaf node
  • Authorship
• Doors
  • Dosemu
• Web server
  • Starting a web server
  • Lookup path
  • Serving static files
  • Writing a web module
    • The handler class
    • The REST API
    • Enabling the module
    • Testing the module
    • Take it further
• Developers
  • Requirements
    • Virtualenv
    • Install editable version
    • Starting x/84
    • As another user
    • x84 Usage
• Customizing your board
  • main(), gosub, and goto
  • Basic example
    • def main():
    • from x84.bbs import ...
    • echo(...)
    • term.bold_red(...)
    • term.inkey()
• Engine
  • x84.engine
  • x84.db
• Protocols
  • x84.server
  • x84.client
  • x84.telnet
  • x84.ssh
  • x84.rlogin
  • x84.sftp
  • x84.webserve
• Service Plugins
  • x84.fail2ban
  • x84.msgpoll
• Terminal I/O
  • x84.terminal
• Userland/scripting API
  • x84.bbs.door
  • x84.bbs.editor
  • x84.bbs.ini
  • x84.bbs.ipc
  • x84.bbs.lightbar
  • x84.bbs.output
  • x84.bbs.pager
  • x84.bbs.session
  • x84.bbs.userbase
  • x84.bbs.ansiwin
  • x84.bbs.dbproxy
  • x84.bbs.exception
  • x84.bbs.msgbase
  • x84.bbs.selector
  • x84.bbs.telnet

Indexes

• Index
• Module Index