Skip to content

Documentation ​

Everything about Sudoo.sh, in one place. The same pages are on GitHub and inside the panel (sidebar, Help).


Start here ​

If you are...Read
New to the panelProject overview, then the User manual
A developer or maintainer (you keep instances up to date)User manual: sections 1 to 6
Installing Sudoo.sh, or running the serverAdministrator guide: one command installs everything
A super admin or administrator of the panelUser manual, then the Administrator guide
A developer connecting another system to an instanceAPI and webhooks
A developer changing the panelArchitecture, Design and Security
Reviewing securitySecurity

Find an answer ​

I want to...Where
Create an instanceUser manual: Creating an instance
Give a private repository to the serverUser manual: GitHub access
Get a developer's latest push into an instanceUser manual: Keeping the code up to date
Add an OCA repositoryUser manual: Submodules
Understand a status (Paused, Switched off...)User manual: Statuses
Read the charts on the Instances pageUser manual: The Instances page
Create an account or set a new passwordUser manual: Accounts and roles
Know which passwords are acceptedUser manual: Password rules
Find the current links after a restartAdministrator guide: Links
Choose how long an instance livesUser manual: Creating an instance, step 8
Restore an instance from a backupUser manual: The Backups card
Find or download a backup, or know when backups are takenUser manual: Backups and audit log
Change the time of the daily backupsUser manual: Settings, group Backups
Back up an instance or the panelAdministrator guide: Backups
Add a new Enterprise versionAdministrator guide: Enterprise add-ons
Fix a problemAdministrator guide: Troubleshooting
Call an instance from Python or PostmanAPI and webhooks
Create or restart instances from a CI pipeline or a scriptPanel API
Update instances the moment code is pushedPlugins: update triggers
Use open ports instead of Cloudflare, or keep Enterprise in gitPlugins
Install or buy a plugin from the marketplace, or link the panel to an accountMarketplace
Look up a settingConfiguration
Send sign-in codes from GmailAdministrator guide: E-mail
Change the look (colours, fonts, motion)Design
Know why something was built this wayArchitecture: Why we chose this

Concepts explained with examples ​

Short explanations of the ideas the panel is built on, written for people who have not met them before. Each one starts with an everyday comparison, then shows what it looks like on our server.

ConceptIn one sentence
TunnelingHow a server that accepts no incoming connections can still have a public https link.
Docker and containersHow many Odoo versions run side by side on one server without disturbing each other.
The gateway (reverse proxy)The small program in front of every instance that records visits and wakes paused instances.
Deploy keysHow the server reads a private GitHub repository without anyone's password or token.
Git submodulesHow one repository includes others, such as OCA module collections.
Passwords and encryptionWhy panel passwords are hashed, why other secrets are encrypted, and the difference.
Web attacks and how the panel stops themPassword guessing, forged requests, injected scripts and commands, with examples.

All documents ​

DocumentContents
Project overviewWhat the panel does, technologies and what we gain from them, components, installation
User manualEvery page and button, step by step
Administrator guideServer, installation, settings, files, links, backups, Enterprise, troubleshooting
API and webhooksOdoo's APIs through an instance's link, with examples
ArchitectureComponents, request flow, life of an instance, decisions and their reasons
SecurityWhat is protected, how, and what is not
ConfigurationEvery setting, with its type and default
PerformanceHow fast the panel and the gateway are, how it is measured, and what keeps them fast
PluginsChoosing how instances are reached and where Enterprise comes from; writing your own
MarketplaceInstalling and buying plugins, licences, the hub connection, what is protected