Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 4.92 KB

communication_manager.md

File metadata and controls

90 lines (62 loc) · 4.92 KB

GoCryptoTrader package Communication manager

Build Status Software License GoDoc Coverage Status Go Report Card

This communication_manager package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for Communication manager

  • The communication manager subsystem is used to push events raised in GoCryptoTrader to any enabled communication system such as a Slack server
  • In order to modify the behaviour of the communication manager subsystem, you can edit the following inside your config file under communications:

slack

Config Description Example
enabled Determines whether the push communications to a Slack server true
verbose If enabled will log more details to your logger output false
targetChannel The channel to send communications to announcements
verificationToken The token generated by Slack to allow interactions with the server and channel iamafaketoken

smsGlobal

Config Description Example
name The name of the SMS sender SMSGlobal
from Who the text name is from Skynet
enabled Determines whether the push communications to the SMS service true
verbose If enabled will log more details to your logger output false
username The username to use with the SMS provider username
password The username to use with the SMS provider password
contacts The name number of the user people you wish to send SMS to and whether it is enabled "name": "StyleGherkin", "number": "1231424", "enabled": true

smtp

Config Description Example
name The name of the service SMTP
enabled Determines whether the push communications to a email server true
verbose If enabled will log more details to your logger output false
host The SMTP host smtp.google.com
port The port to use 537
accountName Your username username
accountPassword Your password password
from The display name of the sender Jeff Bezos
recipientList A comma delimited list of addresses to send alerts to [email protected]

telegram

Config Description Example
name The name to be displayed Telegram
enabled Determines whether the push communications to a Telegram server true
verbose If enabled will log more details to your logger output false
verificationToken The token generated by Telegram to allow you to send messages iamafaketoken

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc