bbsio/doorparty repository overview

⁠bbsio/doorparty

DoorParty Connector for Docker⁠

A small server that connects local RLOGIN clients to a remote RLOGIN server via an SSH tunnel.

This is based on the dpc2⁠ connector by echicken⁠. Images are available for amd64, arm6, arm7 and arm64.

⁠Environment Variables

These environment variables must be set to function normally.

• SYSTEM_TAG - Doorparty System Tag
• SSH_USERNAME - Doorparty SSH Username
• SSH_PASSWORD - Doorparty SSH Password

These environment variables are optional and should probably stay default.

• LOCAL_INTERFACE - default 0.0.0.0
• LOCAL_PORT - default 9999
• SSH_HOST - default dp.throwbackbbs.com
• SSH_PORT - default 2022
• RLOGIN_HOST - default dp.throwbackbbs.com
• RLOGIN_PORT - default 513

⁠Installation

docker pull bbsio/doorparty:latest

⁠Running Directly

Alternatively, should set this in a network only accessible by services allowed to access.

docker run -d \
  --restart unless-stopped \
  -p 9999:9999 \
  -e SYSTEM_TAG=[TODO] \
  -e SSH_USERNAME=TODO \
  -e SSH_PASSWORD=TODO \
  bbsio/doorparty:latest

⁠docker-compose.yml

You can add the following under services

...
services:
  ...
  doorparty_connector:
    hostname: doorparty
    container_name: doorparty_connector
    image: bbsio/doorparty:latest
    environment:
      - SSH_USERNAME=TODO
      - SSH_PASSWORD=TODO
      - SYSTEM_TAG=[TODO]
    deploy:
      restart_policy:
        condition: any
    networks:
      - bbs
...
# Network used for internal communication
networks:
  bbs:
    name: bbs

⁠Usage

The Doorparty Connector service runs and listens for connections from RLOGIN clients. You must start it up and leave it running. A typical installation has doorparty-connector running on the same machine that hosts your BBS - but this isn't a requirement.

When a user on your BBS chooses to connect to DoorParty:

• Your BBS should open an RLOGIN connection to bbsio/doorparty (eg. port 9999 on localhost)
  • The RLOGIN "server-user-name" is the user's alias prefixed with your DoorParty "system tag", eg. [ec]echicken
  • The RLOGIN "client-user-name" is the user's DoorParty password
    • You can use whatever you like for this value, and even use the same value for all users if you must, but you must always send the same password for the same user every time they connect
    • The user does not need to know this value
  • doorparty-connector then connects the user to DoorParty's RLOGIN server via an SSH tunnel, passing the necessary user details along
    • An account is automatically created for the user on the DoorParty server if it doesn't already exist
      • This account is linked to this user on your BBS
      • The user can only access it from your BBS
      • The user does not need to know the password
      • The user may have several DoorParty accounts, one for each BBS they connect from; they cannot use the same DoorParty account from multiple BBSs

On Mystic, for example, this is menu command IR, with a DATA field like:

• /ADDR=localhost:9999 /USER=@USER@ /PASS=some_password
  • Mind that some_password must be replaced with your own values

For Synchronet, a script⁠ and instructions for Synchronet⁠ are available here⁠.