CBM BBS Manual
The same topics are on the BBS itself under H (Help) on the main menu.
Welcome
This is a bulletin board system for Commodore computers: the C64, C128, VIC-20, Plus/4, PET, MEGA65 and the Amiga. PCs and modern terminals are welcome too.
Several people can be online at once. You can read and post messages, send private mail, swap files and chat with whoever else is on.
Getting around
Menus show a key in brackets, like [M] Message boards. Press that key; you don't need RETURN.
When a prompt asks you to type something, finish with RETURN. A blank answer usually means "cancel" or "keep what's there".
Long lists pause with -- More (Y/n) --. Press RETURN or Y to see more, N to stop.
Where next
- Connecting - ports, terminals and choosing your machine
- Keys on your machine - RETURN, DEL, RUN/STOP and friends
- Your account - signing up, passwords and settings
- Message boards, E-mail, File areas
- Chat rooms - talk live with whoever else is on
Connecting
Ask your sysop which ports this BBS uses. The usual ones are:
- Port 6400 - everything: telnet clients (SyncTERM, PuTTY, Amiga terminals), C64 WiFi modems, UltimateTerm and emulators. The BBS works out by itself whether your program speaks telnet.
- Port 6464 - raw TCP, a fallback for a terminal that the BBS mistakes for telnet
- SSH, port 2222 - encrypted logins; see below
- Web, port 8080 - the BBS in a browser; see Using the BBS in a web browser
- FTP - the file areas only; see FTP access
Press DEL
The first screen says PRESS DEL (BACKSPACE ON A PC). Press INST/DEL on a Commodore, or Backspace on a PC or an Amiga. The two keys send different codes, so this one keypress tells the BBS which kind of computer is calling. If you press RETURN instead, the BBS just asks again.
Choosing your machine
Log in first: until the BBS knows who you are it keeps the screen plain, with no colour or graphics, because it doesn't yet know what your computer can draw.
Your account remembers your machine, so you're only asked the first time, or if you call from a different kind of terminal than last time. The menu lists only the machines that fit your DEL key:
- Commodore 8-bits: 1 C64, 2 C128 40 columns, 3 C128 80 columns, 4 VIC-20, 5 Plus/4 or C16, 6 PET 40 columns, 7 PET 80 columns, 8 MEGA65. RETURN picks the C64.
- PC and Amiga: 1 Amiga, 2 PC ANSI, 3 UTF-8 terminal. The BBS guesses first from what your terminal reports; RETURN accepts the guess.
You can change it later under Settings, and the new choice is remembered.
Your choice decides the screen width (22 columns for a VIC-20, 40 for a C64, 80 for a C128 in 80-column mode, a PET 8032, a MEGA65 or an Amiga), the colors and the character set. You can change it later under Settings.
Commodore 8-bit callers
Use a terminal program that speaks PETSCII, such as CCGMS, Novaterm or StrikeTerm, or SyncTERM in one of its Commodore modes. With a WiFi modem, dial the BBS as usual, for example ATDT bbs.example.com:6400.
UltimateTerm (Ultimate 64, Commodore 64 Ultimate, 1541 Ultimate II+) works on port 6400. The BBS never opens with telnet codes, so UltimateTerm stays in its Commodore mode. If you see "(Telnet)" in green when you connect, you have dialed a different port or BBS that opened with telnet codes, and colors, case and DEL will come out wrong.
Amiga callers
NComm, Term, JR-Comm and similar terminals work over telnet. Press Backspace at the first screen, then pick 1 AMIGA from the machine menu. File transfers default to ZMODEM, which these terminals start by themselves.
SSH
ssh -p 2222 yourhandle@bbs.example.com logs straight in with your BBS password.
ssh -p 2222 new@bbs.example.com needs no password and takes you to the normal login screen, where you can sign up.
SSH only ever reaches the BBS: there's no shell behind it.
Using the BBS in a web browser
Open the BBS's web address, for example http://bbs.example.com:8080/, in any modern browser, on a computer, tablet or phone.
- Choose your Computer. The screen looks and behaves exactly as that machine's would: 40 columns for a C64, 22 for a VIC-20, 80 for an Amiga.
- Optionally choose a Modem speed, from full speed down to 300 baud, for the authentic crawl.
- Press Connect, then log in as usual.
It's the same BBS as telnet and SSH: the same account, messages, mail, files and chat, and you show up in Who's online like everyone else.
Keys
Type as normal. Backspace rubs out, Enter is RETURN, Esc or Ctrl-C is RUN/STOP. On a phone or tablet, tap the screen to bring up the keyboard. Paste works too.
Files
Downloads arrive as ordinary browser downloads. To upload, the BBS opens a small window where you choose a file from your computer. See File areas.
Bookmarks
You can bookmark a machine and connect straight away: add ?machine=vic20&connect=1 to the address. Machines are c64, c128, c128-80, vic20, plus4, pet40, pet80, mega65, amiga, pc and utf8. Add &baud=1200 for a modem speed.
The manual is on the web too, at /manual.
Plainhttp://sends your password unencrypted, as telnet does. If your sysop offershttps://, use that.
Keys on your machine
Commodore 8-bit
- RETURN - finish a line, choose the default
- INST/DEL - rub out the last character (also works when a WiFi modem or terminal program turns DEL into an ASCII backspace)
- RUN/STOP - stop a list, leave a prompt
- Cursor keys - move in the reader
- Shift + letter - a capital in lowercase mode, a graphics character in uppercase/graphics mode
Amiga, PC and modern terminals
- Enter - finish a line
- Backspace - rub out
- Esc or Ctrl-C - stop a list, leave a prompt
Upper and lower case
Commodores have two character sets. In mixed case you see "Hello"; in uppercase/graphics mode, "HELLO" plus the PETSCII graphics. Switch under Settings with U, or try both with Settings T, the charset test.
Passwords ignore case, so the same password works in either mode.
Your account and settings
Signing up
At Handle (or NEW), type NEW. Choose a handle of 2 to 20 characters: letters, digits, spaces and . - ! ' & + # $ @. Other characters can't be typed on every Commodore, so they aren't allowed.
Then choose a password of at least six characters, type it twice, and give your name and city.
Passwords
Upper and lower case count as the same, because a Commodore types different letters in its two character sets.
Three wrong passwords end the call. After several wrong passwords in a row the account locks for a while, even if the next try is right. The sysop can unlock it.
Access levels
- 10 New user - can read; waits for the sysop to validate you
- 20 User - can post and upload
- 100 Co-sysop - can delete other people's messages and files
- 255 Sysop - runs the place
Settings
Press S on the main menu:
- M Machine - change your computer type
- U Case - mixed case or uppercase/graphics (Commodore 8-bit)
- P Pager - pause long lists at each screenful
- X Transfers - your preferred transfer protocol
- W Password - change it
- R / F - your real name and city
- T Charset test - every color and graphics character on your machine
- Y Style - CBM menus, or typed commands in the Image BBS style
Your settings are saved and applied the next time you call.
The Image BBS style
In the Image style you type commands at a prompt and press RETURN, as on an Image BBS. To try it, choose Y Style under Settings; to go back, type EP, then P, and change Board Style. Your choice is remembered.
Logging in
On a board that uses the Image style, the Login Options Menu comes first:
- RETURN - log in: type your handle or your ID# (the number the BBS tells you), then your password
!- hang up*- choose your computer type now (the BBS remembers it)M- Mail-Check: see whether someone has mail waitingX- XPress Login: skip the greeting and status screens
Type NEW at the handle prompt to apply, or HELP for a reminder. A handle the BBS doesn't know can become your new account straight away.
The main prompt
Before each prompt you see the time, and the minutes left if the sysop limits calls:
- 9:41 PM - 57 Min Left CBM BBS: _
Type ? (or just RETURN) for the list of commands. Unknown commands get Unknown Command. Enter "?" For Help.
SBmessage bases,EMe-mail,UDfile libraries,TCchat rooms,NFnews,VBvoting booth,ULuser listFfeedback to the sysop,Cpage the sysop,WOwho's online,NXsend a node message,Hhelp topicsBAboard activity,LGtoday's call log (if your group may),SYa saying,TTthe top tenTthe time,STyour status,CFabout this BBS,NUnew-user informationLDchange the date "new" messages and files count fromATchange your computer typeEPedit your information (I) or parameters (P)XPexpert mode: no menu before each promptPMprompt mode: the prompts between messages when readingMPthe "More?" prompt: off, on, or only while reading messagesMXyour four macros,PSyour ten signaturesO,Qlog off;O%,O!,O%!(below)
Message bases
SB lists the SIGs (groups of boards) if there is more than one, then the boards; pick one by number. SB2 opens SIG 2 and SB1,3 board 3 of SIG 1. The prompt becomes Sub#1: General:.
A board holds bulletins, each followed by numbered responses. In a scan, *NEW* marks a bulletin posted since your scan date (normally your last call), *NRB* an older bulletin with new responses, and *FZN* a frozen one that takes no more responses. What you read stays new until you log off and update your scan date (or use LD).
SorS5- scan titles (from bulletin 5);SNnew ones here;SAnew ones on every boardR5- read bulletin 5 and its responses;Rthe next one;RNthe new ones here;RAthe new ones on every boardA5- about bulletin 5: its header, thenNext,Last,Read orMail the posterP- post a bulletin. You can file it anonymously: only the sysop sees who wrote itE5,K5- edit or kill your own bulletinL- list the boards; a number,<or>moves to another;Nits name;Vits SubOp;Mmail the SubOp;SGchange SIGQ- back to the main prompt. Main-level commands (T,EM,O...) work here too
At End Of Bulletin. Command?: press RETURN to go on, or R to respond, P to answer the poster by e-mail (P2 responder 2), O to read it again, 2 to read from response 2, N for its new responses, Q to stop. With prompt mode off (PM), RN and RA don't stop between bulletins. Bulletins and responses earn credits, shown after you file them.
File libraries
UD lists the libraries (our file areas and their sections) and asks Which U/D?; UD3 goes straight to library 3. The prompt becomes U/D#3: Games:.
SorS5- scan the files (from file 5): number, name, type, size in blocks and description;*marks a file new since your scan date.SSis sorted by name,SNthe new ones here,SAthe new ones in every libraryA5- about file 5 (a disk image shows its directory);R5reads a text fileD5downloads file 5,DMseveral (e.g.1,3,5); you're asked Logoff After Transfer? first.U(orUM) uploadsPRchanges your protocol;E5andK5change or remove a file you uploadedL, a number,<and>move between libraries;Qgoes back
The sysop may charge credits for downloads and give credits for uploads.
EM counts your letters and opens the E-Mail: prompt.
- RETURN reads the next letter;
5reads letter 5, then [A]gain, [F]orward, [R]eply?;Areads them all (any key goes on, Q stops);Llists them;RorR5replies Ssends: who to, a subject, an optional Carbon Copy to one more person, the letter, and a Return Receipt if you'd like to know when it is read (it comes back as mail)Vshows how many letters someone has and which are from you;VEalso lets you read, edit or delete each one you sent (*= not read yet)Ddeletes all, some (by number) or none; leaving with letters in the box asks the sameQgoes back to the main prompt
After you log in
The sysop picks what runs after you log in: usually the last callers and what they did, your status and the mail check; perhaps also new system news, the voting booth, scans for new bulletins and new files, or a saying. XPress Login skips all but the mail check.
The sysop, the news and the vote
Fwrites to the sysop; the logoff question Leave Feedback? does the sameCpages the sysop: give a reason. If the sysop is on, you both meet in a chat room of your own; if not, you can leave feedback insteadNFlists the news (*= new since your last call); type a number to read oneVBlists the vote topics (*= you haven't voted); pick one, vote, and see the results so far. You can change your voteULlists the users, fast (ID# and handle) or with details (last call, computer, city); e-mail addresses are never shown
Your access group
Your access group decides how many calls you get a day ("You are allowed 2 more calls today."), how long each lasts (the minutes left in the time line), how long you may sit idle (a bell rings 30 seconds before the BBS hangs up), how many lines a message may have, how many files you may download per call, and what you may do. Something your group can't do is answered Sorry, not cleared for that function. A call over the day's limit is refused. ST shows your group.
Bulletins earn credits, multiplied by your group's credit ratio; the sysop may charge credits for some commands (Not Enough Credits!).
New callers fill in Image's four-part application: the handle and a password (typed or generated), e-mail address and name; the computer and terminal settings; the sysop's questions; and a statement for the sysop. Write down your ID# and password. The sysop then decides your access group.
The editor
In the Image style the message editor works like Image's. Type your text and let the lines wrap; RETURN ends a paragraph. Type . (or /) at the start of a line for Editor Command:, then one key. Commands marked * then take a range of lines: 5, 2-4 (or 2,4), 3-, -3, or RETURN for the usual default.
.Ssave,.Aabort (no questions),.Hor.?help,.Qlines used and left.L* list with line numbers,.R* read,.M* read (MCI codes come later).D* delete (default: the last line),.E* edit each line (RETURN keeps it),.I* insert lines in front of a line until an empty one (default: line 1).F* find,.K* search and replace,.Y* move and.Z* copy to another line.J* justify: C center, R right, L left, E expand, P packed, I indent, U un-indent.Bbanner (big block letters),.Cline length,.Oline numbers while typing,.Nstart over,.Ttext transfer (no echo, for pasting),.Uadd one of your signatures (PSat the prompt),.Vversion,.#a column scale
If your access group allows MCI codes, £C2 (a \ on a PC) and the other color codes color your text for readers, and .M shows it that way while you write. When the last allowed line is filled the editor goes to Editor Command: by itself. How long a message may be depends on your access group.
Stacking, history and macros
- Put several commands on one line with
^between them:T^ST(on a Commodore, the up-arrow key) ^?lists your last ten commands,^0(newest) to^9;^0-^9runs one again, and^^repeats the lastMXstores up to four command lines; type1,2,3or4to run one. Enter-to clear a macro
Logging off
Oasks Logoff?, then Update Message/File Scan Date? (answer No to keep everything you read this call marked new for next time), then Leave Feedback? to write to the sysopO%logs off without updating the scan date;O!logs off at once, no questions;O%!does both
Message boards
Press M on the main menu. You'll see each area with its new and total message counts. Type an area's number, or N to read everything new in every area.
In an area
- R Read new messages
- A Read all, from any message number
- S Scan subjects, then read one
- P Post a message
Some areas are read-only; Announcements is for the sysop.
Reading
After each message:
- N or RETURN - next
- P - previous
- R - reply in public, optionally quoting
- M - reply by private mail
- T - read the whole thread
- D - delete (your own messages)
- Q - quit
Messages reflow to your screen: one written on a VIC-20 fills a C64's full 40 columns, and a C64 message wraps neatly on a VIC-20.
The BBS remembers what you've read. Your own posts never count as new.
See The message editor for writing.
The message editor
Just type. When a word won't fit on the line, the editor moves it down for you, so keep going and press RETURN only to end a paragraph. A blank line leaves a gap between paragraphs.
Commands go at the start of an empty line (in the Image BBS style the editor has Image's dot commands instead):
/S- save and send/A- abort (asks first)/L- list your message with line numbers/D 3- delete line 3 (/Dalone: the last line)/E 3- retype line 3/I 3- insert a line before line 3/C- clear everything and start again/H- show these commands
When you reply you can quote the original. Quoted lines start with >.
Press E on the main menu.
- R Read mail - your inbox; unread mail has a
* - S Send mail - type the handle, a subject, then your message
If the person you're writing to is online, they're told right away. When you log on, the greeting says how much new mail you have.
You can also answer a public message privately with M in the message reader.
File areas
Press F on the main menu. Each area shows its file count and how many files are new since your last look. N lists every new file.
An area may be split into sections, shown indented beneath it, such as Games and Demos under Commodore 64. The files are in the sections, so those are the ones with numbers; the area above them shows the totals for all its sections.
In an area
- L List files, with type, size in blocks and description. The type is the Commodore one (PRG, SEQ, USR, REL, D64, D71, D81); anything else shows its own extension, such as PDF or ZIP, or
???if it has none. A long description wraps within its own column, under itself, rather than under the file name; on narrow screens it sits indented under the file - I File info - details, a PRG's load address, a disk image's directory
- D Download
- U Upload
Sizes are in 254-byte blocks, as a Commodore directory shows them.
Downloading
Give a file number. For several at once, list them: 1,3 or 2-5. Several files need a batch protocol: Multi-Punter, YMODEM or ZMODEM.
Pick a protocol, then start the download in your terminal when the BBS says so. In a web browser there's nothing to pick: the file arrives as a normal browser download.
Uploading
Choose a protocol and start sending. Punter sends the file type for you; with XMODEM the BBS asks for a name and a type. Batch protocols send names too. In a web browser, choose the file in the window that opens. Then give each file a short description.
Ratios
Some BBSes limit downloads until you upload. If so, the file area list shows how many downloads you have left.
See also Disk images.
Disk images
A disk image is a whole floppy in one file: D64 for a 1541, D71 for a 1571, D81 for a 1581.
Use I File info on an image to see its directory, just as LOAD"$",8 would show it, with blocks free at the bottom.
From there:
- D downloads the whole image
- X downloads a single file from inside it, as a normal PRG or SEQ
That's handy when you only want one program from a big collection disk.
Transfer protocols
Your terminal and the BBS must use the same protocol. The BBS remembers your last choice. (In a web browser none of this applies: files move as ordinary browser downloads and uploads.)
- P Punter - the C64 standard (CCGMS, Novaterm, most C64 terminals). Keeps the exact length and the file type. The default for Commodore 8-bits.
- M Multi-Punter - several files at once, with their names. In CCGMS use Multi-Receive or Multi-Send.
- X XMODEM - understood almost everywhere. Pads the last block, so a file may grow by a few bytes.
- K XMODEM-1K - XMODEM with bigger blocks.
- Y YMODEM - batches with names and exact sizes.
- Z ZMODEM - fast, recovers from errors and can resume a broken download. Amiga terminals, SyncTERM and modern terminals start it by themselves. The default for ANSI terminals.
Tips
For Multi-Punter downloads, start Multi-Receive in your terminal; the BBS keeps repeating the file header until you do.
To cancel, press Ctrl-X a few times, or use your terminal's abort key.
Transfers need an 8-bit clean connection. Telnet clients must be in binary mode; the BBS warns you if yours isn't.
Watching progress
Before a download the BBS says how much is coming, and when a transfer ends it shows the size, how long it took and the speed in characters per second.
While a transfer runs, nothing can appear on your screen: the line is carrying the file, and anything else would corrupt it. Your terminal program's own block counter is the live display. The sysop can watch from the other side, where the node monitor and Who's Online show a progress bar and speed.
FTP access
The file areas can also be reached with any FTP client, using your BBS handle and password. Ask your sysop for the port; 21 is the standard one.
Each file area is a folder, such as /c64 or /images. An area split into sections holds a folder per section, so files sit one level deeper, at /c64/games. Files are named with their type, for example Boulder Dash.prg.
- Download and upload as with any FTP site; the same access levels and ratios apply
- You can delete your own uploads
- Interrupted downloads can be resumed
Plain FTP sends your password unencrypted. Use SSH or telnet on the BBS if that worries you.
Some BBSes allow read-only anonymous logins as well.
Chat rooms
Press C on the main menu. You arrive in the first room (usually Main) and see who's there. Everyone in the room sees what you type, as soon as you press RETURN.
Other people's lines appear while you type. If you're halfway through a line, the BBS moves it out of the way and puts it back, so just keep typing.
Commands
Commands start with /:
/who- who's in this room/rooms- every room and how many are in it/join name- go to another room, or open a new one/me waves- an action:* Bob waves/msg handle text- whisper to one person/topic text- set the room's topic/?- list the commands/q- leave chat (or RUN/STOP or Esc on an empty line)
A room you open disappears when the last person leaves. The permanent rooms' topics are set by the sysop.
If you /msg someone who's online but not in chat, it reaches them as a node message. See Who's online and node messages.
Who's online and node messages
Every caller has a node number.
- W Who's online - every node, with handle, machine and what they're doing
- L Last callers - who called recently
- N Node message - send a line to one node, or to everyone with node 0
- C Chat rooms - talk live; see Chat rooms
Messages from other nodes appear when you're at a prompt, so they never interrupt your typing.
You'll also see a note when someone logs on or off.
A caller moving a file shows an extra line with the file, how far it has got and the speed.
Sysop quick start
Sysop guide
The BBS is one program, cbmbbs, plus a folder of data. This guide assumes it lives in /srv/cbmbbs.
Build
make build # makes bin/cbmbbs make test # optional: the test suite
Configure
bin/cbmbbs config > cbmbbs.toml
Edit the BBS name, your sysop handle and the ports. See Configuration.
Run as a service
The BBS runs as its own unprivileged cbmbbs account under systemd:
useradd --system --home-dir /srv/cbmbbs \ --shell /usr/sbin/nologin cbmbbs mkdir -p data && chown -R cbmbbs data cp deploy/cbmbbs.service /etc/systemd/system/ cp deploy/logrotate.conf \ /etc/logrotate.d/cbmbbs systemctl daemon-reload systemctl enable --now cbmbbs
After changing the program or cbmbbs.toml: make build && systemctl restart cbmbbs.
Your sysop account
The account named sysop in cbmbbs.toml is created automatically at level 255, with no password: it can log in locally but not remotely. Give it a password:
bin/cbmbbs user passwd YOURHANDLE
Ports to forward
Behind a router, forward these TCP ports to the BBS machine (defaults shown):
- 6400 the main port: telnet, WiFi modems, UltimateTerm
- 6464 raw TCP fallback (optional)
- 2222 SSH
- 8080 web
- 21 or 2121 FTP, plus the passive range 50000-50019
Set public_host under [ftp] to your public host name so passive FTP works through NAT.
Configuration
Sysop guide
cbmbbs.toml sits next to the program. bin/cbmbbs config prints a commented copy with every default. A missing file means "all defaults". Restart the BBS after editing.
[bbs]
name- shown on screens and menussysop- handle of the sysop account (created automatically at level 255)time_zone- the clock callers see, e.g."America/New_York"; empty means the system's. Logs keep the system's timestyle-"cbm"(hotkey menus, the default) or"image"(typed commands at a prompt, like Image BBS; see The Image BBS style). It sets the login screens and every caller's default; each caller can pick the other style for themselves under Settings (Y) or EP.
[image]
Settings for the Image style, used when style = "image" and by callers who choose it.
main_prompt- the main prompt, shown asTEXT:; empty means the BBS name in capitalssecond_check- after the password, also ask for the first or last word of the caller's real name (accounts without one are not asked)mail_check- offer M at the Login Options Menu: anyone may ask whether a user has mail waitingexpress- offer X (XPress Login) at the Login Options Menu, which skips the greeting and status screensnew_user_credits- credits a new account starts with (default 100)post_credits,response_credits- credits earned by a bulletin (default 2) and by a response (default 0)prime_time,prime_minutes- busy hours, e.g."18:00-22:00", and the longest call then (0 = no cap). Groups without U/D At Prime Time can't use the file libraries thenquestions- Part III of the new-user application; the answers go to you with the application (VF). If the first question asks for a city, it becomes the account's "From"download_credits,upload_credits- credits a download costs and an upload earns (times the group's ratio) in the Image-style file libraries; 0 = nonelogon- the logon modules, in order, e.g.["lastcallers", "news", "vote?", "status", "mail"]; a?asks the caller first. Modules:lastcallers,status,mail,news,vote,scan(new bulletins),uploads(new files),saying. The default is the stock Image sequence: last callers, status, mail[image.strings]- your own wording for the Image style's best-known lines; keys:login_ok,not_valid,unknown,not_cleared,time_up,call_limit,no_mail,credits,logoff,update_scan,feedback,bye,menu_title(with%sfor the BBS name),status_title[image.costs]- credits a command costs, e.g.TC = 5; a caller without enough is told "Not Enough Credits!"
Everything else about a caller's limits comes from their access group (see Managing users): minutes per call, calls per day, idle minutes, editor lines, downloads per call, the credit ratio, and whether they may post, use the file libraries, or e-mail anyone but you.
[network]
telnet- the main port, default:6400; empty turns it off. It serves telnet and raw callers alike: the BBS sends no telnet codes until the caller either negotiates by itself or answers one telnet question after pressing DEL. A caller that doesn't answer within 1.5 seconds is served as raw 8-bit TCP, andcallers.logshows it asraw tcp.raw- raw 8-bit TCP only, default:6464; a fallback for terminals the main port misjudges. Empty turns it off
[nodes]
max- how many callers at once (default 8)idle_timeout- hang up after this long without a key, e.g."10m"
[paths]
data- database, logs, SSH keys, local-console socketscreens- your screen overrides (see Custom screens)help- your own help topics (see Writing help topics)files- where file areas keep files; empty meansdata/files
[users]
allow_new- accept new-user applicationsnew_user_level- 10 needs your validation, 20 is validated straight awaymin_password- shortest password allowedattempts_per_call- wrong passwords before hanging uplockout_after,lockout_duration- lock an account after that many wrong passwords in a row, for that long
[web]
listen- web address, default:8080; empty turns the web terminal offtls_cert,tls_key- certificate and key files to serve HTTPS instead of HTTP
The web terminal also serves the manual at /manual. For HTTPS without managing certificates, you can instead put the BBS behind a reverse proxy such as Caddy or nginx; WebSockets must be passed through.
[ssh]
listen- SSH address, default:2222guest_users- names that log in without a password and land on the login screen
[ftp]
listen- FTP address;":21"is standard, empty turns FTP offpublic_host- host name or IP given to passive-mode clients, needed behind NATpassive_ports- e.g."50000-50019"; forward these tooanonymous,anonymous_level- optional read-only anonymous accessmax_clients- FTP connections at once
[chat]
rooms- the permanent chat rooms, e.g.["Main", "Commodore", "Amiga"]. Callers land in the first. Only co-sysops and the sysop can set their topics; rooms callers open themselves vanish when empty.
[files]
max_upload_kb- largest upload acceptedratio- downloads allowed per upload; 0 means no ratiofree_downloads- downloads before the ratio applies
Command-line flags such as -name, -telnet, -raw, -data and -nodes override the file.
Managing users
Sysop guide
On the BBS
Sysops see ! Sysop menu on the main menu:
- N Node monitor - who is online, redrawn every second, with a progress bar for any transfer running
- U User list
- E Edit user - level, password, unlock, disable or enable, delete
- G Access groups - the Image-style rules (below)
- K Kick node - disconnect a caller, with a message
- B Broadcast - a message to every node
Disabling or deleting someone who is online disconnects them.
From the shell
These work while the BBS is running. Run them from /srv/cbmbbs; run as root, they switch to the BBS account by themselves.
bin/cbmbbs user list bin/cbmbbs user add HANDLE [LEVEL] bin/cbmbbs user passwd HANDLE bin/cbmbbs user level HANDLE 100 bin/cbmbbs user unlock HANDLE bin/cbmbbs user disable HANDLE bin/cbmbbs user enable HANDLE bin/cbmbbs user delete HANDLE
Levels
- 0 locked out
- 10 new user: reads, can't post or upload
- 20 user
- 100 co-sysop: deletes any message or file
- 255 sysop
Area access is set per area; see Message and file areas.
Access groups (Image style)
Callers who use the Image BBS style follow their access group, 0-9, as on Image. Each group has a name, the access level its members get, and Image's 20 flags: credit ratio, post/respond, U/D access, editor lines ((n+1)x10), unlimited downloads, remote maintenance (may use VF), e-mail to others, user list, SubOp everywhere, U/D at prime time, idle minutes, calls per day, minutes per call and downloads per call. Edit them under sysop menu G (or IM, then G).
The groups start as: 0 New Users (a stock Image new user: no posting or e-mail to others, one 15-minute call a day, 2 idle minutes, 20 editor lines), 1-7 Users (post, e-mail, user list, 9 calls of 60 minutes, 5 idle minutes), 8 Co-Sysops and 9 Sysop (no limits). Setting a level puts the user in that level's group (255 → 9, 100 → 8, 20 → 1, 10 → 0); putting them in a group gives them its level.
A new caller's application (handle, password, e-mail, name, computer, your questions, a statement) waits for you under VF at the main prompt: A puts them in a group and can mail them a welcome, N leaves them as they are, D deletes the account. New accounts get new_user_level and its group.
Feedback, news, the vote and sayings (Image style)
VFat the main prompt shows 1 new-user applications and 2 feedback (letters callers wrote withFor at logoff; they also arrive in your e-mail): R replies, D deletes, N goes onNF: A adds a news item (title and text), K removes one. New items show at logon iflogonhasnewsVB: A adds a vote (a question and up to nine choices), K removes one with its resultsSYsayings: put your own insayings.txtin the screens folder, one a line (#for comments); otherwise the BBS uses its ownC: a page shows on your node as a message with the caller's reason; typeTC, then/join Page-Nto talk
Message and file areas
Sysop guide
Message areas
Sysop menu A. Each area has a name, a description, a read level, a write level and a sort order. The starter areas are General, Commodore 8-Bit, Amiga, Buy Sell Trade and Announcements (write level 255, so only you post there).
Deleting an area deletes its messages.
Two settings matter for the Image BBS style:
- SIG - the group the area belongs to. Areas with the same SIG are listed together under
SB; with more than one SIG, callers pick a SIG first. Empty means the main SIG. - SubOp - a user who looks after the area: they can freeze, edit and kill its bulletins (co-sysops and you always can).
-means you.
File areas
Sysop menu F. Each area has a name, a description, a folder, a list/download level, an upload level and a sort order. The folder is fixed when the area is created.
Deleting a file area keeps its files on disk.
Sections
S adds a section to an area, one level deep: Commodore 64 can hold Games, Demos and Utilities. Files live in sections only, so when you give an area its first section, the files already in it move into a section of their own; the BBS asks what to call it (Misc by default) and moves them on disk too.
A section's folder sits inside its area's, for example c64/games, which is also its FTP path. Section names only have to be unique within their area, so several areas can each have a Games. On the command line a section is written "Commodore 64/Games", or by its folder, c64/games.
Callers see sections indented under their area, and only sections are numbered, since that is where the files are. Deleting an area deletes its sections.
Importing files
Add files from the shell, straight from your own folders:
bin/cbmbbs files areas bin/cbmbbs files import "Commodore 64" \ ~/games/*.prg -desc "Classics" bin/cbmbbs files import images ~/disks/*.d64 bin/cbmbbs files list c64 bin/cbmbbs files dir ~/disks/demo.d64
An area can be named by its title or its folder. .P00 containers are unwrapped. Duplicate names get " (2)".
Custom screens
Sysop guide
Files in the screens folder replace the built-in screens. For a screen called welcome, shown to machine ID at width W, the BBS uses the first of these that exists:
welcome.c64.seq(and other machine IDs) - native PETSCII, sent byte for bytewelcome.40.seq,welcome.22.seq,welcome.80.seq- native PETSCII for a widthwelcome.amiga.ans- Amiga ANSI (ISO-8859-1)welcome.pc.ansorwelcome.ans- PC ANSI (CP437); UTF-8 callers get it convertedwelcome.ID.txt- markup for one machinewelcome.W.txt- markup for a widthwelcome.txt- markup for everyone
Screens used today: welcome (before login), newuser (top of the application) and goodbye. Machine IDs are listed by bin/cbmbbs machines.
Markup
UTF-8 text with tags in braces, converted for each machine:
- Colors:
{black} {white} {red} {cyan} {purple} {green} {blue} {yellow} {orange} {brown} {lred} {dgray} {gray} {lgreen} {lblue} {lgray} {rvs}and{/rvs}reverse video,{reset},{clr},{home}{gfx}(also{upper}) switches a Commodore to the uppercase/graphics character set, where PETSCII keeps its nicest shapes:╭╮╰╯ ╱╲ ╳ ● ○ ◤◥◣◢ ♠♥♣♦ π. Letters come out as capitals, and the switch repaints the whole screen, so put it straight after{clr}.{text}(also{lower}) switches back. Other terminals ignore both{hr}a line to the edge of the screen{bbs} {sysop} {node} {nodes} {handle} {machine} {via} {date}{{for a literal brace
Line and block graphics such as ┌─┐ │ ▀▄█ ▒, the quarter and eighth blocks (▖▗▘▝ ▁▂▃ ▏▎▍) and ▚▞ work in both Commodore character sets and on ANSI terminals. A line that exactly fills a Commodore screen is fine: the BBS knows it wraps by itself.
Try a screen as any machine with local mode.
Image BBS screens
If you ran Image BBS, copy its screen files into the screens folder under their Image names and the Image style uses them: s.login 1, s.login 2 80, s.end 1, s.config and so on (s.<name> <mode>, mode 0 ASCII, 1 Commodore graphics, 2 ANSI, 80 for 80 columns; or s.<name> for everyone). Case doesn't matter, and a .seq or .prg ending is fine, so files straight off a disk image work. They are drawn for every caller from the same PETSCII: a C/G file looks right on an ANSI terminal too, and the BBS picks the caller's own mode first. They need 40 columns, so a VIC-20 gets the BBS's own screens.
Screens the Image style looks for: login (before the Login Options Menu), detect (after detection), welcome (after logon), end (logoff), idle, logon help, config (CF), new user (NU), SB, EM and UD (entering them), and the ? menus menu 1 (main), menu 2 (message bases), menu 3 (editor help), menu 5 (U/D) and menu 6 (e-mail).
MCI codes
Image screens use MCI commands after a £ (a \ on PC keyboards). The BBS understands:
£Cncolor (1 white, 2 red, 3 cyan, 4 purple, 5 green, 6 blue, 7 yellow, 8 orange, 9 brown, J pink, K-L-O grays, M light green, N light blue),£Rnreverse off/on,£Knrainbow letters (0 off),£Unthe graphics set,£Qreset£Vnvariables: 0 date and time, 1 your last call, 2 handle, 3 real name, 5 BBS name, 6 caller number (or board number), 7 the last input, 8 board name, 9 the last caller, J a line across the screen, L protocol, M access group, O ID#£_nntab to column nn,£Nnn new lines,£Octhe character c 19 times,£Bnbells,£Hnbackspaces,£F1clear,£Wna pause (up to 5 s),£Gnwait for a key,£Inread a line- tests and jumps:
£AnTEXT£(is variable n TEXT?),£T1TEXT£(was the last input TEXT?),£T2n(is the caller's access group at least n?), then£Dnskips n lines if the test failed,£Enif it passed;£Jnskips n lines;£Xstops - the function-key characters Image files use for punctuation, and PETSCII color and reverse codes
Printer, print-speed and cursor-dancing codes are read and ignored. In messages, only the color, reverse, rainbow and graphics codes work, and only from callers whose access group has MCI Access (and you).
Writing help topics
Sysop guide
Each help topic is a Markdown file. The built-in ones are in docs/help in the source. Your own go in the help folder next to the program (paths.help): a file with the same name as a built-in topic replaces it, and a new name adds a topic. Restart the BBS to pick up changes.
Front matter
--- title: House rules summary: What's allowed here order: 15 level: 0 ---
order sorts the index. level is the lowest access level that sees the topic; use 255 for sysop-only pages.
What you can write
#,##,###headings- paragraphs, separated by a blank line
-bullet lists and1.numbered lists- fenced code blocks, for commands
>notes- inline
code, bold, and links:[text](topic:files)to another topic, or a web address
Keep paragraphs short and code lines under about 38 characters, so pages read well on a 40-column C64. Text wraps on a 22-column VIC-20 by itself.
The offline manual
The same topics make docs/MANUAL.md and docs/manual.html. After editing the built-in topics, regenerate them:
make docs
The tests fail if they're out of date, or if a topic links to one that doesn't exist.
Local mode and the emulator
Sysop guide
Log in at the console, as the sysop, through an emulation of any machine:
bin/cbmbbs local -machine c64 bin/cbmbbs local -machine vic20 -baud 1200
If the BBS is running, local mode joins it on its own node. Otherwise it starts the BBS for you. Ctrl-] hangs up.
The emulator shows the machine's real limits: screen size, palette, both character sets, the Commodore screen editor's line wrapping and the keyboard. -baud slows output to modem speed. -upper starts in uppercase/graphics mode. -plain-glyphs helps if your font lacks the PETSCII graphics symbols.
bin/cbmbbs machines lists the machine IDs: c64, c128, c128-80, vic20, plus4, pet40, pet80, mega65, amiga, pc, utf8.
The same emulator can call any BBS:
bin/cbmbbs term -machine c64 host:6464
Logs and backups
Sysop guide
Logs
In data/logs:
system.log- starts, stops, connections, logins, errorscallers.log- one line per call: node, handle, machine, how they connected, how longtransfers.log- every upload and download, with protocol, size, speed and resultsecurity.log- failed logins, lockouts, new users, sysop actions
deploy/logrotate.conf rotates them weekly. journalctl -u cbmbbs shows the service's own output.
Backups
Everything worth keeping is in:
data/- database (cbmbbs.db), files, SSH host keys, logscbmbbs.tomlscreens/andhelp/, if you've customised them
The simplest safe backup stops the BBS for a moment:
systemctl stop cbmbbs tar czf bbs-backup.tgz data cbmbbs.toml \ screens help systemctl start cbmbbs
Keep the SSH host keys in your backups, or callers will see a "host key changed" warning after a restore.
Security
Sysop guide
- The BBS runs as an unprivileged
cbmbbsaccount; its files aren't readable by other accounts. - Passwords are stored as bcrypt hashes. They're case-insensitive because of Commodore keyboards, so the minimum length matters.
- Telnet, SSH and FTP share one lockout: guessing on any of them locks the account everywhere. Every failure is in
security.log. - SSH reaches only the BBS: no shell, commands, SFTP or port forwarding.
- FTP shows only the file areas. Its data connections can only go back to the client, so it can't be used to attack other machines.
- Uploads are size-limited and stored under safe names inside their area's folder.
- ZMODEM remote commands are refused.
- The web terminal only talks to its own page (same-origin WebSockets, a strict content security policy, no framing). Web downloads and uploads use single-use links that expire after a few minutes, and uploads are size-limited.
- The local-console socket is only reachable by the BBS account (and root).
Telnet, FTP and plain-HTTP web access are unencrypted, as they always were. Callers who care can use SSH, or HTTPS if you configure it.
Running on a Raspberry Pi
Sysop guide
The BBS runs well on a Raspberry Pi Zero 2 W: it's one program of about 10 MB with nothing else to install, and uses around 15 MB of memory.
Build on another computer
Use 64-bit Raspberry Pi OS Lite if you can:
GOOS=linux GOARCH=arm64 \ go build -o cbmbbs-pi ./cmd/cbmbbs
For 32-bit Raspberry Pi OS use GOARCH=arm GOARM=7.
Install
Copy the program to /srv/cbmbbs/bin/cbmbbs on the Pi, with cbmbbs.toml, screens/, help/ and deploy/. Then follow Sysop quick start from "Run as a service". To move an existing BBS, stop it and copy data/ across as well.
Tips
- Logins take a moment longer on a Pi; that's the password hashing working.
- Use a good SD card and back up
data/often. - A wired network (USB Ethernet) is steadier than Wi-Fi for a server.