Branch Actions
The Actions area on the branch screen holds every operation you can perform on a branch's instance. This page is a reference — for the normal working flow, see Your First Branch.
Every action creates a background task. Watch the Tasks tab to see whether it succeeded.
Actions marked Developer are only visible to users with the Developer role or above. Actions marked Destructive ask for confirmation first; Delete Instance additionally requires you to type the instance name.
Running the instance
| Action | What it does | |
|---|---|---|
| Restart | Restarts the instance's containers (a restart-and-reload). The first thing to try when an instance is unavailable | |
| Reload | Regenerates the Docker configuration from the current source and restarts | Developer |
| Build | Runs the generated Docker configuration — fetches Odoo and Postgres images, installs required packages, builds the instance | |
| Update Source-Code | Checks out the latest commit of the branch into the instance workspace |
Reload regenerates the Docker configuration from the current source:
Build then runs it — fetching the Odoo and Postgres images and installing the required packages:
Getting in
| Action | What it does | |
|---|---|---|
| Odoo Login | Lists users from the instance database and logs you in as the one you pick, without a password | |
| Update Users | Re-syncs the list of login users. Use this when Odoo Login offers stale users after a reset or restore | |
| Shell | Opens a shell on the instance | Developer |
| Code | Opens the web-based VS Code editor on the instance workspace | Developer |
| Code (Vim) | The same editor with Vim key bindings | Developer |
| Test TV | Opens the live test viewer | Developer |
| Logs | Opens live container logs | Developer |
| Webmailer | Opens the instance's web mail catcher | |
| Restart VS Code / Test TV | Restarts the editor and test viewer, and refreshes the instance workspace setup | Developer |
Modules
| Action | What it does |
|---|---|
| Update MANIFEST Modules | Updates every module listed in the MANIFEST file. Installs new custom modules, and uninstalls anything in the uninstall section |
| Update Installed | Updates the modules currently installed in the database, without consulting MANIFEST |
| Update Specific | Opens a picker so you can update a chosen set of modules only |
Update MANIFEST Modules installs anything newly listed and uninstalls
anything moved to the uninstall section:
Databases and dumps
| Action | What it does | |
|---|---|---|
| Backup | Creates a dump of the instance database including the filestore | |
| Backup w/o Filestore | Creates a dump without the filestore — faster and much smaller | |
| Restore | Restores a selected dump into this instance. See Database Backup and Restore | |
| Autobackup | Toggles automatic backups for this instance | |
| Snapshot | Takes a filesystem-level snapshot of the instance | Developer |
| Restore Snapshot | Restores a previously taken snapshot | Developer |
| Determine DB Size | Measures and records the current database size | |
| Shrink DB | Clears out bulk data from the database to reduce its size | Destructive |
| Reset DB | Wipes the database and rebuilds it empty | Developer · Destructive |
| Reset DB (Demo) | Wipes the database and rebuilds it with demo data. The quickest way to get a clean, predictable system to test a feature on | Developer · Destructive |
| Export Excel | Exports data from the instance as an Excel file |
Assets and appearance
| Action | What it does |
|---|---|
| Regenerate Assets | Rebuilds Odoo's web assets |
| Remove Web Assets | Stops Odoo, removes the generated web assets, and starts it again. Assets regenerate on next login. Use this for broken or stale CSS/JS |
| Restore Web Icons | Restores module web icons |
| Install Ribbon | Installs the environment ribbon, which labels the instance visibly in the Odoo UI |
Instance settings
These are toggles rather than one-off operations.
| Toggle | Effect |
|---|---|
| Active | Deactivates or reactivates the instance |
| Favorite | Marks the branch as a favourite for you |
| Dev Mode | Turns Odoo's developer mode on or off |
| I18N Updates | Controls whether translations are updated on module update |
| No Zodoo Pull | Prevents zCICD from pulling zodoo images for this instance |
| No Zodoo Push | Prevents zCICD from pushing zodoo images from this instance |
| Turn into DEV | Neutralises the database for development use: deactivates every scheduled action (ir.cron), and repoints all outgoing and incoming mail servers at the local test mail host. Requires DEVMODE=1 |
Maintenance and teardown
| Action | What it does | |
|---|---|---|
| Fix Filestore Permissions | Repairs filesystem permissions on the instance filestore | |
| Free Volumes (down -v) | Brings the instance down and removes its Docker volumes | Developer · Destructive |
| Delete Instance | Destroys the instance entirely. Requires typing the instance name to confirm | Developer · Destructive |
Turn into DEV exists because a database restored from production still
contains real mail servers and active cron jobs. Run it before working on any
instance seeded from production data, or the instance may send mail to real
customers. zodoo refuses to run it unless DEVMODE=1 is set, because the
database is not usable in production afterwards.
The project can extend what neutralisation does: any .sql file listed under
neutralize in MANIFEST, and any devscripts/turn-into-dev.sql, is applied
as well.