Northstar · Setup guide

Français

Northstar for Odoo Community

Run Northstar on your own computer or your own server, with Docker. No sign-in, and no Odoo knowledge needed.

Your setup
About 10 minutes the first time, to install Docker once.
Northstar ready in
A few minutes.

Quick start

  1. Install Docker, once
    Download Docker Desktop (free for personal use, education and small companies) and open it until it says Engine running. On Linux, install Docker Engine instead.
  2. Download and unzip Northstar
    Click Download Northstar on the Northstar page (or use this direct link), then unzip the file into an empty folder. All versions are on the GitHub releases page. The zip holds the Docker file, the database backup, a README with the quick start, the licence and the terms.
  3. Start it
    Open a terminal in that folder, type docker compose up and press Enter. The first start takes a few minutes. When you see Northstar is ready, open http://localhost:8069 and log in with admin and the password admin.
These passwords are public. They are fine on your own computer. Before you put Northstar on a server other people can reach, change every password: see Put it online below.
Need more detail?

What you need

  • A computer with Windows 10 or 11, a Mac (Apple chip or Intel chip) or Linux.
  • About 3 GB of free disk space and 8 GB of memory (RAM). In Docker Desktop, leave at least 4 GB to Docker.
  • An internet connection for the first start: Docker downloads Odoo and PostgreSQL once.
  • Docker, a free program that runs Northstar.
Docker Desktop is free for personal use, education, non-commercial open source and companies with fewer than 250 employees and less than US$10 million a year in revenue. Larger companies need a paid Docker subscription. Docker Engine on Linux is free.

Install Docker

Windows 10 or 11

  1. Download Docker Desktop from docker.com and run the installer.
  2. Keep Use WSL 2 ticked. It turns WSL 2 on for you. Restart the computer when it asks.
  3. Start Docker Desktop once and wait until it says Engine running.

Mac

  1. Download Docker Desktop from docker.com. Pick Mac with Apple chip (M1, M2, M3, M4 and later) or Mac with Intel chip. Not sure which? Open the Apple menu, then About This Mac.
  2. Open Docker Desktop once and wait until it says Engine running.

Linux

  1. Install Docker Engine and the Compose plugin for your distribution: docs.docker.com/engine/install.
  2. Check it with docker compose version. Docker Compose 2.20 or later is needed.
  3. Add yourself to the docker group (sudo usermod -aG docker $USER, then log out and in), or put sudo before the commands below.

Download Northstar

  1. Click Download Northstar on the Northstar page. The file is called northstar-odoo20.zip. Do not use the green Code button, then Download ZIP, on GitHub: it does not contain the database.
  2. Unzip it into an empty folder. On Windows, right-click the file and choose Extract All. The folder then holds docker-compose.yml, the database file, a README, the licence and the checksums. Nothing else is needed.

Start Northstar

  1. Open a terminal in that folder. On Windows, right-click an empty space in the folder and choose Open in Terminal. On a Mac, open Terminal, type cd , drag the folder into the window and press Return. On Linux, open a terminal there.
  2. Type this and press Enter: docker compose up
  3. Wait. The first start takes a few minutes, and this is normal. Docker downloads Odoo and PostgreSQL once, then Northstar prints Restoring Northstar and a Still restoring line every 10 seconds. You do not need to do anything.
  4. When you see Northstar is ready, open http://localhost:8069 in your browser. Leave the terminal window open while Northstar runs.

Log in

Use one of these logins:

  • Administrator: admin with the password admin
  • The four sales users: rachel.donovan@northstar-supply.example, marcus.hale@northstar-supply.example, priya.raman@northstar-supply.example, tomas.kowalski@northstar-supply.example, all with the password northstar
These passwords are public. They are fine on your own computer. Before you put Northstar on a server that other people can reach, change every user's password.

Northstar sends no email: every address is on a .example domain that cannot receive mail.

Stop it, start it again, start over

  • Stop: press Ctrl+C in the terminal, or run docker compose down.
  • Start again: docker compose up. Later starts keep your data and open in seconds.
  • Port 8069 already in use? Run NORTHSTAR_PORT=8070 docker compose up (in PowerShell: $env:NORTHSTAR_PORT=8070; docker compose up), then open the address with 8070.
  • Start over with the original data: docker compose down -v, then docker compose up. This deletes every change you made.
  • A newer release: download Northstar again, run docker compose down -v in the old folder, unzip the new file into a new empty folder and run docker compose up there. We publish a new release every week.
  • Who can reach it: only your own computer, not your network.

Another way: restore it without Docker

