Jump to
↵select↑↓navigateescclose

Reference

Reference

The flake outputs and library functions of odoo-nix, with links to the option references, the scaffolder, the repository layout and troubleshooting.

Updated
Tags
  • reference
  • flake
  • outputs
On this page

Flake outputs of odoo-nix

OutputWhat it is
flakeModules.defaultThe flake-parts module: the dev shell, the packages, the container image and the odoo-nix option tree.
nixosModules.defaultThe standalone services.odoo-nix NixOS module.
lib.mkFlakeflake-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.overridesPython 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.addonsThe addons_path synthesis (lib/addons.nix), for testing and advanced use.
lib.odoo-lsThe odoo-ls package builder.
packages.<SYSTEM>.odoo-init, .defaultThe scaffolder.
packages.<SYSTEM>.odoo-lsodoo-ls, pinned to the odoo-ls-src and odoo-ls-typeshed inputs.
packages.<SYSTEM>.sources, apps.<SYSTEM>.sourcesodoo-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>.bootstrapodoo-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, .defaultWhat nix run github:Avunu/odoo-nix runs.
apps.<SYSTEM>.relock, .relock-odoo-lsMaintenance 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