Usage

This section describes teleghosts executable usage in a great detail

TL;DR: teleghosts --target <your_simplex_profile_address> and check the list of caveats

USAGE
./teleghosts --target <address> [--bot-mirror]

ARGUMENTS

 -h, --help                  Print usage information
 -V, --version               Print version
 --target <address>          Public address of SimpleX profile to connect to
 --bot-mirror                Run in a bot mirroring mode. Teleghost admin and setup bots will be disabled

ENVIRONMENT

  TEGHOST_KEY        Provide DB password. Teleghost setup will skip password dialogue if this is set
  TEGHOST_TOKEN      Provide Telegram token. Teleghost setup will skip TG token step if this is set
  TEGHOST_PIN        Set pin to mitigate phishing attacks(displayed in admin/setup bio)

User mode

teleghosts --target <public_profile_address>

This mode lets you chat with Telegram users directly from your personal SimpleX profile.

If a malicious actor knows your public profile address used with teleghosts, they may try to impersonate teleghosts bots to steal sensitive data from you. Set some memorable word/phrase in TEGHOST_PIN environment variable, the contents of TEGHOST_PIN will be used in profile bios of teleghosts bots allowing you to distinguish your bots from fake ones.

You can also set TEGHOST_KEY and TEGHOST_TOKEN env variables to provide the database key and the Telegram token respectively. If both variables are set the Setup Wizard initialization step will be skipped. If only one of the variables is set the Teleghosts Setup Wizard will still connect to you to ask about the missing information.

Bot mirror mode: mirror SimpleX bots to Telegram

teleghosts --target <public_address> --bot-mirror

--bot-mirror flag does only 2 things in current alphas:

1. Ensures TEGHOST_TOKEN and TEGHOST_KEY environment variables are set to so that Teleghosts Setup Wizard won’t connect to your SimpleX bot.
2. Disables the admin task. Teleghosts admin will still connect to your bot but it will be unresponsive.

This is enough to mirror simple SimpleX bots to Telegram. Note, that --bot-mirror doesn’t enable any extra features so bot menus won’t be bridged, bot captcha prompts will be ignored, and the markdown won’t render properly on the Telegram side.

Caveats

• Telegram stores undelivered bot messages for ~24hours before dropping them. Don’t keep teleghosts offline for longer than 24 hours to avoid message loss.

• There is a bunch of unadressed issues that may cause a message loss. During this alpha test we expect you to monitor logs and report any message delivery issues on sight.