How to use the Hipchat Server Support Toolkit

Still need help?

The Atlassian Community is here for you.

Ask the community

What is the Hipchat Server Support Toolkit?

The Hipchat Server Support Toolkit is a set of functions written to help our customers: 

  • Apply a set of customizations to Hipchat Server
  • Simulate features that are yet to be added to the product
  • Run workarounds in a more supportable way
  • Simplify some administration tasks

It is a Python zipapp that should be downloaded from Amazon S3 and run from the Hipchat Server terminal/command-line interface.

On this page...

 

 

 

How to run a function

  1. Download the package from S3: 

    wget -N https://s3.amazonaws.com/hipchat-server-toolkit/hipchat-support.pyz 
  2. Run a function:

    python hipchat-support.pyz function-name --argument value

    Usage example - deleting two emoticons:

    python hipchat-support.pyz purge-emoticons --emoticons wat,areyoukiddingme 

The help menu of the script will provide usage instructions and a list of available functions:

python hipchat-support.pyz -h


The help menu of a function will describe the function and its arguments:

python hipchat-support.pyz function-name -h

Implemented Functions

FunctionDescription
update-password-messagesDisplay a warning message in the password update and password reset pages. This is useful to inform LDAP users that password updates in Hipchat Server will not affect their ability to log in.

Usage example

python hipchat-support.pyz update-password-messages --update_message "Please contact your LDAP admin to change your password" --update_color "red" --forgot_message "Please contact your LDAP admin to reset your password" --forgot_color "red"
purge-emoticonsPurge multiple emoticons via a list of comma-separated shortcuts or all default emoticons with the --default option. 

Usage example

python hipchat-support.pyz purge-emoticons --default
python hipchat-support.pyz purge-emoticons --emoticons wat,areyoukiddingme 
upgrade-diagnosticsGenerate an upgrade diagnostics archive to be send to support. The archive will contain information useful for troubleshooting issues related to upgrading Hipchat Server. 

Usage example

python hipchat-support.pyz upgrade-diagnostics
users-activityCreate a list of active and inactive users for the last N days. N can be passed with the --days argument. The list is returned in standard output and also written to /tmp/active_users.csv and /tmp/inactive_users.csv. Using the option --deactivate-inactive will deactivate all inactive users. 

Usage example
:
python hipchat-support.pyz users-activity --days 15
python hipchat-support.pyz users-activity --days 15 --deactivate-inactive 
export-redis-prefs

Export users auto-join information and other client preferences from Redis.

Usage example:
python hipchat-support.pyz export-redis-prefs

Last modified on Jan 19, 2018

Was this helpful?

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