Features
Odoo branch instances on your own server, feature by feature
You are deciding whether Sudoo.sh can replace Odoo.sh staging builds, or a set of scripts on a test server, for your team. This page lists what the panel does today for Odoo branch instances, how it compares with Odoo.sh and where its limits are.
Odoo staging, demo and test instances from any Git branch
Choose a GitHub repository, a branch, the Odoo version and the edition. The panel does the rest.
- Any version
- Every published Odoo version from 16.0 is offered, and new versions appear by themselves. Community or Enterprise.
- Generated for you
- The instance's name, database, ports and passwords. About two minutes later the panel shows its link and login.
- Guided creation
- Repository checks, a branch list, a preview of the name and warnings when a quota is near.
- Everyday actions
- Restart, pause, switch off and delete, from the list or the instance's page. Deleting leaves nothing behind.
- Lifetime
- Each instance can be deleted automatically a set number of days after it was created (30 by default), or kept.
One https link per instance
Browsers, API clients and webhook senders reach every instance like any Odoo address.
- No open port
- With the default exposure plugin each instance gets a free Cloudflare quick tunnel, https included, and the server accepts no incoming connections.
- Fixed addresses
- The host-ports plugin serves instances on open ports instead, for servers that can accept connections.
- Odoo as usual
- JSON-RPC, XML-RPC, the JSON-2 API with an API key, incoming webhooks, uploads, downloads and WebSockets work through the link.
Updates from GitHub on every push
When a developer pushes, the instance follows on its own.
- Updates on push
- The instance pulls the code, upgrades only the modules whose files changed and restarts.
- Two triggers
- Poll GitHub every 2 minutes, or receive a GitHub webhook within seconds of a push. Use either or both.
- Submodules
- Update, add and remove submodules, for example OCA repositories, from the panel.
- Private repositories
- Each private repository gets its own read-only deploy key, created by the panel and stored encrypted. No personal tokens.
Auto-pause saves memory
A running Odoo takes about 1 to 1.5 GB of memory. Instances nobody uses give it back.
- Auto-pause
- An instance nobody opened for 6 hours is paused. The time is a setting.
- Wake on visit
- Opening the link starts it again: a short "Starting up" page shows for a few seconds.
Daily Odoo backups and restore
Standard Odoo backups (database and files) that Odoo itself can restore.
- Daily
- Every instance used during the day is backed up once a day, at a time you choose, keeping its latest daily backup.
- Before deletion
- Before any deletion, automatic or by hand, the instance is saved and listed under Backups.
- Restore the latest
- One button on the instance's page puts a backup back in a minute or two, after saving the current state so the restore can be undone.
- Back up now
- Make a backup at any time from the instance's page.
Live figures and charts
Know what the server and every instance are doing, without opening a terminal.
- Every 5 seconds
- Processor, memory, disk, requests per minute, error rate and response times of the server and every instance, with an hour of history.
- Instances page
- Figure cards with a one-hour line, requests and errors of all instances, instances by state, response time and the busiest instances.
- Pages that keep up
- Pages update by themselves as things change, through a live event stream.
Accounts, roles and second factors
Give each person the access they need, and see who did what.
- Five roles
- Super admin, administrator, maintainer, developer and viewer, each a set of named permissions checked on the server for every request.
- Sign-in
- With the e-mail address. Passwords follow NIST SP 800-63B: length and a blocklist, no forced symbols.
- Second factors
- An authenticator app or a code by e-mail, which can be required for administrators or everyone.
- Audit log
- Every sign-in, refusal and action is recorded.
- Limits
- Requests per minute per user or address, and how many instances can be created, by whom and how often.
An API for other systems
Every function of the panel is in one REST API at /api/v1.
- Signed requests
- An API token plus an HMAC-SHA256 signature over the timestamp, a single-use nonce, the method, the path and the body.
- Scopes
- Read, write, and Instances: a narrow token for connected apps such as the Odoo apps, which can only manage instances. Tokens are managed in the panel or from the command line.
- Live events
- Server-Sent Events push job progress, instance status and figures, and resume after a lost connection.
- A reference client
- A dependency-free Python client in the repository's examples.
Set up from the website
Install with one command, then configure everything in the browser.
- One command
- Installs Docker if needed and the latest release. Run it again to update; instances, accounts, keys and settings are kept.
- Settings page
- Second factors, limits, backups, the e-mail account that sends sign-in codes and more, on top of the base values in .env.
- Explains itself
- Plain-language messages when something fails, the technical log next to them, and the documentation inside the panel under Help.
- Your look
- Light and dark themes, and your own accent colour.
Inside Odoo
Manage instances from your company's Odoo
Free apps on the Odoo Apps store, for Odoo 17.0 to 20.0 and in English and Arabic. Sales, consultants and support create instances from the record that needs them, within the limits an administrator sets.
-
Sudoo.sh Instance Manager
Create, start, pause, back up and delete instances from Odoo. Administrators decide what people may create.
The base of every app
On the Odoo Apps store : Sudoo.sh Instance Manager -
Sudoo.sh CRM Demos
A Create demo button on opportunities: a live Odoo for every prospect.
Needs CRM
On the Odoo Apps store : Sudoo.sh CRM Demos -
Sudoo.sh Project Tests
A Test instance button on tasks: review the task's branch on a live Odoo.
Needs Project
On the Odoo Apps store : Sudoo.sh Project Tests -
Sudoo.sh Helpdesk Tests
A Test instance button on tickets: reproduce a problem and check the fix.
Needs Helpdesk (Enterprise)
On the Odoo Apps store : Sudoo.sh Helpdesk Tests
All Sudoo.sh apps on the Odoo Apps store · Source and documentation on GitHub. They need a Sudoo.sh panel and an API token with the Instances scope.
Compared
Sudoo.sh as a self-hosted Odoo.sh alternative
Sudoo.sh is to your own server what Odoo.sh is to Odoo's cloud. It is an independent project, not affiliated with Odoo S.A.
| Topic | Odoo.sh | Sudoo.sh |
|---|---|---|
| Where it runs | Odoo's cloud | Your server (one Docker host) |
| A running Odoo per branch | Yes | Yes, Community or Enterprise, any version from 16.0 |
| Updates on push | Yes | Yes: GitHub webhook or polling |
| Unused instances | Staging builds expire | Pause when unused, wake on the next visit |
| How instances are reached | *.odoo.com | Free Cloudflare tunnels, open ports, or your own exposure plugin |
| API for automation | — | Signed REST API |
| Production hosting | Yes | No: for development, demos, tests and training |
Good to know
Known limitations
- With the default Cloudflare quick tunnels, links change after a restart of the server or of a connector.
- Quick tunnels carry at most 100 MB per request, end requests longer than about 100 seconds and have no uptime guarantee.
- About 1 to 1.5 GB of memory per running instance; on a 3 GB server, keep one or two running and let the others pause.
- Python libraries listed in a module's requirements.txt are not in the official Odoo image.
- An instance's major Odoo version cannot be changed; create a new instance for another version.
- The encryption key is on the same server as the secrets it protects: it protects copies and backups, not a server someone already controls.
The full picture is in the documentation and the project's README.
Try it on a server you already have
A branch becomes a running Odoo with its own https link in about two minutes. The server needs Linux, at least 2 GB of memory and 20 GB of free disk, and no open port with the default tunnels.
curl -fsSL https://github.com/Sudoo-sh/sudoo.sh/releases/latest/download/sudoo-install.sh | sudo bash