Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions documentation/docs/ceo-odoo.md
Original file line number Diff line number Diff line change
@@ -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.

<iframe src="slides/ceo-odoo.html" title="Odoo for local testing, slide deck"
style="width: 100%; aspect-ratio: 16 / 9; border: 0;"
allowfullscreen></iframe>

<p><a href="slides/ceo-odoo.html">Open the slides full screen</a>
(arrow keys to move, <kbd>F</kbd> for full screen).</p>

## 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<br/>(web browser)"] -->|home network| beelink
subgraph beelink["beelink (the test computer)"]
demo["Odoo: demo<br/>sample company"]
blank["Odoo: blank<br/>empty company"]
mailpit["Mailpit<br/>pretend mailbox"]
demo -->|every email| mailpit
blank -->|every email| mailpit
end
mailpit -. "nothing goes out" .-x world["The real world<br/>(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.
3 changes: 2 additions & 1 deletion documentation/docs/odoo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions documentation/flake-module.nix
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
{Home = "index.md";}
{
Odoo = [
{"CEO: Odoo" = "ceo-odoo.md";}
"odoo.md"
"odoo-access.md"
];
Expand Down
42 changes: 42 additions & 0 deletions documentation/slides/ceo-odoo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Odoo for local testing</title>
<!-- Same page as the generated index.html (pkgs flakeModules.docs),
for a second deck: the build inlines ceo-odoo.md like slides.md. -->
<link rel="stylesheet" href="reveal/reset.css" />
<link rel="stylesheet" href="reveal/reveal.css" />
<link rel="stylesheet" href="reveal/theme/black.css" />
<link rel="stylesheet" href="reveal/plugin/highlight/monokai.css" />
<link rel="stylesheet" href="org/org.css" />
</head>
<body>
<div class="reveal">
<div class="slides">
<section data-markdown="ceo-odoo.md" data-separator="^---$" data-separator-vertical="^--$" data-separator-notes="^Note:"></section>
</div>
</div>
<script src="reveal/reveal.js"></script>
<script src="reveal/plugin/markdown.js"></script>
<script src="reveal/plugin/highlight.js"></script>
<script src="reveal/plugin/notes.js"></script>
<script src="org/speaker-sync.js"></script>
<script src="org/rough.js"></script>
<script src="org/sketch.js"></script>
<script>
Reveal.initialize({
hash: true,
slideNumber: "h.v",
progress: true,
transition: "slide",
backgroundTransition: "fade",
autoAnimateDuration: 0.8,
width: 1280,
height: 720,
plugins: [RevealMarkdown, RevealHighlight, RevealNotes],
}).then(sketchDiagrams);
</script>
</body>
</html>
142 changes: 142 additions & 0 deletions documentation/slides/ceo-odoo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<!-- .slide: class="title-slide" -->
<p class="kicker">For the CEO</p>

# Odoo, for testing

A safe place to try the business software

<p class="hint">Arrow keys to move · F for full screen</p>

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

<p class="takeaway">A sandbox. Click everything. Nothing leaves the house.</p>

---

## 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 |

<p class="hint">You never touch these parts: you use the browser.</p>

Note: Same idea as a LAMP server, newer parts. The person who runs beelink looks after all of it.

---

## Two test companies

<div class="diagram">
<svg class="sketch" viewBox="0 0 1100 420">
<rect x="20" y="150" width="220" height="110" stroke="#6a9bcc" fill="#6a9bcc" />
<text x="130" y="200" text-anchor="middle" fill="#faf9f5" font-size="30">Your laptop</text>
<text x="130" y="235" text-anchor="middle" fill="#b0aea5" font-size="22">web browser</text>
<line x1="245" y1="205" x2="365" y2="205" stroke="#faf9f5" data-arrow />
<rect x="370" y="20" width="710" height="380" stroke="#d97757" fill="none" data-dash />
<text x="725" y="60" text-anchor="middle" fill="#d97757" font-size="28">beelink</text>
<rect x="400" y="90" width="300" height="120" stroke="#d97757" fill="#d97757" />
<text x="550" y="140" text-anchor="middle" fill="#faf9f5" font-size="32">demo</text>
<text x="550" y="178" text-anchor="middle" fill="#b0aea5" font-size="22">sample company, full of data</text>
<rect x="400" y="250" width="300" height="120" stroke="#d97757" fill="#d97757" />
<text x="550" y="300" text-anchor="middle" fill="#faf9f5" font-size="32">blank</text>
<text x="550" y="338" text-anchor="middle" fill="#b0aea5" font-size="22">empty company</text>
<g class="fragment fade-in">
<line x1="705" y1="150" x2="815" y2="210" stroke="#faf9f5" data-arrow />
<line x1="705" y1="310" x2="815" y2="250" stroke="#faf9f5" data-arrow />
<rect x="820" y="170" width="230" height="120" stroke="#8fa876" fill="#8fa876" />
<text x="935" y="222" text-anchor="middle" fill="#faf9f5" font-size="32">Mailpit</text>
<text x="935" y="258" text-anchor="middle" fill="#b0aea5" font-size="22">every email</text>
</g>
</svg>
</div>

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

<p class="hint">All start with https:// · home network only</p>

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

<p class="takeaway">Read every email exactly as the customer would, before a real one goes out.</p>

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 <!-- .element: class="fragment" -->
4. Confirm → invoice → **Send** <!-- .element: class="fragment" -->
5. **Mailpit**: the invoice is there too <!-- .element: class="fragment" -->

<p class="hint">Not in Mailpit yet? Wait a few minutes, refresh.</p>

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 |

<p class="hint">A reset fixes almost everything, including slow or stuck.</p>

---

## Ground rules

<ul class="ticks">
<li>Try anything: send, delete, import</li>
<li>Install apps from the Apps menu</li>
<li>Reset whenever it gets messy</li>
</ul>
<ul class="ticks cross">
<li>No real customer data, bank details or passwords</li>
</ul>

---

<!-- .slide: class="title-slide" -->

# Questions?

<p class="hint">The written guide: the "CEO: Odoo" page of these docs</p>
Loading