# How to install Voxbi on Odoo.sh: a step-by-step guide

> Deploy the Voxbi app from the Odoo Apps Store to your Odoo.sh production branch, activate it in Odoo, and connect it to Voxbi Cockpit. For Odoo 16 to 20.

Public AI-agent markdown version of [this guide](https://www.voxbi.com/guides/install-voxbi-on-odoo-sh) on the Voxbi website.
HTML page: https://www.voxbi.com/guides/install-voxbi-on-odoo-sh
Markdown page: https://www.voxbi.com/guides/install-voxbi-on-odoo-sh.md

- Published: 2026-10-28
- Category: Integrations
- Author: Umair Ali (Head of software architecture)

---
This guide is for Odoo.sh only. On Odoo.sh you install Voxbi from the Odoo Apps Store, merge it into your production branch, and then connect it to Voxbi Cockpit with one click. Running Odoo Online or your own server instead? Follow [how to connect Odoo to Voxbi](https://www.voxbi.com/guides/connect-odoo-to-voxbi). For what the integration does once it runs, see the [Odoo VoIP integration overview](https://www.voxbi.com/integrations/odoo).

The setup has three parts. **Part 1** deploys the app on Odoo.sh. **Part 2** activates it inside Odoo. **Part 3** connects it to Voxbi Cockpit, which installs the rest for you.

<aside class="callout tint-neutral">

**Before you start.** Plan about 15 minutes, most of it waiting for Odoo.sh builds. You need three things. First, an Odoo.sh project on Odoo 16 to 20 with a production branch; Odoo.sh adds the app as a commit to the project's GitHub repository, so you need the right to push to it. Second, administrator access to the Odoo database, because developer mode, the apps list update and module activation all require it. Third, a Voxbi Cockpit login with access to the PBX you want to connect to this Odoo.

</aside>

## Part 1: deploy the app on Odoo.sh

The Odoo Apps Store can push an app straight into an Odoo.sh project. The app lands on a development branch first, and you merge it into production yourself.

### Step 1: open Voxbi on the Odoo Apps Store

Search the [Odoo Apps Store](https://apps.odoo.com/apps/modules/browse?search=voxbi) for Voxbi and open the listing. Check that the version badge next to the title matches your Odoo.sh project's version. The **Versions** row lets you switch. Then click **Deploy on Odoo.sh**.

![The Voxbi listing on the Odoo Apps Store, with the Deploy on Odoo.sh button next to the download button.](https://www.voxbi.com/assets/blog/odoo-sh-install/01-store-listing.webp)

*The Voxbi listing. Deploy on Odoo.sh sits next to the download button.*

### Step 2: choose the Odoo.sh project

Odoo.sh lists every project you have access to. Pick the one whose production database should get Voxbi and click **Open**. Make sure its Odoo version matches the store version you chose in step 1.

![The Odoo.sh project picker, listing each project with its Odoo version and an Open button.](https://www.voxbi.com/assets/blog/odoo-sh-install/02-choose-project.webp)

*Each row shows the project's Odoo version, so you can confirm the match before you open it.*

### Step 3: confirm the Add app dialog

Odoo.sh explains that it will create a new branch based on your production branch and add the app to it. Click **Continue**.

![The Odoo.sh Add app dialog, explaining that a new branch will be created from production.](https://www.voxbi.com/assets/blog/odoo-sh-install/03-add-app.webp)

*Nothing changes in production yet. Odoo.sh only creates a branch.*

### Step 4: wait for the development build

A development branch named `app-voxbi_installer` appears with one commit, `[ADD] app voxbi_installer`, and Odoo.sh queues a build. Wait until the build completes. You can keep the branch after the merge or delete it; it has no effect on production.

![The app-voxbi_installer development branch in Odoo.sh with its build running.](https://www.voxbi.com/assets/blog/odoo-sh-install/04-dev-branch-build.webp)

*The development branch builds on a fresh database with demo data. It is a test, not your production install.*

### Step 5: merge the branch into production

With `app-voxbi_installer` selected, click **Merge** in the branch toolbar and target your production branch, usually `main`. In the dialog, **Merge** creates a merge commit and **Rebase and Merge** keeps a linear history. Both give you the same code, so either one works.

![The Odoo.sh merge dialog, offering Merge and Rebase and Merge into the production branch.](https://www.voxbi.com/assets/blog/odoo-sh-install/05-merge-dialog.webp)

*The merge starts a production build.*

### Step 6: wait for the production build, then open Odoo

The history of your production branch now shows the merge. When the build reports **Test: Success**, click **Connect** to open your production database.

![The Odoo.sh production branch history with a successful build and the Connect button.](https://www.voxbi.com/assets/blog/odoo-sh-install/06-production-build.webp)

*Connect opens the production database as the administrator.*

<aside class="callout tint-neutral">

**Why Voxbi is not in Apps yet.** The merge only puts the `voxbi_installer` module on the server. Odoo lists a new module once you refresh its apps list, and the Apps view hides it until then. Part 2 takes care of that.

</aside>

## Part 2: activate Voxbi in Odoo

Four short steps inside Odoo: switch on developer mode, refresh the apps list, find the module, activate it.

### Step 7: turn on developer mode

Open **Settings**, scroll to the bottom of **General Settings**, and click **Activate the developer mode** under **Developer Tools**. The page reloads and the address ends in `?debug=1`.

![Odoo General Settings with the Activate the developer mode link under Developer Tools.](https://www.voxbi.com/assets/blog/odoo-sh-install/07-developer-mode.webp)

*Developer mode unlocks the Update Apps List menu you need in the next step.*

### Step 8: open Update Apps List

Go to **Apps**. The top menu now shows **Update Apps List**. Click it.

![The Odoo Apps menu bar in developer mode, with Update Apps List as the second entry.](https://www.voxbi.com/assets/blog/odoo-sh-install/08-update-apps-list.webp)

*Update Apps List only appears in developer mode.*

### Step 9: confirm the update

In the **Module Update** dialog, click **Update**. Odoo rescans the add-ons on the server and registers `voxbi_installer`. This takes a few seconds.

![The Odoo Module Update dialog with its Update button.](https://www.voxbi.com/assets/blog/odoo-sh-install/09-module-update.webp)

*After the update the Apps view reloads. Voxbi is registered but the default filter still hides it.*

### Step 10: find Voxbi and activate it

In the search bar, remove the **Apps** filter by clicking its **×**. Type `Voxbi` and pick **Search Module for: Voxbi**. The Voxbi card appears, labelled `voxbi_installer`. Click **Activate**.

![The Odoo Apps search with the Apps filter removed, showing the Voxbi card and its Activate button.](https://www.voxbi.com/assets/blog/odoo-sh-install/10-search-voxbi.webp)

*With the Apps filter gone the search covers every module, and Voxbi shows up with its Activate button.*

## Part 3: connect to Voxbi Cockpit

The module you just activated is a small installer. It hands your Odoo connection details to Voxbi Cockpit, and Cockpit then sets up call logging, click-to-call and caller details in this database.

### Step 11: open Voxbi Setup and connect

After activation, Odoo opens **Voxbi Setup** with the status strip on **Ready to install**. If the database has no user yet other than administrators, click **Create a Voxbi sync user** first, so the ongoing sync never runs on an administrator's credentials. Then click **Connect to Voxbi Cockpit**.

![The Voxbi Setup screen in Odoo with the Connect to Voxbi Cockpit button and the Create a Voxbi sync user option.](https://www.voxbi.com/assets/blog/odoo-sh-install/11-voxbi-setup.webp)

*The status strip tracks the three stages: Ready to install, Installing, Installed.*

### Step 12: authorize the connection in Cockpit

Your browser goes to Voxbi Cockpit. Sign in with your Cockpit account if asked. The **Connect Odoo to Voxbi Cockpit** page names the Odoo instance and the PBX it will link. It also lists what Odoo sends to Voxbi, what Voxbi does with it, and how to stop it. Click **Authorize and connect**.

![The Voxbi Cockpit authorization page listing what is sent to Voxbi and how to stop it, with the Authorize and connect button.](https://www.voxbi.com/assets/blog/odoo-sh-install/12-authorise.webp)

*Approving starts the setup in your Odoo straight away. You can revoke the key at any time under Odoo integrations in Cockpit.*

### Step 13: let the installation run

Back in Odoo, Voxbi Setup shows the Cockpit address, the PBX, and the user it syncs as, with the message **Voxbi module is installing**. Cockpit now creates the Voxbi models, views and menus in your database. Leave the page open. It updates by itself, and the status strip moves from **Installing** to **Installed** when the work is done.

![Voxbi Setup in Odoo during installation, showing the Cockpit connection, the sync user and the installing message.](https://www.voxbi.com/assets/blog/odoo-sh-install/13-installing.webp)

*A Disconnect Voxbi button replaces Connect once the link exists. Use it to revoke the integration from the Odoo side.*

When the status reads **Installed**, every Voxbi call lands in Odoo. The Voxbi menu gains a **Calls** view, and call history, click-to-call and caller details appear on contacts, leads and tasks. Calls start syncing from that moment.

## Optional: make and receive calls inside Odoo

To let your team call from Odoo's own VoIP module, turn on **Sync SIP connection configurations to Odoo for all users** in the Odoo integration settings in Voxbi Cockpit. Step 5 of [how to connect Odoo to Voxbi](https://www.voxbi.com/guides/connect-odoo-to-voxbi) shows where the setting is.

## Troubleshooting

<table header-row="true">

<tr>

<td>Symptom</td>

<td>Likely cause</td>

<td>Fix</td>

</tr>

<tr>

<td>Voxbi does not appear in Apps</td>

<td>The production build from step 6 has not finished, the apps list was not updated, or the Apps filter is still on</td>

<td>Check the three in that order: the build in step 6, steps 8 and 9, then the filter chip in step 10.</td>

</tr>

<tr>

<td>No Deploy on Odoo.sh button on the store</td>

<td>You are not signed in to an Odoo account that owns Odoo.sh projects</td>

<td>Sign in on [apps.odoo.com](http://apps.odoo.com/) and reload the listing.</td>

</tr>

<tr>

<td>The version badge does not match the project</td>

<td>The listing shows a different Odoo version</td>

<td>Use the Versions row on the listing to switch to your project's version before you click Deploy. Odoo.sh refuses apps built for another major version.</td>

</tr>

<tr>

<td>Voxbi Setup reports Install failed</td>

<td>The installation stopped partway</td>

<td>Click **Disconnect Voxbi**, then **Connect to Voxbi Cockpit** again. If it fails a second time, copy the text under Output on the setup page and send it to [support@voxbi.com](mailto:support@voxbi.com).</td>

</tr>

<tr>

<td>One person's calls do not sync</td>

<td>Their email differs between Voxbi and Odoo</td>

<td>Voxbi matches users by email address. Make the email identical in both systems.</td>

</tr>

</table>

## Frequently asked questions

**Does this guide work for Odoo Online?**

No. This guide relies on Odoo.sh branches and builds, which Odoo Online does not have. Follow [how to connect Odoo to Voxbi](https://www.voxbi.com/guides/connect-odoo-to-voxbi) instead; Voxbi Cockpit installs the module for you there.

**Which Odoo versions does Voxbi support on Odoo.sh?**

Odoo 16, 17, 18, 19 and 20. Pick the matching version on the store listing before you deploy.

**Does the development branch touch my production data?**

No. It builds on a fresh database with demo data. Production changes only when you merge in step 5.

**Do I need an Odoo API key?**

No. The Authorize step in Cockpit replaces the API key you would otherwise copy by hand. Cockpit deletes the key it used for the installation when the installation finishes and keeps only the sync user's key.

**How do I disconnect Voxbi later?**

Click **Disconnect Voxbi** in Voxbi Setup in Odoo, or revoke the key under Odoo integrations in Voxbi Cockpit. Syncing stops at once. Call history already in Odoo stays there until you delete it.

## Need help?

If a step fails, email [support@voxbi.com](mailto:support@voxbi.com). Include a screenshot of the step and any text under Output on the Voxbi Setup page, so we can help you faster.