Alias (The Crisp Variety)

A simple HipChat add-on that supports group mentions via room notifications.

The only difference between this and the official code from Atlassian is that it doesn't repeat the original message. It just tags the group and refers to the previous message with "^^".

Commands

#!html
usage: /alias [-h] {list,set,remove,show} ...
positional arguments:
  {list,set,remove,show}
                        Available commands
    list                List existing aliases
    set                 Sets a group mention alias
    remove              Removes a group mention alias
    show                Shows the names for an existing alias
optional arguments:
  -h, --help            show this help message and exit

Example:

#!html
/alias set @ateam @bob @anne @alex

Mentioning a team in a room will return another notification that mentions Bob, Anne and Alex.

Run Alias yourself with Docker

This is an experimental way for you to run Sassy yourself using Docker, which could be useful for "Behind the Firewall" (on-premises) Hipchat Data Center deployments.

This version of Alias links to a persistent Redis and Mongo containers which contains your installation/registration. If you destroy the linked containers, you'll have to uninstall and reinstall the Dockerized-Sassy on your Hipchat deployment.

If you decide to use this in production, you'll want to use your own SSL termination and port forwarding from the Docker host to protect your Sassy traffic. You can use a proxy such as NGINX or HAProxy for this.

If you'll be running this on a deployment without access to the internet, your process will look something like this:

Clone this repository.
Build a container from the repository.
Pass the container to your on-premises deployment using whatever process is approved by your organization.
Run the container on a host within your firewall. Optionally, you may also push the image to a Docker Registry, Docker Trusted Registry, or Docker Datacenter repository.

Setup and Prerequisites

Check for port conflicts on port 3022. Alias will use this port so you want it to be available.
Clone this source repository to your local machine: git clone https://bitbucket.org/atlassianlabs/hc-alias.git

Build the container

Change directories to the source you just cloned: cd hc-alias

Run the following command to use the Dockerfile in this repo to build a container with the latest version of Alias. sudo docker build -t atlassian_labs/alias:latest .

Run

Export the following variable in your shell: export BASE_URL=http://your-docker-host-fqdn:3022
Run the following command to use the Docker Compose file in this repo to run the Alias service. docker-compose up -d
Check the logs to make sure everything went smoothly using the following command. docker-compose logs
Verify that the following URL returns a valid capabilities.json response. (Replace 'your-docker-host-fqdn' with your actual host.) http://your-docker-host-fqdn:3022/addon/capabilities

Install Alias on your Hipchat instance

Next, make your Dockerized version of Sassy available on your Hipchat service.

Note: You must be at least a room admin to install an integration in a room. Only admins can install integrations globally.

Log in to your Hipchat instance.
If you're using Hipchat Cloud or Hipchat Server, click the Manage tab.
If you're using Hipchat Data Center, log in to the web portal and click Add-ons in the left navigation.
Click Install an add-on from a descriptor URL.
In the dialog that appears, enter the URL you used above: http://your-docker-host-fqdn:3022/addon/capabilities Hipchat verifies the add-on capabilities, and adds it to your deployment.

Play

Go to a chat room and type /alias

Things to remember

You may want to use a firewall or iptables at the Docker host level to set ACLs and filter traffic.
Use your own SSL termination and port forwarding from the Docker host to protect your Sassy traffic. You can use a proxy for this.
The Sassy Docker container publishes through the host port 3020. Check for port conflicts before you run it!
If installing to Hipchat Server your HC Server should have a valid trusted SSL cert from a major CA vendor. Self signed is not supported (yet).
To debug you can override the entry point by using docker run --interactive --tty ... and appending /bin/bash

tdreid/hc-alias-crisp