From 727c565834a782111b7dc7d51e4043122d466bd9 Mon Sep 17 00:00:00 2001 From: andrewthomaslee Date: Thu, 12 Nov 2026 16:02:47 -0600 Subject: [PATCH] docs: CEO: Odoo page and deck for non-technical users A plain-English guide to the beelink Odoo test setup for a non-technical reader: what Odoo, beelink and Mailpit are, the addresses, logging in, a first quote-to-invoice test read back in Mailpit, and asking for resets and snapshots. Its own slide deck (slides/ceo-odoo.html) sits next to the repo deck; the docs build inlines it like slides.md. Co-Authored-By: Claude Opus 5.5 --- documentation/docs/ceo-odoo.md | 161 +++++++++++++++++++++++++++++ documentation/docs/odoo.md | 3 +- documentation/flake-module.nix | 1 + documentation/slides/ceo-odoo.html | 42 ++++++++ documentation/slides/ceo-odoo.md | 142 +++++++++++++++++++++++++ 5 files changed, 348 insertions(+), 1 deletion(-) create mode 100644 documentation/docs/ceo-odoo.md create mode 100644 documentation/slides/ceo-odoo.html create mode 100644 documentation/slides/ceo-odoo.md diff --git a/documentation/docs/ceo-odoo.md b/documentation/docs/ceo-odoo.md new file mode 100644 index 0000000..2e39bbe --- /dev/null +++ b/documentation/docs/ceo-odoo.md @@ -0,0 +1,161 @@ +# CEO: Odoo + +A plain-English guide to the Odoo test setup: what it is, how to open +it, and how to try things in it without breaking anything that matters. +No technical background needed. The [technical page](odoo.md) is for +whoever runs the machine. + + + +

Open the slides full screen +(arrow keys to move, F for full screen).

