Configure optional Hipchat Data Center features

Once your Hipchat Data Center cluster is running you can configure optional features. 

Many features are available from the Hipchat Data Center admin UI. To access this UI, browse to your server's fully-qualified domain name, and log in using an administrator account.

If you have access to the command line for the cluster, you can SSH to any node in the cluster and use the Hipchat CLI to change some configuration options. Configuration changes propagate to all servers in the cluster, except for the Email command (see below).

On this page:

Set up Hipchat notification emails

In order to send an email notification when a user gets a message and they're not available, you need to give Hipchat access to an SMTP email server. You can set this up using the Hipchat Data Center admin UI, or you can choose to leave emails disabled. If you leave email disabled, you will not be able to send user invitations, message notifications, or password reset emails.

To add a mail server:

  1. Browse to your server's fully-qualified domain name, and log in using your administrator credentials.
  2. Click System.
  3. Click the Email server tab.
  4. Enter your SMTP email account information:

    Sender email address The address that the email should appear to be from. This is used as the "from" and "reply-to" address, usually something like no-reply@example.com
    SMTP hostname The address (DNS or IP address) of your SMTP server.
    SMTP port If your SMTP server uses a port other than the default (port 25), enter it here.
    Encryption None, SSL, or TLS.
    Username The username of the account to send email notifications.
    Password The password for the account.
    Monitoring email address The address to which system monitoring alerts will be sent.
  5. Click  Save.

Set up a forward proxy

Hipchat Data Center now allows you to specify a forward (outbound) proxy which you can use to allow your deployment to connect to publicly hosted Add-ons, and authenticate with the Video chat servers. See the Hipchat Labs CLI documentation to learn more about the proxy configuration requirements.

To enable a forward proxy:

  1. Log in to the Hipchat Data Center admin UI using your administrator account.
  2. Click Settings, and scroll down to Forward proxy.
  3. Enter the address of your proxy on your network.
  4. Click Save

Enable or disable Hipchat Video

Hipchat Video is enabled by default. Hipchat video requires that the server have one-time access to video.hipchatserver.com to register itself with the license server and generate a trust keypair. You can revoke this access once the server has registered. The Hipchat Data Center clients require continuing access to hipchat.me on 443 TCP and 10000 UDP to connect to and stream video calls. If you have a forward proxy available on your network you can configure it (using the instructions above) to allow you to access Hipchat Video.

If you do not want to use Hipchat Video, you can disable it.

To enable or disable Hipchat Video:

  1. Log in to the Hipchat Data Center admin UI using your administrator account.
  2. Click Settings, and scroll down to Video.
  3. Change the setting to enable or disable Hipchat Video.
  4. Click Save

Enable and configure add-ons

Hipchat Data Center provides a large set of add-ons (previously called integrations) which allow you to expand the functions available in your chat rooms. Add-ons are enabled either globally (for all rooms), or on a room-by-room basis.

Some add-ons require access to the open internet to register themselves, and to be able to reach your Hipchat Data Center deployment from an external network in order to function correctly. If you are enabling add-ons from behind a firewall, you may need to open ports, or set up a proxy to allow them to function.  

Connect an authentication source to Hipchat Data Center

You can use your organization's user directories, including popular LDAP directories, Active Directory, Crowd, and Jira applications, with Hipchat Server. For the full list of supported user directories and instructions on configuring them with Hipchat Server, see Configuring user directories.  Hipchat Data Center also supports SAML 2.0 authentication.

If you're restoring Hipchat Data Center from an exported archive file, connect to external user directories after Importing your Hipchat Data to ensure data consistency.

Last modified on Nov 30, 2017

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.