nuqql-mattermostd

README

nuqql-mattermostd

nuqql-mattermostd is a network daemon that implements the nuqql interface and uses the Mattermost Golang Driver to connect to Mattermost servers. It can be used as a backend for nuqql or as a standalone chat client daemon.

Quick Start

You can download and install nuqql-mattermostd with its dependencies to your GOPATH or GOBIN with the go tool:

$ go get github.com/hwipl/nuqql-mattermostd/cmd/nuqql-mattermostd

Make sure your GOPATH or GOBIN (e.g., ~/go/bin) is in your PATH.

After the installation, you can run nuqql-mattermostd by running the nuqql-mattermostd command:

$ nuqql-mattermostd

By default, it listens on TCP port 32000 on your local host. So, you can connect with, e.g., telnet to it with the following command:

$ telnet localhost 32000

In the telnet session you can:

• add Mattermost accounts with: account add mattermost <account> <password>.
  • Note: the format of <account> is <username>@<server>, e.g., dummy_user@yourserver.org:8065.
• retrieve the list of accounts and their numbers/IDs with account list.
• retrieve your buddy/channel list with account <id> buddies or account <id> chat list
• send a message to a channel with account <id> chat send <channel> <message>
• get a list of commands with help

Usage

You can run nuqql-mattermostd with the following command line arguments:

Usage of ./nuqql-mattermostd:
  -address address
        set AF_INET listen address (default "localhost")
  -af family
	set socket address family: "inet" for AF_INET, "unix" for AF_UNIX
        (default "inet")
  -dir directory
        set working directory (default "/home/user/.config/nuqql-mattermostd")
  -disable-encryption
        disable TLS encryption
  -disable-history
        disable message history
  -filter-own
        toggle filtering of own messages
  -loglevel level
        set logging level: debug, info, warn, error (default "warn")
  -port port
        set AF_INET listen port (default 32000)
  -push-accounts
        push accounts to client
  -sockfile file
	set AF_UNIX socket file in working directory (default
        "nuqql-mattermostd.sock")
  -v    show version and exit

Changes

• v0.3.0:
  • Update mattermost to v6.4.2
  • Cleanups, fixes and improvements
• v0.2.0:
  • Add retrieval of messages since last login.
  • Disable filtering of own messages and change command line argument -disable-filterown to -filter-own.
  • Rewrite sender of own messages to <self>.
  • Add message history per account.
  • Add/update welcome message, account adding help, account added info messages and push new accounts to client with -push-accounts.
  • Add config file support.
  • Fixes and improvements.
• v0.1.0:
  • First/initial release.