+ +## The short version + +- **Odoo** is a business application: sales, CRM, invoicing, inventory, + projects, all in one place, used through a web browser. +- **beelink** is a small computer in the house. It runs Odoo for + **testing only**. No customer, supplier or bank ever sees it. +- **Mailpit** is a pretend mailbox. Every email Odoo "sends" lands there + instead of going out, so you can read it, and nobody else gets it. +- Anything you do can be **wiped and started fresh in seconds**. You + cannot break it in a way that lasts. + +!!! tip "If you remember one thing" + This is a sandbox. Click everything. Send the invoice. Delete the + customer. Nothing leaves the house, and it can all be put back. + +## If you know a LAMP server + +You have run this shape before. Same idea, newer parts: + +| The classic setup | Here | +| --- | --- | +| A server in the back room | beelink, a mini PC on the home network | +| Apache serving the site | nginx, a web server that does the same job | +| MySQL holding the data | PostgreSQL, another database, one per test system | +| The PHP application | Odoo, written in Python | +| A test mail server nobody reads | Mailpit, which you *do* read, in the browser | +| Restoring last night's backup to undo a test | one command that resets the test system in seconds | + +You never touch any of these parts. You use the browser; the person who +runs beelink takes care of the rest. + +## What is on beelink + +There are two test systems. Each is its own complete Odoo with its own +data; what you do in one does not show up in the other. + +| Name | Address (from your laptop) | What it is for | +| --- | --- | --- | +| **demo** | `https://demo.odoo.beelink.home.arpa` | a made-up company already full of sample customers, products, orders and invoices; best for looking around and trying workflows | +| **blank** | `https://blank.odoo.beelink.home.arpa` | an empty company; best for setting things up the way *your* business would, from scratch | +| **Mailpit** | `https://mail.odoo.beelink.home.arpa` | every email either system sent | + +`https://odoo.beelink.home.arpa` is a start page that links all three. + +```mermaid +flowchart LR + you["Your laptop
(web browser)"] -->|home network| beelink + subgraph beelink["beelink (the test computer)"] + demo["Odoo: demo
sample company"] + blank["Odoo: blank
empty company"] + mailpit["Mailpit
pretend mailbox"] + demo -->|every email| mailpit + blank -->|every email| mailpit + end + mailpit -. "nothing goes out" .-x world["The real world
(customers, banks)"] +``` + +## Logging in + +1. Open one of the addresses above in your browser (Edge or Chrome). +2. User name: **admin**. +3. Password: ask the person who runs beelink. It is the same for both + test systems and does not change when a system is reset. + +The first time on a new laptop, someone has to do a one-time setup so +the laptop can find beelink and trusts its padlock (the steps are on +[Reaching Odoo from other machines](odoo-access.md)). After that it just +works. If the browser ever says *"Your connection isn't private"*, stop +and ask: it means that setup is missing or out of date, not that +something is wrong with Odoo. + +The **"neutralized database"** notice at the top of the screen is +expected. It is Odoo's way of saying "this is a test copy, outside +connections are off". + +## Mailpit: where the emails go + +In a real business, Odoo emails customers all the time: quotes, +invoices, order confirmations, payment reminders, password resets. In a +test system full of made-up (and sometimes real-looking) addresses, that +would be a disaster. + +So on beelink, **no email ever leaves the house**. Odoo hands every +message to Mailpit instead, and Mailpit keeps it, like a post office +that puts every letter in a tray rather than sending it. + +To see what Odoo sent: + +1. Do something in Odoo that sends an email, for example open a + quotation and click **Send** (called *Send by Email* in some + versions), then **Send** again in the window that opens. +2. Open `https://mail.odoo.beelink.home.arpa`. +3. The newest message is at the top. Click it to read it exactly as the + customer would have received it, attachments (the PDF quote or + invoice) included. + +This is the useful part: you can check the wording, the layout and the +attachments of every email *before* anything like it goes to a real +customer. + +!!! note "Not there yet?" + Most emails show up at once, but Odoo sends some in batches. If a + message is missing, wait a few minutes and refresh the page. + +## A first test, start to finish + +In **demo**: + +1. **Sales** → **New**: pick any customer, add a product or two, **Save**. +2. **Send** → **Send**. +3. In Mailpit: read the quotation email and open the attached PDF. +4. Back in Odoo: **Confirm** the order, then **Create Invoice**, + **Confirm** the invoice and **Send** it (button names vary a little + between Odoo versions). +5. In Mailpit again: the invoice email is there. + +Nothing was sent to anyone, and the sample customer is still made up. + +## Starting over + +When a test system gets messy, or you want a clean run for a demo, ask +for a **reset**. The person who runs beelink types one command and, in a +few seconds, that system is exactly as it was on day one: all your +changes are gone, the sample data is back. + +Two more things they can do for you: + +| Ask for | What you get | +| --- | --- | +| "Reset demo" (or blank) | that system back to its first day, in seconds | +| "Save demo as *before-import*" | a bookmark of how it looks right now | +| "Put demo back to *before-import*" | everything as it was when the bookmark was taken | + +A bookmark is handy before a long test: set up the starting point once, +then go back to it as often as you like. + +## Good to know + +- **It is a test system.** Do not put real customer data, real bank + details or real passwords into it. +- **Only the home network can reach it.** From outside the house it is + not there. +- **Slow or stuck?** Refresh once. If it still does not respond, ask + for a reset; that fixes almost everything. +- **Want another app** (Inventory, Projects, Accounting, ...)? You can + install apps yourself from the **Apps** menu, or ask for one to be + included automatically after every reset. diff --git a/documentation/docs/odoo.md b/documentation/docs/odoo.md index 04b92d8..b66a288 100644 --- a/documentation/docs/odoo.md +++ b/documentation/docs/odoo.md @@ -9,7 +9,8 @@ created state in seconds. Nothing is reachable from other machines unless an instance asks for it: see [Reaching Odoo from other machines](odoo-access.md) for the LAN (a Windows laptop, say) and the internet (a real domain with Let's -Encrypt). +Encrypt). For a non-technical walkthrough (using the test instances +and Mailpit from a browser), see [CEO: Odoo](ceo-odoo.md). ## Enabling and adding instances diff --git a/documentation/flake-module.nix b/documentation/flake-module.nix index a9b7fe5..97222da 100644 --- a/documentation/flake-module.nix +++ b/documentation/flake-module.nix @@ -10,6 +10,7 @@ {Home = "index.md";} { Odoo = [ + {"CEO: Odoo" = "ceo-odoo.md";} "odoo.md" "odoo-access.md" ]; diff --git a/documentation/slides/ceo-odoo.html b/documentation/slides/ceo-odoo.html new file mode 100644 index 0000000..cc49ce5 --- /dev/null +++ b/documentation/slides/ceo-odoo.html @@ -0,0 +1,42 @@ + + + + + + Odoo for local testing + + + + + + + + +
+
+
+
+
+ + + + + + + + + + diff --git a/documentation/slides/ceo-odoo.md b/documentation/slides/ceo-odoo.md new file mode 100644 index 0000000..0fe67aa --- /dev/null +++ b/documentation/slides/ceo-odoo.md @@ -0,0 +1,142 @@ + +

