====== The BBS list ======

A directory of ProBoard boards, in three parts that work together:

  - **BBSLIST.P3X**, the plug-in. Callers browse, search and download the list from a menu item. It reads only local files, so it never slows a caller down.
  - **PBDispatch**, the sync. **Tools > BBS List** downloads the published list, verifies it, writes the SyncTERM and PBTerm exports, and (optionally) checks your own board in with the list server.
  - **BBSListServer**, the web side (PHP and MySQL). Sysops register once, boards check in automatically, a moderator approves, and the server publishes static files that every board downloads.

The published files are plain static files at ''https://www.proboardbbs.com/bbslist/'': ''bbslist.json'' (the list), ''bbslist.json.sig'' (an optional signature), ''syncterm.lst'' (a SyncTERM address book), ''pbterm.json'' (a PBTerm phonebook) and ''index.html''. Only the check-in side needs PHP.

===== Running a list by hand =====

You can run a list with no server code at all:

<code>
PBRelease bbslist template --out mylist.json
PBRelease bbslist keygen
PBRelease bbslist build --source mylist.json --out upload
PBRelease bbslist verify --dir upload
</code>

The ''keygen'' step prints the ''listkey'' line for ''BBSLIST.CFG''. Upload the ''upload'' folder to ''/bbslist/''.

===== Your board's entry =====

Make ''Configs\BBSLIST.CFG'' (copy ''BBSLIST.CFG.SAMPLE'') with your board's name, sysop, location, country, description and an address. If you belong to PBLink as well, see [[v4:mail:pblink|PBLink]] for the ''synchours'' setting.

//The BBS list server setup is covered in more detail in the source documentation (''BBSList.txt''); a full page is being written.//