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 panel | Project 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 server | Administrator guide: one command installs everything |
| A super admin or administrator of the panel | User manual, then the Administrator guide |
| A developer connecting another system to an instance | API and webhooks |
| A developer changing the panel | Architecture, Design and Security |
| Reviewing security | Security |
Find an answer
| I want to... | Where |
|---|---|
| Create an instance | User manual: Creating an instance |
| Give a private repository to the server | User manual: GitHub access |
| Get a developer's latest push into an instance | User manual: Keeping the code up to date |
| Add an OCA repository | User manual: Submodules |
| Understand a status (Paused, Switched off...) | User manual: Statuses |
| Read the charts on the Instances page | User manual: The Instances page |
| Create an account or set a new password | User manual: Accounts and roles |
| Know which passwords are accepted | User manual: Password rules |
| Find the current links after a restart | Administrator guide: Links |
| Choose how long an instance lives | User manual: Creating an instance, step 8 |
| Restore an instance from a backup | User manual: The Backups card |
| Find or download a backup, or know when backups are taken | User manual: Backups and audit log |
| Change the time of the daily backups | User manual: Settings, group Backups |
| Back up an instance or the panel | Administrator guide: Backups |
| Add a new Enterprise version | Administrator guide: Enterprise add-ons |
| Fix a problem | Administrator guide: Troubleshooting |
| Call an instance from Python or Postman | API and webhooks |
| Create or restart instances from a CI pipeline or a script | Panel API |
| Update instances the moment code is pushed | Plugins: update triggers |
| Use open ports instead of Cloudflare, or keep Enterprise in git | Plugins |
| Install or buy a plugin from the marketplace, or link the panel to an account | Marketplace |
| Look up a setting | Configuration |
| Send sign-in codes from Gmail | Administrator guide: E-mail |
| Change the look (colours, fonts, motion) | Design |
| Know why something was built this way | Architecture: 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.
| Concept | In one sentence |
|---|---|
| Tunneling | How a server that accepts no incoming connections can still have a public https link. |
| Docker and containers | How 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 keys | How the server reads a private GitHub repository without anyone's password or token. |
| Git submodules | How one repository includes others, such as OCA module collections. |
| Passwords and encryption | Why panel passwords are hashed, why other secrets are encrypted, and the difference. |
| Web attacks and how the panel stops them | Password guessing, forged requests, injected scripts and commands, with examples. |
All documents
| Document | Contents |
|---|---|
| Project overview | What the panel does, technologies and what we gain from them, components, installation |
| User manual | Every page and button, step by step |
| Administrator guide | Server, installation, settings, files, links, backups, Enterprise, troubleshooting |
| API and webhooks | Odoo's APIs through an instance's link, with examples |
| Architecture | Components, request flow, life of an instance, decisions and their reasons |
| Security | What is protected, how, and what is not |
| Configuration | Every setting, with its type and default |
| Performance | How fast the panel and the gateway are, how it is measured, and what keeps them fast |
| Plugins | Choosing how instances are reached and where Enterprise comes from; writing your own |
| Marketplace | Installing and buying plugins, licences, the hub connection, what is protected |