Skip to content

Configuration ​

Audience: administrators of the server. Covers: every setting of the panel, with its type, default, meaning, and where and when it can be changed.

The defaults are environment variables, kept in /opt/odoo/manager/.env on the server (.env.example is the template). Almost every setting can also be changed on the panel's Settings page by a super admin (or with PATCH /api/v1/settings, see Panel API). Such a change is kept in /opt/odoo/manager/settings.json on top of .env; Use .env on the page brings back the .env value.

The Applies column of each table says how a change takes effect:

AppliesChanged whereTakes effect
liveSettings page or .envOn the Settings page: at once, without a restart.
restartSettings page or .envThese settings choose plugins. On the Settings page: after Restart the panel (Settings, Advanced), which stops only the backend for a few seconds and is refused while jobs run.
.env only.env onlyFolders, ports, the exposure and the storage, which the web service and the containers read too. The Settings page lists them, read-only, under Advanced, Server.

A change made in .env itself (any class) applies when the containers are recreated: cd /opt/odoo/manager && docker compose up -d. A value changed on the Settings page wins over .env until it is reset with Use .env.

  • Names are not case sensitive. A wrong value (for example IDLE_HOURS=soon) stops the panel at start-up with a message naming the setting; on the Settings page it is refused with the same message.
  • See what the panel actually uses: docker exec sudoo-panel sudoo.sh config.
  • The settings are defined in src/sudoo/config.py (the lists EDITABLE, RESTART and SECRET); a test fails when one of them is missing here.
  • Secret settings (SMTP_PASSWORD, ODOO_ADMIN_PASSWORD, GITHUB_WEBHOOK_SECRET, the alert webhooks' addresses and secrets) are write-only on the Settings page: it only shows whether they are set. Changed there, they are stored encrypted with the vault key (Security).

Contents ​

  1. Contact
  2. Odoo
  3. Instance containers
  4. Enterprise add-ons (plugin)
  5. Exposure (plugin)
  6. Code updates (plugins)
  7. Storage, sign-in and e-mail (plugins)
  8. Limits
  9. Gateway
  10. Ports
  11. Behaviour
  12. Alerts
  13. Marketplace
  14. Locations

Contact ​

SettingTypeDefaultAppliesMeaning
ADMIN_CONTACT_NAMEstrthe administratorliveWho users are told to contact.
ADMIN_CONTACT_PHONEstremptylivePhone number added to that message.
ADMIN_CONTACT_EMAILstremptyliveE-mail address added to that message.
BRAND_COLORstr#714B67liveAccent colour of the web app and of e-mails (title mark, buttons), as #RRGGBB.

Odoo ​

SettingTypeDefaultAppliesMeaning
ODOO_VERSIONSstrautoliveVersions offered: "auto" (every published version of the official image from odoo_min_version) or a comma-separated list such as 17.0,18.0,saas-18.2.
ODOO_MIN_VERSIONstr16.0liveOldest version offered when odoo_versions is "auto".
PREPULL_IMAGESboolfalseliveDownload the Odoo image of every offered version, and the PostgreSQL image, in the background (checked every 30 minutes), so the first instance of a version does not wait for the download. Only missing images are downloaded; each Odoo image takes 1-3 GB of disk.
ODOO_IMAGEstrodooliveDocker image of Odoo; the tag is the Odoo version. Used for instances created after the change.
POSTGRES_IMAGEstrpostgres:16liveDocker image of each instance's database. Used for instances created after the change.
ODOO_ADMIN_PASSWORDstradminlivePassword of the Odoo user "admin" in new instances. Secret: write-only on the Settings page.

An instance keeps the images it was created with, pinned by digest; Update Odoo and PostgreSQL images on its page refreshes them (same names and tags). See Administrator guide.


Instance containers ​

Limits of each instance's odoo and db containers, and what happens when they are changed outside the panel. Changed limits reach an instance the next time it starts or restarts through the panel; running instances are not restarted for them. What the containers are allowed to do: Security.

SettingTypeDefaultAppliesMeaning
ODOO_MEMORY_LIMITstr2gliveMemory one instance's Odoo container may use, in Docker units (512m, 2g); 0: no limit.
ODOO_CPU_LIMITfloat2liveProcessor cores one instance's Odoo may use; 0: no limit.
DB_MEMORY_LIMITstr1gliveMemory one instance's database container may use, in Docker units; 0: no limit.
DB_CPU_LIMITfloat2liveProcessor cores one instance's database may use; 0: no limit.
CONTAINER_PIDS_LIMITint1024liveProcesses and threads one instance container may run at the same time (at least 64).
CONTAINER_LOG_MAX_SIZEstr10mliveSize of a container's log file before it is rotated (k, m or g).
CONTAINER_LOG_MAX_FILESint3liveRotated log files kept per container (1 to 20).
DRIFT_ACTIONstrrestoreliveWhen an instance's containers or files were changed outside the panel: warn reports it (audit log, banner, e-mail to super admins); restore reports it and then recreates Odoo and its database from the panel's own configuration, backing the database up first when its container is affected. Connectors and .env are only ever reported.

The memory of an in-memory /tmp counts towards the container's memory limit; very large uploads to Odoo need room there.


Enterprise add-ons (plugin) ​

SettingTypeDefaultAppliesMeaning
ENTERPRISE_SOURCEstrfolderrestartWhere Enterprise add-ons come from: "folder", "git" or "none".
ENTERPRISE_PATHstr/opt/odoo/enterprise/{version}livefolder source: where the add-ons of a version are; {version} (19.0) and {major} (19) are replaced.
ENTERPRISE_GIT_URLstremptylivegit source: repository holding one branch per Odoo version. An address with a user name or password in it (https://user:token@...) is refused: use an SSH address such as git@github.com:my-company/odoo-enterprise.git with a deploy key under GitHub access.
ENTERPRISE_GIT_BRANCHstr{version}livegit source: branch name of a version, e.g. {version}.
ENTERPRISE_MARKERstrweb_enterpriseliveModule whose presence proves the add-ons are there.

Exposure (plugin) ​

SettingTypeDefaultAppliesMeaning
EXPOSUREstrcloudflare-quick.env onlyHow instances are reached: "cloudflare-quick" or "host-ports".
PUBLIC_HOSTstrempty.env onlyhost-ports: the server's public name or address.
PUBLIC_SCHEMEhttp or httpshttp.env onlyhost-ports: scheme of the public addresses.
CLOUDFLARED_IMAGEstrcloudflare/cloudflared:latestlivecloudflare-quick: connector image, used for connectors started after the change.
CONNECTOR_PREFIXstrsudoo-connector-.env onlycloudflare-quick: container name prefix.
CONNECTOR_STATUS_PORT_STARTint20300.env onlycloudflare-quick: first status port of a connector.
PANEL_CONNECTOR_STATUS_PORTint20242.env onlycloudflare-quick: status port of the panel connector.

Code updates (plugins) ​

SettingTypeDefaultAppliesMeaning
UPDATE_TRIGGERSstrpolling,github-apprestartWhat starts code updates, comma-separated: "polling", "github-app" (the GitHub App's webhook), "github-webhook" (one webhook per repository). See Plugins.
GITHUB_WEBHOOK_SECRETstremptylivegithub-webhook: the secret entered on GitHub (20 or more random characters). Secret: write-only on the Settings page.
POLL_MINUTESfloat2livepolling: check GitHub for new commits this often.

Storage, sign-in and e-mail (plugins) ​

SettingTypeDefaultAppliesMeaning
STORAGEstrsqlite.env onlyWhere the panel keeps its own data (accounts, tokens, audit log, instance state): sqlite, the file /opt/odoo/manager/sudoo.db.
AUTHstrlocalrestartHow user names and passwords are checked: local, the panel's own accounts.
SECOND_FACTORSstremail,totprestartSecond factors offered, comma-separated: email (a code by e-mail; only when e-mail is set up) and totp (an authenticator app).
REQUIRE_SECOND_FACTORstradminsliveWho must use a second factor: none, admins (super admins and administrators) or everyone. Such accounts without one can only set one up after signing in.
SESSION_IDLE_MINUTESfloat60livePanel sign-out after this long without activity.
SESSION_MAX_HOURSfloat12liveLongest panel session.
MAILERstrsmtprestartHow the panel sends e-mail: smtp or none.
MAIL_FROMstremptyliveSender, for example Sudoo.sh <no-reply@your-site.com>; empty: SMTP_USERNAME.
SMTP_HOSTstremptyliveThe mail server, for example mail.your-site.com. Empty: no e-mail, and no e-mail codes.
SMTP_PORTint587live587 with starttls, 465 with ssl.
SMTP_SECURITYstrstarttlslivestarttls, ssl or none (only for a mail server on the same machine).
SMTP_USERNAMEstremptyliveUsually the full address of the mailbox.
SMTP_PASSWORDstremptyliveIts password (often an "app password"). Secret: write-only on the Settings page.
MAIL_TEMPLATES_DIRstremptyliveA folder with e-mail templates (layout.html, code.html, code.txt, ...) that replace the built-in ones of the same name (src/sudoo/mail/templates/).

E-mails are HTML in the style of Odoo's own (a white card, the title on the left, the product name on the right, a button and a footer), with a plain-text version for mail programs that show text only. Sign-in codes also say when, from which address and which browser they were asked for. The code can be selected with one tap; Gmail's apps also offer their own Copy code button.

Gmail ​

  1. On the Google account that will send the e-mails, turn on 2-Step Verification (myaccount.google.com, Security).

  2. Create an app password: myaccount.google.com/apppasswords, name it Sudoo.sh. Google shows 16 letters once.

  3. In the panel, open Settings, then E-mail, and enter:

    FieldValue
    Mail serversmtp.gmail.com
    Port587
    EncryptionSTARTTLS
    User nameyour Gmail address
    Passwordthe app password
    SenderSudoo.sh <your.address@gmail.com>

    Click Save, then Send a test and enter an address to send the test e-mail to. The changes apply at once.

  4. Or put the same values in /opt/odoo/manager/.env:

    MAILER=smtp
    SMTP_HOST=smtp.gmail.com
    SMTP_PORT=587
    SMTP_SECURITY=starttls
    SMTP_USERNAME=your.address@gmail.com
    SMTP_PASSWORD=the16letterapppassword
    MAIL_FROM=Sudoo.sh <your.address@gmail.com>

    and apply and test them on the server:

    cd /opt/odoo/manager && docker compose up -d
    docker exec sudoo-panel sudoo.sh test-email you@example.com

Gmail sends from the signed-in address (or an alias added under Gmail's Send mail as), at most about 500 messages a day for a personal account. With Google Workspace on your own domain, use the domain's address. When the test fails, the message shows the mail server's answer; for Gmail the password must be an app password, not the account's password.

Your website's mailbox ​

The same fields on the Settings page, or in .env:

MAIL_FROM=Sudoo.sh <no-reply@your-site.com>
SMTP_HOST=mail.your-site.com
SMTP_USERNAME=no-reply@your-site.com
SMTP_PASSWORD=...

Limits ​

SettingTypeDefaultAppliesMeaning
RATE_LIMITERstrmemoryrestartWhere request counts are kept: memory.
RATE_LIMIT_READS_PER_MINUTEint600liveRequests that read, per minute, per signed-in user or API token (per address before signing in); 0: no limit.
RATE_LIMIT_CHANGES_PER_MINUTEint60liveRequests that change something, per minute, counted the same way; 0: no limit.
MAX_INSTANCESint0liveInstances on this server at most, those being created included; 0: no limit.
MAX_INSTANCES_PER_USERint0liveInstances one person or API token may have created (or be creating) and not yet deleted; 0: no limit.
CREATE_COOLDOWN_MINUTESfloat0liveMinutes one person or token must wait between two creations, for example 60; 0: no wait.

Answers over a request limit are 429 Too Many Requests with Retry-After; every limited answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.

Capacity ​

How many instances the server runs comfortably at the same time, and when the panel warns. The panel never refuses an instance because of these figures unless MAX_RUNNING_INSTANCES is set; how the estimate is made: How many instances can my server run?.

SettingTypeDefaultAppliesMeaning
CAPACITY_RESERVE_MBint1024liveMemory kept free for the operating system, Docker and the file cache, in MB. The larger of this and CAPACITY_RESERVE_PERCENT is used.
CAPACITY_RESERVE_PERCENTfloat10liveThe same reserve as a share of the server's memory, 0 to 90.
CAPACITY_INSTANCE_MEMORY_MBint700liveMemory one running instance is counted with until the panel has measured one (a few measurements of a running instance in the last hour), in MB.
CAPACITY_WARNING_PERCENTfloat85liveServer memory use, in %, from which the dashboard warns that instances may slow down; also the share of the processor the estimate lets instances use.
MAX_RUNNING_INSTANCESint0liveInstances running at once at most, those being created or started included: creating or starting one more (in the panel or the API) is refused with 403. Visitors opening a paused instance still start it. 0: never refused, only warned.

Gateway ​

Where the gateway in front of every instance runs, and what it accepts from visitors (Gateway). Request bodies are passed on to Odoo piece by piece as they arrive, so an upload never sits whole in memory; these limits keep one visitor from tying up the gateway that every instance shares.

With GATEWAY_MODE=service the gateway runs in its own container, sudoo-gateway, which has no .env: the panel hands it the values below (also those changed in the panel) through <ODOO_ROOT>/gateway/routes.json within two seconds. Set them in the panel's .env or in the panel, as always.

SettingTypeDefaultAppliesMeaning
GATEWAY_MODEtextservice.env onlyWhere the gateways run. service: in their own container (sudoo-gateway, in compose.yaml), so the instances keep answering while the panel restarts or is down; while that container is not running, the panel serves the instances itself. embedded: inside the panel process, as before version 3.0 (the instances stop answering while the panel restarts; a sudoo-gateway container that runs gives the ports back and stays idle). Switching either way needs no connector restart: see Administrator Guide, section 8.
GATEWAY_TAKEOVER_SECONDSfloat10.env onlyservice only: seconds the gateway service may not answer the panel (2 to 600) before the panel serves the instances itself. When the service stopped normally, the panel takes over at once.
GATEWAY_MAX_UPLOAD_MBint2048liveLargest request body a visitor may send to an instance (file uploads, imports), in MB. Larger ones get 413 Content Too Large before Odoo sees them.
GATEWAY_IDLE_TIMEOUT_SECONDSfloat120liveSeconds a visitor may send nothing while sending a request body (5 to 3600); then the gateway answers 408 Request Timeout and frees the connection.
GATEWAY_WEBSOCKET_MAX_MESSAGE_MBint16liveLargest single WebSocket message passed to or from Odoo (Odoo's own live updates are far smaller); a larger one closes that connection (code 1009).
GATEWAY_HEADER_TIMEOUT_SECONDSfloat30.env onlySeconds a visitor's connection has to send a request's line and headers (1 to 3600), counted from when it opens and again after every answer; then the gateway closes it. Requests being answered are not affected: long polling, WebSockets and slow uploads (see GATEWAY_IDLE_TIMEOUT_SECONDS) keep going.
GATEWAY_MAX_CONNECTIONSint1000.env onlyVisitors' connections open at once to one instance's gateway. A new one beyond it is answered 503 Service Unavailable (Retry-After: 5) and closed. A browser tab of Odoo uses up to about 7.
GATEWAY_MAX_CONNECTIONS_TOTALint4000.env onlyVisitors' connections open at once to all gateways together; beyond it, the same 503. Each one can use two of the panel's open files (the visitor's and the one to Odoo): keep this well below the open-files limit of the process that runs the gateways (ulimit -n in the sudoo-gateway container, or sudoo-panel with GATEWAY_MODE=embedded).

Ports ​

SettingTypeDefaultAppliesMeaning
PANEL_PORTint9000.env onlyPort of the panel: the web app (container sudoo-web) listens here.
API_PORTint9002.env onlyPort of the backend (container sudoo-panel), on 127.0.0.1 only; the web app forwards /api, /hooks and /docs to it.
EVENTS_PORTint9001.env onlyPort of the live event stream (/api/v1/events), on 127.0.0.1 only.
GATEWAY_PORT_STARTint8069.env onlyFirst gateway port (one per instance).
ODOO_PORT_STARTint28069.env onlyFirst Odoo port (one per instance, 127.0.0.1 only).

Behaviour ​

SettingTypeDefaultAppliesMeaning
IDLE_HOURSfloat6livePause an instance after this many hours without visits; 0: never.
AUTO_PAUSEbooltrueliveNew instances pause when idle (each instance can change it).
AUTO_UPDATEbooltrueliveNew instances get new code from their branch automatically.
AUTO_UPGRADEbooltrueliveNew instances upgrade changed modules after an update.
DELETE_AFTER_DAYSint30liveLifetime offered for new instances, in days; 0: keep.
METRICS_INTERVAL_SECONDSfloat5liveSeconds between two measurements of the server and the instances (2 to 60). One hour of figures is kept.
DAILY_BACKUPSbooltrueliveOnce a day, back up every instance that was used since its last daily backup. Each instance keeps only its latest daily backup; they are removed when the instance is deleted.
DAILY_BACKUP_TIMEtext00:00liveWhen the daily backups run, HH:MM on a 24-hour clock, in TIMEZONE.
TIMEZONEtextUTCliveTime zone of DAILY_BACKUP_TIME and of the times in backup names shown in the panel, for example Africa/Cairo.
ROLLBACK_HOURSfloat24liveAfter a restore, the state the instance had before it is kept this many hours (up to 720), and the instance page offers Rollback meanwhile. Then that backup is removed.
SAFE_UPDATESbooltrueliveBefore an update that changes an instance's code (a push to its branch, Get latest code, Update submodules), back up its database and files (kind before-update); if the update then fails, put the previous code back, restore that backup when the database may have changed, and start Odoo again. false: updates run as before, without the backup and the automatic rollback. See Keeping the code up to date.

Stages ​

What the stage of an instance changes (production, staging, development; see Stages). A development instance follows the settings above exactly. A production instance is never paused or deleted automatically, is backed up every day whatever DAILY_BACKUPS says (even when nobody used it), and is always updated with SAFE_UPDATES behaviour.

SettingTypeDefaultAppliesMeaning
MAX_PRODUCTION_INSTANCESint1liveInstances that may be in production at the same time, those being created as production included. Creating one more, or moving one more to production, is refused with 409. 0: no limit.
PRODUCTION_AUTO_UPDATEboolfalseliveNew production instances get new code from their branch automatically. Off: a production instance gets new code only when someone asks (Get latest code), or once Get new code automatically is switched on for it.
STAGING_DELETE_AFTER_DAYSint90liveLifetime offered for new staging instances, in days; 0: keep.
STAGING_DAILY_BACKUPSbooltrueliveStaging instances get the daily backup too (while DAILY_BACKUPS is on). false: only their manual and safety backups.

Alerts ​

Who is told when something needs attention, about what, and how often. How alerts work, their e-mails, webhooks and the bell: Admin guide, Alerts. All of them are on the Settings page, Alerts tab, with Send a test alert for the e-mail and each webhook.

SettingTypeDefaultAppliesMeaning
ALERTSbooltrueliveSend alerts at all. false: no alert is sent, listed in the bell or kept.
ALERT_SUPER_ADMINSbooltrueliveE-mail alerts to every super admin who has an e-mail address.
ALERT_EMAILStextemptyliveMore addresses that receive alert e-mails, comma-separated (an on-call mailbox, say); at most 50.
ALERT_JOB_FAILEDbooltrueliveA job failed: its plain hint (the one the panel shows) and a link to its log.
ALERT_UPDATE_FAILEDbooltrueliveAn update failed and the instance was put back (SAFE_UPDATES), or putting it back failed too. Such a job sends this alert instead of ALERT_JOB_FAILED.
ALERT_BACKUP_FAILEDbooltrueliveA backup job (manual or daily) failed. Sent instead of ALERT_JOB_FAILED.
ALERT_INSTANCE_DOWNbooltrueliveAn instance that should run (not paused, not switched off, no job on it) is stopped, or runs without Odoo answering, for ALERT_INSTANCE_DOWN_MINUTES.
ALERT_INSTANCE_DOWN_MINUTESfloat5liveMinutes it must stay down before the alert (1 to 1440).
ALERT_DISKbooltrueliveThe disk holding ODOO_ROOT has less than ALERT_DISK_FREE_PERCENT free.
ALERT_DISK_FREE_PERCENTfloat10liveFree disk, in %, below which the alert is sent (1 to 90).
ALERT_MEMORYbooltrueliveServer memory stays at or above CAPACITY_WARNING_PERCENT for ALERT_MEMORY_MINUTES.
ALERT_MEMORY_MINUTESfloat10liveMinutes memory must stay high before the alert (1 to 1440).
ALERT_DRIFTbooltrueliveAn instance's containers or files were changed outside the panel (DRIFT_ACTION).
ALERT_PUBLIC_LINKbooltrueliveThe panel, or an instance that is online, has had no public link for ALERT_PUBLIC_LINK_MINUTES (its connector stopped, say).
ALERT_PUBLIC_LINK_MINUTESfloat10liveMinutes without a public link before the alert (1 to 1440).
ALERT_RECOVERYbooltrueliveSend a notice when a problem that was alerted is over: back online, disk freed, memory normal, link back.
ALERT_QUIET_MINUTESfloat60liveThe same alert (same kind, same instance) is sent at most once in this many minutes; a repeat inside it only counts up on the alert in the bell. 0: every time (0 to 10080).
ALERT_DIGESTboolfalseliveE-mail one summary a day, at ALERT_DIGEST_TIME, instead of each alert as it happens. Webhooks and the bell still get each alert at once.
ALERT_DIGEST_TIMEtext08:00liveWhen the daily summary is sent, HH:MM on a 24-hour clock, in TIMEZONE.
ALERT_WEBHOOK_TIMEOUT_SECONDSfloat10liveSeconds a webhook may take to answer before the delivery counts as failed (1 to 60).
ALERT_WEBHOOK_1_URLtextemptyliveWebhook 1: the address alerts are posted to. https:// only (http:// only for localhost); no user name or password in it. Secret: write-only on the Settings page.
ALERT_WEBHOOK_1_SECRETtextemptyliveWebhook 1: key of the X-Sudoo-Signature header (HMAC-SHA256 of the body). Empty: requests are not signed. Secret.
ALERT_WEBHOOK_1_FORMATtextjsonliveWebhook 1: json (the panel's own signed JSON), slack, discord or teams (their incoming webhooks).
ALERT_WEBHOOK_2_URLtextemptyliveWebhook 2: as webhook 1. Secret.
ALERT_WEBHOOK_2_SECRETtextemptyliveWebhook 2: as webhook 1. Secret.
ALERT_WEBHOOK_2_FORMATtextjsonliveWebhook 2: as webhook 1.
ALERT_WEBHOOK_3_URLtextemptyliveWebhook 3: as webhook 1. Secret.
ALERT_WEBHOOK_3_SECRETtextemptyliveWebhook 3: as webhook 1. Secret.
ALERT_WEBHOOK_3_FORMATtextjsonliveWebhook 3: as webhook 1.

Marketplace ​

How the panel talks to the Sudoo.sh hub, which lists plugins, sells paid ones and signs every package. See Marketplace.

SettingTypeDefaultAppliesMeaning
MARKETPLACEbooloffliveOff by default until the marketplace opens. on: register with the hub, send a signed heartbeat every 15 minutes (version, core hash, fingerprint, installed plugins and coarse server figures) and install plugins from the Plugins page. off: the panel never contacts the hub; installed free plugins keep working, paid ones stop at their run_until (the last lease's end plus 96 hours, about 7 days).
HUB_URLtexthttps://hub.sudoo.sh.env onlyThe hub's address: https:// (http:// only for localhost while testing). The panel registers with each hub it is pointed at.
HUB_PUBLIC_KEYStextempty.env onlyThe hub's root public keys (Ed25519, base64url, comma-separated). Every answer, lease, command and package must be signed by one of them, or by a newer key one of them endorsed. Empty: the keys this release ships for hub.sudoo.sh; for another hub (while testing), the keys it lists the first time the panel reaches it.

Locations ​

SettingTypeDefaultAppliesMeaning
ODOO_ROOTPath/opt/odoo.env onlyFolder that holds instances, backups and panel data.
DOCS_DIRPath/app/documentation.env onlyREADME.md and docs/ shown in the panel.
MEMORY_DIRPath/dev/shm.env onlyMemory-backed folder for secrets needed briefly as files.