Self-hosting Hanzo Team
Learn how to get help with self-hosting Hanzo Team.
We offer the option to self-host the Hanzo Team on your own server. All of the documentation for setting up and maintaining a self-hosted instance of Hanzo Team is available on our hanzo team-selfhost GitHub repository. The main repository readme includes documentation on the following:
- Cloning and configuring the repository
- Setting up AWS SES email notifications
- Setting up Love Service (Audio & Video calls)
- Setting up AI Service
- Configuring OpenID Connect
- Configuring GitHub OAuth
- Disabling Sign-up
Everything you see in the cloud version can potentially be self-hosted; however, we may not "prepackage" some services for various reasons. Some integrations (like GitHub) may require you to install a separate app in GitHub or work with Google to enable an API, and we do not have extensive documentation to describe every case. Also, some parts of cloud version rely on proprietary Cloudflare services, which we intentionally do not include into self-hosting packages to avoid any vendor lock-ins.
Connecting the Desktop App to your self-hosted server
You can connect the Hanzo Team Desktop App to your self-hosted server by launching it with the --server option pointing to your server URL.
Windows:
- Right-click the Hanzo Team shortcut → Properties
- In the "Target" field, add
--server https://your-hanzo team-server.comafter the exe path - Example:
"C:\Program Files\Hanzo Team\Hanzo Team.exe" --server https://your-hanzo team-server.com
macOS:
# Using the app name
open -a "Hanzo Team" --args --server https://your-hanzo team-server.com
# Or using the executable path directly
/Applications/Hanzo Team.app/Contents/MacOS/Hanzo Team --server https://your-hanzo team-server.comMigrating data between self-hosted and cloud
We do not have a way for users to migrate data from a self-hosted Hanzo Team instance to our cloud version through the GUI, but there is still a way to manually export/import your self-hosted data to hanzo.team. Feel free to reach us out when you need to do this and we will provide you guidance and help.
In the reverse direction (migrating from could to self-hosted), if you are an owner of the workspace, you can do this in the desktop app. In the menu we have Backup option that saves workspace backup to your filesystem. When you have the backup, you can restore it to the self-hosted version.
Support for self-hosting
Support for self-hosting is community-driven, and the best way to get in touch with others who are self-hosting is through our Slack community in the #open-source channel. Here, you can ask questions, share tips, and get help from others who are also self-hosting Hanzo Team.
Our team is also active in the community and we do our best to respond to as many questions as we can. However, due to the technical complexities of self-hosting and the wide range of factors that vary between individual setups, we may not be able to respond to every request for self-hosting support. For this reason, we encourage community members to support each other whenever possible, and of course we welcome any supplementary documentation provided by the community to add to our repository.