This page provides information on the command line utility you can use with HipChat Server and describes other configurations you can do on HipChat Server.
HipChat command line utility
You can do a variety of actions, like upgrade, export your data, control networking, and more in HipChat Server's command line interface (CLI).
To see the list of available commands type
hipchat at the
For help on using any of the commands, type the command like
hipchat upgrade at the prompt:
admin@hipchat:~$ hipchat upgrade
The HipChat Server CLI returns explanations of all the arguments available for the command.
Setting network time
HipChat Server uses network time protocol (NTP) with the following default servers:
To change the servers, type the following command:
hipchat service --ntp-servers time1.example.com,time2.example.com
time1.example.com,time2.example.com are the servers you want to use
Configuring email notifications
You can configure email notifications via the
hipchat email utility:
To show the current settings:
To show the help menu and what can be changed:
For example, to change the sender email and the sender name to respectively firstname.lastname@example.org and HipChat Notifications:
You can configure HipChat Server with a recipient email address for system alerts using the
OVF alerts email property or the command line.
To configure email alerts through the command line, open the command line and enter:
hipchat email --alerts-email email@example.com
An alert email is sent when any of the following conditions are met:
- Memory utilization over 98% for three cycles
- Swap file utilization over 10% for three cycles
- CPU (user) utilization over 95% for three cycles
- CPU (system) utilization over 95% for three cycles
- CPU (wait) utilization over 99% for three cycles
- 'gearman' over 30% CPU utilization
- 'mysql' becomes unavailable after three attempts within five cycles
- 'nginx' over 20% CPU utilization for five cycles
- 'ntpd' becomes unavailable
- 'php5' restarts three times within five cycles
- 'punjab' unavailable for three cycles, or over 45% CPU for three cycles
- 'redis' unavailable three times within five cycles, or over 35% CPU for three cycles
- 'rsyslog' over 75% CPU for three cycles
HipChat Server implements SNMP v2c using standard Ubuntu MIBs that can be enabled by the command line.
- To turn SNMP on or off, type:
hipchat service -n "on" OR "off"
- To set up the community string, type:
hipchat service -c <communitystring>
Example: hipchat service -c public
To add TRAP recipient server list, type:
hipchat service -t trap.server.com
\prior to a special character as in
Enabling SMS notifications
To enable your users to receive SMS Notifications, use a Twilio account.
- Start a Twilio trial or log into your Twilio account.
- In the HipChat Server web interface, click Server admin > Notifications.
- In the fields provided, paste your Twilio credentials and phone number.
- Click Modify.
- To test SMS notifications, click Account settings, then Notifications in the left menu.
- Next to SMS, click Add phone.
Disabling phone-home signal
HipChat Server sends a daily heartbeat “phone home” to help Atlassian improve the product. This can be disabled at the command line by running this command:
hipchat license --phone-home off
Was this helpful?
Thanks for your feedback!