The download holds the database as a standard Odoo backup. It restores on any self-hosted Odoo 20 Community:

  1. Unzip the download. Open /web/database/manager on your Odoo 20 (for example http://localhost:8069/web/database/manager).
  2. Click Restore Database, enter your master password, choose the database file from the unzipped folder (the zip named northstar-odoo20.zip), and name the database northstar.
  3. Keep This database is a copy selected, then click Continue.
  4. Open the new database and log in with one of the logins above.

If the upload stops, raise the upload size limit of your web server or proxy (for example client_max_body_size in nginx).

Northstar on your own server

The same download and the same command, docker compose up -d, work on any Linux server that has Docker (see Install Docker Engine). Nothing else changes.

Before you open it to other people:

  • Change the password of every user.
  • Set your own master password (admin_passwd in your Odoo configuration) and turn the database list off (list_db = False), so nobody can open the database manager to copy, restore or delete a database.
  • Change the PostgreSQL password in docker-compose.yml, and keep PostgreSQL off the network.
  • Public sign-up and password reset are already off in Northstar. Leave them off unless you need them.

Pair it. To add a new day every night, run docker compose --profile live up -d on the server, then open our Northstar page, click Northstar runs on a server? Type its code and type the code (see Northstar Live below).

Use the AI on it. Questions you ask in chat, ChatGPT or Claude are answered from our hosted Northstar, not from your server. To ask about your own copy, give it a public https address and connect it with an Odoo API key.

Our free guides cover the rest:

If something goes wrong

  • The restore failed: Northstar prints one line that says what failed and what to do. Usually, run docker compose down -v, then docker compose up again.
  • The line says the database file is damaged: download Northstar again and unzip it into an empty folder.
  • It still fails: write to contact@speaktoyourdatabase.com with the line Northstar printed.

Northstar Live: keep it alive every day

Northstar Live adds a new business day to your download every night. You need no server, no domain name and no open port.

Your setup
About 5 minutes.
Northstar ready in
A few minutes. Days missing since your copy was made are added in the background.

Quick start

  1. Start it with Live
    In the folder of your Northstar download, open a terminal and run docker compose --profile live up -d. It is the same download as above: Live is part of it.
  2. Click Pair
    Open http://localhost:8070 on that computer and click Pair. Your browser opens our Northstar page.
  3. Confirm on our page
    Sign in (it is free). Our Northstar page shows your computer's code: click Connect. You have 15 minutes.
Need more detail?

What you need

  • Docker installed, as above (Docker Desktop on Windows and Mac, Docker Engine with the Compose plugin on Linux).
  • 8 GB of memory (RAM) and about 3 GB of disk. In Docker Desktop, leave at least 4 GB to Docker.
  • An Intel or AMD processor, or an ARM 64-bit one (Apple Silicon, recent ARM Linux).
  • A free account on our site: you sign in once to pair your computer.

Set it up, in detail

  1. Start it. Open a terminal in the folder (on Windows, right-click an empty space and choose Open in Terminal; on a Mac, type cd , drag the folder in and press Return) and run docker compose --profile live up -d. It starts Northstar and Northstar Live together, so it also works if you already ran docker compose up -d. The first start downloads what it needs: about 5 minutes, depending on your connection.
  2. Click Pair. Open http://localhost:8070 on that computer and click Pair. Your browser opens our Northstar page with the code of your computer.
  3. Confirm on our page. Sign in, then click Connect. Each code works once, for 15 minutes.
  4. Check it. The page on your computer now says Live.

On a server without a browser. Run docker compose exec northstar-live northstar-live code: it prints the code and the link. Open the link in a browser on the same network as the server and sign in, or open our Northstar page from anywhere, click Northstar runs on a server? Type its code and type the code. If your browser is on another network than the server, our page asks you to confirm that it is your own computer.

You do not need to edit any file to pair. The only file you may touch is .env, to change a port: see If something goes wrong below.

Your Odoo is at http://localhost:8069. Log in as admin with the password admin (the four sales users have the password northstar). These passwords are public: keep Odoo on your own computer, as this package does.

What happens each night

  • Every night we add the day that just ended: leads and quotes, orders, deliveries, invoices, payments, purchases, trade counter sales, workshop orders, projects, time off and attendance.
  • Today is always empty: the day is added after it ends. Ask about last week or last month.
  • Your own changes are left alone.
  • Leave it running. If your computer sleeps or Docker is stopped for a while, the missed days are added when it is back.
  • If nobody uses your Northstar for 30 days, it pauses. Opening your Odoo keeps it going, and one click on Resume on our Northstar page brings it back.
  • The page on your computer (http://localhost:8070) shows whether it is live and when it last added a day.

We cannot read the Odoo on your computer. Questions you ask in ChatGPT, Claude or our chat are answered from our hosted Northstar, the same company. Changes you make by hand in your own Odoo are not in those answers.

How to stop it

  • Pause Northstar Live alone: docker compose stop northstar-live. Odoo keeps working without it, and the missed days are added when it is back.
  • Stop everything: docker compose stop. Start again with docker compose --profile live up -d.
  • Disconnect this computer from your account: on our Northstar page, click Disconnect this computer, or on your computer use the button on http://localhost:8070 (tick the box first), or without a browser run docker compose exec northstar-live northstar-live unpair. Your Odoo and your changes stay, and the page on your computer shows a new code.
  • Pair it with another account: disconnect it first, then click Pair again and sign in with the other account.
  • Start over with the original data: docker compose down -v, then docker compose --profile live up -d. This deletes your changes and the pairing: you pair again with a new code.

If something goes wrong

  • port is already allocated: another program uses 8069 or 8070. Copy .env.example to .env, change NORTHSTAR_PORT or NORTHSTAR_LIVE_PAGE_PORT, and run docker compose --profile live up -d again.
  • The page says Not connected for a long time: check your internet connection. At work, a proxy may block it.
  • A new code (it expired, or to pair again): use the button on http://localhost:8070.
  • Anything else: docker compose logs northstar-live shows what Northstar Live did. It never writes your key, the pairing code or your data in it, so you can send it to contact@speaktoyourdatabase.com.

Need help? Contact support