diff --git a/templates/zerver/help/import-from-hipchat.md b/templates/zerver/help/import-from-hipchat.md new file mode 100644 index 0000000000..4c276fc90a --- /dev/null +++ b/templates/zerver/help/import-from-hipchat.md @@ -0,0 +1,99 @@ +# Import from HipChat (beta) + +Starting with Zulip 1.9, Zulip supports importing data from HipChat, +including users, rooms, messages, avatars, and custom emoji. + +**Note:** You can only import a HipChat group as a new Zulip +organization. In particular, you cannot use this tool to import data +from HipChat into an existing Zulip organization. + +## Import from HipChat + +First, export your data from HipChat. + +{start_tabs} +{tab|cloud} + +1. Log in at `yourdomain.hipchat.com/admin/`. + +1. Click on the **Data Export** tab. + +1. Select the data to export. + +1. Click **Export**. + +Once the export has completed, the export will be available to you in the +admin console. + +{tab|server} + +1. Upgrade to the latest version to ensure you have the latest updates to + the HipChat export dashboard. + +1. Log in at the domain name configured for your Hipchat Server. + +1. Click on **Server Admin > Export**. + +1. Select the data to export. + +1. Click **Export**. + +Once the export has completed, you will receive an **email** with a link to +download the file. + +!!! tip "" + If you are not on the latest version of Hipchat Server / Data Center, + you can do a command line export with `hipchat export --export`. See + HipChat's [command line export docs][cli-export] for more information. + +{end_tabs} + +!!! warn "" + **Note:** Only HipChat Group Administrators can export data from HipChat. + +[cli-export]: https://confluence.atlassian.com/hipchatdc3/export-data-from-hipchat-data-center-913476832.html + +### Import into zulipchat.com + +Email support@zulipchat.com with exported HipChat archive and your desired +subdomain. Your imported organization will be hosted at +`.zulipchat.com`. + +If you've already created a test organization at +`.zulipchat.com`, let us know, and we can rename the old +organization first. + +### Import into a self-hosted Zulip server + +Because the import tool is very new, you will need to +upgrade your Zulip server to the latest `master` branch, +using [upgrade-zulip-from-git][upgrade-zulip-from-git]. + +Log in to a shell on your Zulip server as the `zulip` user. To import with +the most common configuration, run the following commands, replacing +`` with the HipChat export file. + +``` +cd /home/zulip/deployments/current +./manage.py convert_hipchat_data --output converted_hipchat_data +./manage.py import '' converted_hipchat_data +``` + +This could take several minutes to run, depending on how much data you're +importing. + +**Import options** + +The commands above create an imported organization on the root domain +(`EXTERNAL_HOST`) of the Zulip installation. You can also import into a +custom subdomain, e.g. if you already have an existing organization on the +root domain. Replace the last line above with the following, after replacing +`` with the desired subdomain. + +``` +./manage.py import converted_hipchat_data +``` + +{!import-login.md!} + +[upgrade-zulip-from-git]: https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html#upgrading-from-a-git-repository diff --git a/templates/zerver/help/include/sidebar_index.md b/templates/zerver/help/include/sidebar_index.md index 934e26d057..75636a5d17 100644 --- a/templates/zerver/help/include/sidebar_index.md +++ b/templates/zerver/help/include/sidebar_index.md @@ -100,6 +100,7 @@ * [Review your organization's settings](/help/review-your-organization-settings) * [Create your organization profile](/help/create-your-organization-profile) * [Link to your Zulip from the web](/help/join-zulip-chat-badge) +* [Import from HipChat](/help/import-from-hipchat) * [Import from Slack](/help/import-from-slack) * [Import from Gitter](/help/import-from-gitter) * [Manage who can join](/help/manage-who-can-join-and-invite) diff --git a/zerver/lib/bugdown/tabbed_sections.py b/zerver/lib/bugdown/tabbed_sections.py index 100876e9ab..4e264b9f23 100644 --- a/zerver/lib/bugdown/tabbed_sections.py +++ b/zerver/lib/bugdown/tabbed_sections.py @@ -47,6 +47,9 @@ TAB_DISPLAY_NAMES = { 'js': 'JavaScript', 'curl': 'curl', 'zulip-send': 'zulip-send', + + 'cloud': 'HipChat Cloud', + 'server': 'HipChat Server or Data Center', } class TabbedSectionsGenerator(Extension):