====== Command reference ======

===== doorhub (the hub) =====

<code>
doorhub [-d folder] <command> ...
</code>

The folder is ''-d folder'', or the ''DOORHUB_DIR'' environment variable, or ''/opt/doorhub'' (Linux) / ''C:\doorhub'' (Windows).

==== Server ====

^ Command ^ What it does ^
| ''init'' | Make ''hub.json'' and the host key in the folder; prints the key fingerprint. Refuses if ''hub.json'' exists. |
| ''serve'' | Run the hub. |
| ''service install'' | Windows: install the "Door Hub" service for this folder (Administrator). |
| ''service start'' / ''stop'' / ''remove'' | Windows: manage the service. |
| ''settings'' | Show the settings. |
| ''set <name> <value>'' | Change a setting. See [[doorhub:settings|Settings]]. |
| ''version'' | Show the version. |
| ''help'' | Show the command list. |

==== Member BBSes ====

^ Command ^ What it does ^
| ''bbs add <TAG> "<name>" [--user <u>] [--contact "<c>"]'' | Add a BBS; prints its connector ini and password (once). |
| ''bbs list'' | List members. |
| ''bbs show <TAG>'' | Details of one member. |
| ''bbs passwd <TAG>'' | New password; prints a new ini. |
| ''bbs enable <TAG>'' / ''bbs disable <TAG>'' | Allow or block a member. |
| ''bbs note <TAG> "<text>"'' | Set notes. |
| ''bbs remove <TAG>'' | Delete a member (players are kept). |

See [[doorhub:member_bbses|Member BBSes]].

==== Games ====

^ Command ^ What it does ^
| ''door add <code> <INTERNAL> "<name>"'' | Offer a door. ''code'' is what members send; ''INTERNAL'' is the door's Internal Code on your Synchronet. |
| ''door list'' | Games, open or closed, play counts. |
| ''door enable <code>'' / ''door disable <code>'' | Open or close a game. |
| ''door rename <code> "<name>"'' | Change the menu name. |
| ''door remove <code>'' | Remove a game from the hub. |

See [[doorhub:games|Games]].

==== Players ====

^ Command ^ What it does ^
| ''player list [TAG]'' | Players, newest first, optionally for one member. |
| ''player reset "[TAG]Name"'' | Forget the player's password from their BBS. |

See [[doorhub:players|Players]].

===== doorhub-connector (member BBSes) =====

^ Command ^ What it does ^
| ''doorhub-connector'' | Run with ''doorhub-connector.ini'' from the program's folder. |
| ''doorhub-connector <ini>'' | Run with another ini. |
| ''doorhub-connector service install [ini]'' | Windows: install the "Door Hub Connector" service (Administrator). |
| ''doorhub-connector service start'' / ''stop'' / ''remove'' | Windows: manage the service. |
| ''doorhub-connector version'' / ''help'' | Version / short help. |

See [[doorhub:connector|The connector]].

===== doorhub.js (Synchronet) =====

^ Command line in SCFG ^ What it does ^
| ''?doorhub.js'' | Show the hub's game menu. |
| ''?doorhub.js <code>'' | Go straight into one game. |

Options in ''ctrl/modopts.ini'' section ''[doorhub]'': ''tunnel_host'', ''tunnel_port'', ''password''. See [[doorhub:synchronet_member|Synchronet set-up]].