Reference
Reference
The flake outputs and library functions of odoo-nix, with links to the option references, the scaffolder, the repository layout and troubleshooting.
On this page
Flake outputs of odoo-nix
| Output | What it is |
|---|---|
flakeModules.default | The flake-parts module: the dev shell, the packages, the container image and the odoo-nix option tree. |
nixosModules.default | The standalone services.odoo-nix NixOS module. |
lib.mkFlake | flake-parts.lib.mkFlake with odoo-nix's own inputs merged into the consumer's, so a project declares only odoo-nix and nixpkgs.follows. |
lib.overrides | Python native-build overlays, lib.overrides.<PACKAGE> { pkgs }, each a final: prev: overlay: python-devops-nix's shared fixes one by one (psycopg2, python-ldap, lxml, pycups, python-magic, pyvips, cairocffi) and libsass. Every project's environment already has the shared ones; these are for a flake that builds its own package set. |
lib.addons | The addons_path synthesis (lib/addons.nix), for testing and advanced use. |
lib.odoo-ls | The odoo-ls package builder. |
packages.<SYSTEM>.odoo-init, .default | The scaffolder. |
packages.<SYSTEM>.odoo-ls | odoo-ls, pinned to the odoo-ls-src and odoo-ls-typeshed inputs. |
packages.<SYSTEM>.sources, apps.<SYSTEM>.sources | odoo-nix-sources, the dev shell's submodule checkout, outside it: nix run github:Avunu/odoo-nix#sources -- enter --treeless odoo <ROOT>. |
packages.<SYSTEM>.bootstrap, apps.<SYSTEM>.bootstrap | odoo-nix-bootstrap <ROOT>: a fresh clone's submodules, from the sources its flake.lock pins, before Nix evaluates the project. See A fresh clone. |
apps.<SYSTEM>.odoo-init, .default | What nix run github:Avunu/odoo-nix runs. |
apps.<SYSTEM>.relock, .relock-odoo-ls | Maintenance of odoo-nix itself: see Repository layout. |
devShells.<SYSTEM>.default, formatter.<SYSTEM> | For working on odoo-nix itself. |
What a project gets
With odoo-nix.enable, a project's flake gets packages.<SYSTEM>.{default, builtOdoo, odooCli, odooPythonEnv, odooDevEnv, odooTestEnv, odooConf, odoo-ls}, container-odoo with containers.enable, the dev shell, and, with secrets declared, lib.secrets. See From development to production.
Pages in this section
Dev shell options: every
perSystem.odoo-nixoption.Secrets options:
odoo-nix.secrets.Scaffolder: the flags and exit codes of
odoo-init.Repository layout: where things live in odoo-nix, its checks, and how its pinned data is refreshed.