urit/README.md
2026-05-02 21:11:50 -04:00

1.6 KiB

URIT BBS

A modern bulletin board system inspired by T.A.G.-BBS (1986), written in Go.

Features

  • Telnet and SSH access
  • Multi-user support
  • Message boards with security-based access control
  • Private mail
  • File libraries
  • ANSI terminal support
  • SQLite storage (zero-configuration)
  • Cross-platform: runs on x86, ARM64 (Raspberry Pi), and more

Building

Requires Go 1.22 or later.

go build -o urit ./cmd/urit/

Cross-compile for Raspberry Pi

GOOS=linux GOARCH=arm64 go build -o urit ./cmd/urit/

Quick Start

Initialize a new BBS instance:

./urit init

This creates the database, a sysop account, starter boards, a welcome bulletin, an empty file library, and sample ANSI screen files. It's the modern equivalent of the original TAG-BBS's GENERATE program.

Start the server:

./urit

Connect with any telnet client:

telnet localhost 2323

Usage

./urit              # Start the BBS server (default config: config.toml)
./urit -config PATH # Start with a specific config file
./urit init         # Initialize a new BBS instance
./urit init -force  # Re-initialize, overwriting existing database
./urit version      # Print version and exit
./urit help         # Show help

Configuration

See config.toml for all available settings. Running urit init will create a default config file if one doesn't exist.

Project Status

Under active development.

License

This project is released into the public domain. See LICENSE for details.

Credits

See CREDITS.md for acknowledgments.