For the CEO

+ +# Odoo, for testing + +A safe place to try the business software + +

Arrow keys to move · F for full screen

+ +Note: No technical background needed. Everything here happens in a web browser. + +--- + +## What it is + +- **Odoo**: sales, CRM, invoicing, inventory, projects, in one web app +- **beelink**: a small computer in the house that runs it +- **Testing only**: no customer, supplier or bank ever sees it + +

A sandbox. Click everything. Nothing leaves the house.

+ +--- + +## You have seen this shape before + +| The classic setup | Here | +| --- | --- | +| Server in the back room | **beelink** | +| Apache | **nginx** | +| MySQL | **PostgreSQL** | +| The PHP app | **Odoo** (Python) | +| Restore last night's backup | **reset**, in seconds | + +

You never touch these parts: you use the browser.

+ +Note: Same idea as a LAMP server, newer parts. The person who runs beelink looks after all of it. + +--- + +## Two test companies + +
+ + + Your laptop + web browser + + + beelink + + demo + sample company, full of data + + blank + empty company + + + + + Mailpit + every email + + +
+ +Note: Each company is its own complete Odoo with its own data. What you do in one does not show up in the other. + +--- + +## Where to go + +| | Address | +| --- | --- | +| Start page | `odoo.beelink.home.arpa` | +| **demo** | `demo.odoo.beelink.home.arpa` | +| **blank** | `blank.odoo.beelink.home.arpa` | +| **Mailpit** | `mail.odoo.beelink.home.arpa` | + +User **admin** · password: ask whoever runs beelink + +

All start with https:// · home network only

+ +Note: The laptop needs a one-time setup so it can find beelink and trusts its padlock. "Your connection isn't private" means that setup is missing: stop and ask. + +--- + +## Mailpit: the pretend mailbox + +- Odoo emails quotes, invoices, reminders, password resets +- On beelink, **no email ever leaves the house** +- Mailpit keeps every one, like a post office that puts every letter in a tray + +

Read every email exactly as the customer would, before a real one goes out.

+ +Note: Test data has made-up, sometimes real-looking addresses. Without Mailpit a test could email a stranger. + +--- + +## A first test + +1. **demo** → Sales → New quotation → Save +2. **Send** it +3. **Mailpit**: read the email, open the PDF +4. Confirm → invoice → **Send** +5. **Mailpit**: the invoice is there too + +

Not in Mailpit yet? Wait a few minutes, refresh.

+ +Note: Nothing was sent to anyone, and the customer is still made up. + +--- + +## Starting over + +| Ask for | You get | +| --- | --- | +| "Reset demo" | day one again, in seconds | +| "Save demo as *before-import*" | a bookmark of right now | +| "Put demo back to *before-import*" | everything as bookmarked | + +

A reset fixes almost everything, including slow or stuck.

+ +--- + +## Ground rules + + + + +--- + + + +# Questions? + +

The written guide: the "CEO: Odoo" page of these docs