Compare commits
30
Commits
e8b208accb
...
5.13.50
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
37abda5f39 | ||
|
|
4e544f6e46 | ||
|
|
0f1f3f6675 | ||
|
|
2c9915699d | ||
|
|
bd112541e5 | ||
|
|
b883e04303 | ||
|
|
8216a723f0 | ||
|
|
ef08e0d7fc | ||
|
|
330ec8c503 | ||
|
|
b1fe86e9d5 | ||
|
|
ccf4d01a34 | ||
|
|
fd055f0cf9 | ||
|
|
7d7d717745 | ||
|
|
d7fea37e25 | ||
|
|
a71ccc87bb | ||
|
|
4c97391a33 | ||
|
|
fef9406b63 | ||
|
|
2c0a48b899 | ||
|
|
d7633e66ce | ||
|
|
f6e5c15afd | ||
|
|
df90f25778 | ||
|
|
554f73d477 | ||
|
|
5de2563c0f | ||
|
|
b37f121f06 | ||
|
|
878134dd4b | ||
|
|
808b9a7fe9 | ||
|
|
6b0f38d59e | ||
|
|
fd776bb9b7 | ||
|
|
a42d01edd3 | ||
|
|
1df11adbde |
@@ -0,0 +1,2 @@
|
|||||||
|
/result
|
||||||
|
/nixos.qcow2
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||||
|
|
||||||
|
## What this repo is
|
||||||
|
|
||||||
|
A Nix flake that packages [Invoice Ninja](https://github.com/invoiceninja/invoiceninja) (a PHP/Laravel app with a
|
||||||
|
separate React frontend) and provides a NixOS module (`services.invoiceninja`) to deploy it as a full service:
|
||||||
|
PHP-FPM pool, nginx or Caddy reverse proxy, MariaDB, Redis, a queue-worker systemd unit, and a one-shot
|
||||||
|
migration/setup unit.
|
||||||
|
|
||||||
|
There is no application source code here — this is packaging/deployment code only. All behavior changes come from
|
||||||
|
editing Nix expressions.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
This project uses `just` (see `justfile`) and Nix directly.
|
||||||
|
|
||||||
|
- `just build-vm [proxy]` — cleans previous artifacts and builds the test VM (`nixosConfigurations.test-<proxy>`)
|
||||||
|
via `nom build`. `proxy` is `nginx` (default) or `caddy`.
|
||||||
|
- `just boot-vm` — boots the built VM (`result/bin/run-nixos-vm`) in the current terminal. Serves Invoice Ninja on
|
||||||
|
`localhost:8080` (see `QEMU_NET_OPTS` in the `justfile`) with root login `toor`.
|
||||||
|
- `just clean` — removes `result`/`nixos.qcow2` and kills any running `qemu` process.
|
||||||
|
- `just test` — runs the automated test suite (`nix flake check -L`).
|
||||||
|
- `nix build .#invoiceninja` — build just the Invoice Ninja package.
|
||||||
|
- `nix build .#checks.x86_64-linux.invoiceninja -L` — run only the automated VM test, with build/test log output.
|
||||||
|
- `nix flake check` — evaluate the flake (module options, overlay, package derivation) and run the automated test.
|
||||||
|
|
||||||
|
### `tests/`
|
||||||
|
|
||||||
|
- `common.nix` — the shared `services.invoiceninja` config used by both the interactive VM and the automated test:
|
||||||
|
imports the module and points at the checked-in test fixtures (`invoice_ninja_test_password`, `test.env`). It's a
|
||||||
|
function taking `{ proxyServer ? "nginx" }` so callers can pick which proxy backend to test.
|
||||||
|
- `default.nix` — the interactive VM config (`nixosConfigurations.test-nginx`/`test-caddy` in `flake.nix`), used
|
||||||
|
for manual, click-around verification via `just build-vm [proxy]` / `just boot-vm`. It's also a function taking
|
||||||
|
`{ proxyServer ? "nginx" }`, forwarded straight through to `common.nix`, so `flake.nix` can instantiate one
|
||||||
|
`nixosConfigurations` entry per proxy backend. Adds the qemu-guest profile and a root login. It also sets a
|
||||||
|
dummy `fileSystems."/"` and disables `boot.loader.grub` purely to satisfy NixOS's built-in assertions when
|
||||||
|
`nix flake check` evaluates
|
||||||
|
`config.system.build.toplevel` directly — the qemu-vm module overrides both with a tmpfs root and direct kernel
|
||||||
|
boot when actually building `config.system.build.vm` (what `just build-vm` uses), so these values are otherwise
|
||||||
|
unused. Also raises `virtualisation.cores`/`memorySize` to 2/2560 (qemu-vm's defaults, 1 core/1024MB, are too
|
||||||
|
tight for real interactive use — see the module architecture notes below on PDF generation's memory cost).
|
||||||
|
- `nixos-test.nix` — the automated test (`pkgs.testers.nixosTest`, exposed as `checks.<system>.invoiceninja` in
|
||||||
|
`flake.nix`). Builds its own `pkgs` externally (needed regardless of config, since `nixosTest` itself is called
|
||||||
|
as `pkgs.testers.nixosTest`) and boots two nodes from `common.nix` — one with `proxyServer = "nginx"`, one with
|
||||||
|
`proxyServer = "caddy"` — so both proxy backends get exercised. The shared
|
||||||
|
assertion suite (factored into a `check_invoiceninja(machine, proxy_unit)` function in the test script) runs
|
||||||
|
against each node: waits for mysql/redis/phpfpm/queue-worker/proxy to be active, checks the
|
||||||
|
`invoiceninja-data-setup` marker files (`.db-seeded`, `.admin-created`) to confirm the
|
||||||
|
one-time setup actually completed (not just that the oneshot unit exited), curls `/` for the app shell, exercises
|
||||||
|
the `invoiceninja-manage` wrapper, logs in via `/api/v1/login` using the test admin credentials as an
|
||||||
|
end-to-end check that migrations/seeding/account creation all worked, checks the full language list is
|
||||||
|
available (see the `cache:forget languages` note above), and exercises PDF generation end-to-end (POSTs to
|
||||||
|
`/api/v1/preview` with no entity, which falls back to a self-contained mock PDF built via the same
|
||||||
|
chromium/snappdf pipeline real invoices use, and checks for the `%PDF` magic bytes — no client/invoice setup
|
||||||
|
needed). This is the only automated test in the repo — there is no separate unit-test suite.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
### `package.nix`
|
||||||
|
|
||||||
|
Builds Invoice Ninja in two stages:
|
||||||
|
|
||||||
|
1. **`ui`** — the separate `invoiceninja/ui` React frontend repo, built with `buildNpmPackage`. Patches
|
||||||
|
`.env.example` to disable test mode and swaps in `vite.config.ts.react` before building.
|
||||||
|
2. **Main package** — built with `php82.buildComposerProject` from the `invoiceninja/invoiceninja` PHP repo. The
|
||||||
|
`ui` build's `dist/` output is copied into `public/` before the PHP build (`preConfigure`), and
|
||||||
|
`public/index.html` is copied to `resources/views/react/index.blade.php` so Laravel serves the React shell.
|
||||||
|
|
||||||
|
Both source fetches (`fetchFromGitHub`) run their lockfiles through `npm-lockfile-fix` in `postFetch` to patch
|
||||||
|
missing integrity fields — required for `fetchNpmDeps`/`buildNpmPackage` to work with these upstream lockfiles.
|
||||||
|
|
||||||
|
Because Laravel needs writable directories that can't live in the read-only Nix store, `postInstall` renames
|
||||||
|
`bootstrap` → `bootstrap-static` and `storage` → `storage-static` inside the derivation, then symlinks
|
||||||
|
`$out/.env`, `$out/storage`, `$out/public/storage`, and `$out/bootstrap` to paths under the module's `dataDir` /
|
||||||
|
`runtimeDir`. This means **the package output is only fully functional when paired with the NixOS module** (or
|
||||||
|
something else that populates those runtime paths the same way) — building the package alone will produce
|
||||||
|
dangling symlinks.
|
||||||
|
|
||||||
|
When bumping the Invoice Ninja or UI version in `package.nix`, all four hashes (`src.hash`, `uiSrc.hash`,
|
||||||
|
`ui`'s `npmDepsHash`, and the main package's `vendorHash`/`npmDeps.hash`) generally need to be recomputed —
|
||||||
|
expect Nix to report the correct hash on a failed build (or use `nix-prefetch`/`lib.fakeHash` workflow).
|
||||||
|
|
||||||
|
### `nixos-module/`
|
||||||
|
|
||||||
|
- `default.nix` — the flake's `nixosModules` output. Exposes the `invoiceninja` module and a small
|
||||||
|
`overlayNixpkgsForThisInstance` module that applies the flake's overlay (registers `pkgs.invoiceninja`) to
|
||||||
|
whatever nixpkgs instance imports it.
|
||||||
|
- `invoiceninja.nix` — the actual `services.invoiceninja` module. Key structural points:
|
||||||
|
- `cfg.settings` is a submodule with a `freeformType` (`pkgs.formats.keyValue`), so any Laravel `.env` key can be
|
||||||
|
set even if not explicitly declared as an option; explicitly declared options (APP_ENV, MAIL_MAILER,
|
||||||
|
SESSION_DRIVER, etc.) exist mainly to add type-checking/enums and sensible computed defaults (e.g.
|
||||||
|
SESSION_DRIVER/QUEUE_CONNECTION/CACHE_DRIVER default to redis → database → file depending on what's enabled).
|
||||||
|
- **Secrets are deliberately kept out of `cfg.settings`/the Nix store.** `secretFile` (required) and
|
||||||
|
`adminAccount.passwordFile` (required) are consumed via systemd `LoadCredential` in the
|
||||||
|
`invoiceninja-data-setup` service, not written into the generated `.env` derivation. The final `.env` is
|
||||||
|
assembled at activation time by concatenating the Nix-store-rendered non-secret settings with the secret file
|
||||||
|
contents directly on disk in `dataDir`.
|
||||||
|
- `invoiceninja-data-setup.service` (oneshot, runs on every activation) does all first-run and idempotent setup:
|
||||||
|
clears bootstrap/opcode cache, rebuilds `.env`, rsyncs static storage into `dataDir`, symlinks the runtime
|
||||||
|
`app.php`, runs `migrate --force` unconditionally on every activation (safe/idempotent — Laravel tracks
|
||||||
|
applied migrations in the DB and only runs new ones; this must NOT be marker-gated, since a later invoiceninja
|
||||||
|
version upgrade can ship new migrations that need to run on an already-migrated install), and guards the
|
||||||
|
remaining one-time actions (`db:seed`, admin account creation) behind marker files (`.db-seeded`,
|
||||||
|
`.admin-created`) in `dataDir`. `phpfpm-invoiceninja.service` and
|
||||||
|
`invoiceninja-queue-worker.service` both depend on it. It also unconditionally runs
|
||||||
|
`invoiceninja-manage cache:forget languages` on every activation, working around an upstream bug: migration
|
||||||
|
`2025_08_31_224356_additional_languages_af_ca_id.php` runs during `migrate` (before `db:seed`'s
|
||||||
|
`LanguageSeeder` has populated the other 42 rows) and does `Cache::forever('languages', Language::all())`,
|
||||||
|
permanently caching just the 3 languages it sees at that moment — without this, the language dropdown in
|
||||||
|
the app stays stuck at 3 entries forever, since `StaticServiceProvider` checks that cache key before ever
|
||||||
|
querying the DB again.
|
||||||
|
- `invoiceninja-scheduler.timer`/`.service` run `artisan schedule:run` every minute — this is what drives
|
||||||
|
Invoice Ninja's own internal cron-scheduled jobs (recurring invoices, scheduled reports, etc.); without it the
|
||||||
|
app's dashboard reports "cron jobs are not enabled". Laravel's scheduler is just a dispatcher, so this one
|
||||||
|
timer is sufficient regardless of how many scheduled tasks Invoice Ninja itself defines.
|
||||||
|
- `invoiceninja-manage` is a generated wrapper script (`invoiceninja-manage <artisan-args>`) that `cd`s into the
|
||||||
|
package output and runs `php artisan` as the configured service user (via `sudo` if invoked as another user).
|
||||||
|
It's added to `environment.systemPackages`, so it's the normal way to run artisan commands
|
||||||
|
(`migrate`, `queue:work`, `ninja:create-account`, etc.) by hand on a deployed system.
|
||||||
|
- Both `nginx` and `caddy` proxy backends are supported (`proxy.server`), each independently duplicating the
|
||||||
|
PHP-FPM passthrough config — if changing one, check whether the other needs the same change. Neither sets
|
||||||
|
CORS headers itself: Laravel's own CORS middleware already sends a complete set on every response, and an
|
||||||
|
earlier version of this module additionally set a second, static set of `Access-Control-*` headers at the
|
||||||
|
proxy level, which browsers reject as conflicting duplicates (server-to-server/curl checks don't notice,
|
||||||
|
since only browsers enforce CORS header validation).
|
||||||
|
- Caddy matches vhosts on the exact `Host` header, unlike nginx (where a single vhost acts as the default
|
||||||
|
regardless of `Host`). When `hostname == "localhost"`, the caddy vhost adds `serverAliases` for
|
||||||
|
`127.0.0.1:80`/`[::1]:80` too — otherwise visiting the VM via the IP literal instead of `localhost` matches no
|
||||||
|
vhost and Caddy silently returns an empty `200 OK` (a blank page with no error anywhere).
|
||||||
|
- A headless browser is required at runtime for PDF generation (`PDF_GENERATOR=snappdf`,
|
||||||
|
`SNAPPDF_CHROMIUM_PATH`) and is added to the PHP-FPM and data-setup services' `path`. This is
|
||||||
|
`nixpkgs.playwright-driver`'s `chromium-headless-shell` component (Google's official "Chrome for Testing"
|
||||||
|
headless-only build, selected via `playwright-driver.browsers.override { ... }` with every other
|
||||||
|
browser/ffmpeg disabled) rather than `pkgs.chromium` — snappdf only ever shells out to
|
||||||
|
`$SNAPPDF_CHROMIUM_PATH --headless --print-to-pdf=...`, so the full browser UI/GPU stack `pkgs.chromium` ships
|
||||||
|
is dead weight; the headless-shell closure is ~1.45GB smaller and needs no `allowUnfree`. Each PDF request
|
||||||
|
still launches a full instance of the underlying browser engine (not a lightweight renderer), and PHP-FPM's
|
||||||
|
default `pm.max_children = 8` means up to 8 of these can run concurrently — on a memory-constrained deployment
|
||||||
|
this can exhaust RAM (confirmed: even a couple of concurrent PDF requests OOM-killed a 1024MB VM). Size
|
||||||
|
deployments accordingly, or lower `phpfpm.settings."pm.max_children"`.
|
||||||
|
|
||||||
|
### `flake.nix`
|
||||||
|
|
||||||
|
Standard flake shape: `overlays.default` registers the package, `packages.<system>.invoiceninja` exposes it,
|
||||||
|
`nixosModules` re-exports `nixos-module/default.nix`, and `nixosConfigurations.test-nginx`/`test-caddy` each build
|
||||||
|
the VM defined in `tests/default.nix` with the corresponding `proxyServer`. Only `x86_64-linux` is currently
|
||||||
|
supported.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Nix files: 2-space indentation (see `.editorconfig`); Unix line endings; final newline required.
|
||||||
|
- Prefer `lib.mkDefault`/`lib.mkIf`/`lib.mkMerge` for module config so downstream users can override cleanly —
|
||||||
|
this is used pervasively in `invoiceninja.nix` and should be followed for new options/config.
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
####
|
|
||||||
# Target definitions
|
|
||||||
####
|
|
||||||
|
|
||||||
# Disable echoing of target recipe commands
|
|
||||||
# Comment this for debugging
|
|
||||||
.SILENT:
|
|
||||||
|
|
||||||
# Run target recipes in one shell invocation
|
|
||||||
.ONESHELL:
|
|
||||||
|
|
||||||
# Since all targets are phony, all targets should be listed here
|
|
||||||
# One target per line
|
|
||||||
.PHONY: boot-vm \
|
|
||||||
build-vm \
|
|
||||||
clean \
|
|
||||||
format-nix-files \
|
|
||||||
help
|
|
||||||
|
|
||||||
# Show the help text
|
|
||||||
help:
|
|
||||||
egrep -h '\s##\s' $(MAKEFILE_LIST) \
|
|
||||||
| sort \
|
|
||||||
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
|
||||||
|
|
||||||
|
|
||||||
format-nix-files: ## Format nix files using the nixpkgs-fmt tool
|
|
||||||
find . -name "*.nix" -exec nixpkgs-fmt {} \;
|
|
||||||
|
|
||||||
clean: ## Clean build artifacts and shutdown running virtual machines
|
|
||||||
rm result > /dev/null 2>&1
|
|
||||||
rm nixos.qcow2 > /dev/null 2>&1
|
|
||||||
pkill qemu
|
|
||||||
exit 0
|
|
||||||
|
|
||||||
build-vm: clean ## Build virtual machine for testing
|
|
||||||
nix build ".#nixosConfigurations.test.config.system.build.vm"
|
|
||||||
|
|
||||||
boot-vm: ## Run virtual machine in current terminal
|
|
||||||
QEMU_KERNEL_PARAMS=console=ttyS0 \
|
|
||||||
QEMU_NET_OPTS=hostfwd=tcp::8080-:80 \
|
|
||||||
QEMU_OPTS=-nographic \
|
|
||||||
./result/bin/run-nixos-vm
|
|
||||||
reset
|
|
||||||
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
diff --git a/app/Console/Commands/CreateAccount.php b/app/Console/Commands/CreateAccount.php
|
|
||||||
index 228f8e8283..1ff3c54a61 100644
|
|
||||||
--- a/app/Console/Commands/CreateAccount.php
|
|
||||||
+++ b/app/Console/Commands/CreateAccount.php
|
|
||||||
@@ -79,7 +79,7 @@ class CreateAccount extends Command
|
|
||||||
$company->save();
|
|
||||||
|
|
||||||
$account->default_company_id = $company->id;
|
|
||||||
- $account->set_react_as_default_ap = true;
|
|
||||||
+ $account->set_react_as_default_ap = false;
|
|
||||||
$account->save();
|
|
||||||
|
|
||||||
$email = $this->option('email') ?? 'admin@example.com';
|
|
||||||
Generated
+25
-35
@@ -3,15 +3,15 @@
|
|||||||
"flake-compat": {
|
"flake-compat": {
|
||||||
"flake": false,
|
"flake": false,
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1733328505,
|
"lastModified": 1767039857,
|
||||||
"narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
|
"narHash": "sha256-vNpUSpF5Nuw8xvDLj2KCwwksIbjua2LZCqhV1LNRDns=",
|
||||||
"owner": "edolstra",
|
"owner": "NixOS",
|
||||||
"repo": "flake-compat",
|
"repo": "flake-compat",
|
||||||
"rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
|
"rev": "5edf11c44bc78a0d334f6334cdaf7d60d732daab",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"owner": "edolstra",
|
"owner": "NixOS",
|
||||||
"repo": "flake-compat",
|
"repo": "flake-compat",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
}
|
}
|
||||||
@@ -24,11 +24,11 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1733312601,
|
"lastModified": 1782949081,
|
||||||
"narHash": "sha256-4pDvzqnegAfRkPwO3wmwBhVi/Sye1mzps0zHWYnP88c=",
|
"narHash": "sha256-vp6Y/Grm98ESt6ceOkWiHWyZRDV3J1RID4w+6NWK9yA=",
|
||||||
"owner": "hercules-ci",
|
"owner": "hercules-ci",
|
||||||
"repo": "flake-parts",
|
"repo": "flake-parts",
|
||||||
"rev": "205b12d8b7cd4802fbcb8e8ef6a0f1408781a4f9",
|
"rev": "17c9d6cdfc60c64f4ee8d306f9bc0b4ccb51481e",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -42,24 +42,17 @@
|
|||||||
"flake-compat": [
|
"flake-compat": [
|
||||||
"nix"
|
"nix"
|
||||||
],
|
],
|
||||||
"gitignore": [
|
|
||||||
"nix"
|
|
||||||
],
|
|
||||||
"nixpkgs": [
|
"nixpkgs": [
|
||||||
"nix",
|
"nix",
|
||||||
"nixpkgs"
|
"nixpkgs"
|
||||||
],
|
|
||||||
"nixpkgs-stable": [
|
|
||||||
"nix",
|
|
||||||
"nixpkgs"
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1734279981,
|
"lastModified": 1783008725,
|
||||||
"narHash": "sha256-NdaCraHPp8iYMWzdXAt5Nv6sA3MUzlCiGiR586TCwo0=",
|
"narHash": "sha256-jGiy6+sxjNWXSjp25uoJuNfyH9zBK1PEDY0lVoL4ibQ=",
|
||||||
"owner": "cachix",
|
"owner": "cachix",
|
||||||
"repo": "git-hooks.nix",
|
"repo": "git-hooks.nix",
|
||||||
"rev": "aa9f40c906904ebd83da78e7f328cd8aeaeae785",
|
"rev": "bca82caa46d5ec0f5d422c61fb1e30bc51313cbe",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -78,11 +71,11 @@
|
|||||||
"nixpkgs-regression": "nixpkgs-regression"
|
"nixpkgs-regression": "nixpkgs-regression"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1740432616,
|
"lastModified": 1786478010,
|
||||||
"narHash": "sha256-2yad3RqbLhCeMK01lpSLXmeZR7J74YeBg4yNAqhzLLk=",
|
"narHash": "sha256-/9wXGp+aLObxqQuOGhDOnbdV0QCRDHH8uSh/4URKVAg=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nix",
|
"repo": "nix",
|
||||||
"rev": "8384e41b7608b5ff50306d3dec6171483cf2d4cd",
|
"rev": "24b65e35d9d4c9d64c1bd5844a35f2a779356d63",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -92,18 +85,15 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1734359947,
|
"lastModified": 1783148766,
|
||||||
"narHash": "sha256-1Noao/H+N8nFB4Beoy8fgwrcOQLVm9o4zKW1ODaqK9E=",
|
"narHash": "sha256-H9+N+GFtsbVC8ZniHliChM7ndizxtqVZs6bnGOLM3WQ=",
|
||||||
"owner": "NixOS",
|
"rev": "a50de1b7d8a586adc18d2395c19de7d6058e6030",
|
||||||
"repo": "nixpkgs",
|
"type": "tarball",
|
||||||
"rev": "48d12d5e70ee91fe8481378e540433a7303dbf6a",
|
"url": "https://releases.nixos.org/nixos/26.05/nixos-26.05.4193.a50de1b7d8a5/nixexprs.tar.xz"
|
||||||
"type": "github"
|
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"owner": "NixOS",
|
"type": "tarball",
|
||||||
"ref": "release-24.11",
|
"url": "https://channels.nixos.org/nixos-26.05/nixexprs.tar.xz"
|
||||||
"repo": "nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"nixpkgs-23-11": {
|
"nixpkgs-23-11": {
|
||||||
@@ -140,16 +130,16 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs_2": {
|
"nixpkgs_2": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1740339700,
|
"lastModified": 1786430034,
|
||||||
"narHash": "sha256-cbrw7EgQhcdFnu6iS3vane53bEagZQy/xyIkDWpCgVE=",
|
"narHash": "sha256-Vux08kA5PICwS2sViCMfwVLAHNoH8TkKAeBo25LjpMI=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"rev": "04ef94c4c1582fd485bbfdb8c4a8ba250e359195",
|
"rev": "70cc4559b10a6062b05ff1af17e0add065ccaed9",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"ref": "nixos-24.11",
|
"ref": "nixos-26.05",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,14 @@
|
|||||||
{
|
{
|
||||||
description = "An Invoice Ninja package and module.";
|
description = "An Invoice Ninja package and module.";
|
||||||
|
|
||||||
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
|
nixConfig = {
|
||||||
|
extra-substituters = [ "https://invoiceninja-nixos.cachix.org" ];
|
||||||
|
extra-trusted-public-keys = [
|
||||||
|
"invoiceninja-nixos.cachix.org-1:TmRZaji8FFVjjIw9KZmvLrxMxfP+JDThOyOX04z526A="
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-26.05";
|
||||||
|
|
||||||
outputs =
|
outputs =
|
||||||
{ self, nixpkgs, nix, }:
|
{ self, nixpkgs, nix, }:
|
||||||
@@ -20,9 +27,15 @@
|
|||||||
);
|
);
|
||||||
in
|
in
|
||||||
rec {
|
rec {
|
||||||
nixosConfigurations.test = nixpkgs.lib.nixosSystem {
|
nixosConfigurations = {
|
||||||
|
test-nginx = nixpkgs.lib.nixosSystem {
|
||||||
system = "x86_64-linux";
|
system = "x86_64-linux";
|
||||||
modules = [ ./tests ];
|
modules = [ (import ./tests/default.nix { proxyServer = "nginx"; }) ];
|
||||||
|
};
|
||||||
|
test-caddy = nixpkgs.lib.nixosSystem {
|
||||||
|
system = "x86_64-linux";
|
||||||
|
modules = [ (import ./tests/default.nix { proxyServer = "caddy"; }) ];
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
overlays.default = final: prev: { invoiceninja = final.callPackage ./package.nix { }; };
|
overlays.default = final: prev: { invoiceninja = final.callPackage ./package.nix { }; };
|
||||||
@@ -32,6 +45,10 @@
|
|||||||
default = pkgsBySystem.${system}.invoiceninja;
|
default = pkgsBySystem.${system}.invoiceninja;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
checks = forEachSystem (system: {
|
||||||
|
invoiceninja = import ./tests/nixos-test.nix { inherit system; nixpkgsPath = nixpkgs; };
|
||||||
|
});
|
||||||
|
|
||||||
nixosModules = import ./nixos-module { overlays = overlayList; };
|
nixosModules = import ./nixos-module { overlays = overlayList; };
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
set quiet := true
|
||||||
|
|
||||||
|
# Passed to QEMU in boot-vm
|
||||||
|
export QEMU_KERNEL_PARAMS := "console=ttyS0"
|
||||||
|
export QEMU_NET_OPTS := "hostfwd=tcp::8080-:80"
|
||||||
|
export QEMU_OPTS := "-nographic"
|
||||||
|
|
||||||
|
[private]
|
||||||
|
_default:
|
||||||
|
just --list
|
||||||
|
|
||||||
|
[doc('Clean build artifacts and shutdown running virtual machines')]
|
||||||
|
[group('maintenance')]
|
||||||
|
clean:
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
rm result > /dev/null 2>&1
|
||||||
|
rm nixos.qcow2 > /dev/null 2>&1
|
||||||
|
pkill qemu
|
||||||
|
exit 0
|
||||||
|
|
||||||
|
[doc('Build virtual machine for testing (proxy: nginx or caddy)')]
|
||||||
|
[group('main')]
|
||||||
|
build-vm proxy="nginx": clean
|
||||||
|
nom build ".#nixosConfigurations.test-{{proxy}}.config.system.build.vm"
|
||||||
|
|
||||||
|
[doc('Run virtual machine in current terminal')]
|
||||||
|
[group('main')]
|
||||||
|
boot-vm:
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
[ -x result/bin/run-nixos-vm ] && \
|
||||||
|
./result/bin/run-nixos-vm
|
||||||
|
reset
|
||||||
|
|
||||||
|
[doc('Run the automated NixOS VM test')]
|
||||||
|
[group('main')]
|
||||||
|
test:
|
||||||
|
nix flake check -L
|
||||||
|
|
||||||
|
[doc('Build the package and automated test, then push results to the invoiceninja-nixos cachix cache')]
|
||||||
|
[group('maintenance')]
|
||||||
|
push-cache:
|
||||||
|
nix build --print-out-paths --no-link \
|
||||||
|
".#invoiceninja" \
|
||||||
|
".#checks.x86_64-linux.invoiceninja" \
|
||||||
|
| cachix push invoiceninja-nixos
|
||||||
|
|
||||||
@@ -47,8 +47,22 @@ let
|
|||||||
extraConfig = "memory_limit = 1024M";
|
extraConfig = "memory_limit = 1024M";
|
||||||
};
|
};
|
||||||
|
|
||||||
# Chromium is required for PDF invoice generation
|
# A headless browser is required for PDF invoice generation (PDF_GENERATOR=snappdf). snappdf
|
||||||
chromium = pkgs.chromium;
|
# just shells out to `$SNAPPDF_CHROMIUM_PATH --headless --print-to-pdf=... <url>`, so a full
|
||||||
|
# browser UI/GPU stack isn't needed -- Google's own "Chrome for Testing" headless-only build
|
||||||
|
# (as packaged by nixpkgs' playwright-driver) does the same job for a ~1.45GB smaller closure
|
||||||
|
# than pkgs.chromium, with no allowUnfree requirement.
|
||||||
|
chromiumHeadlessShellBrowsers = pkgs.playwright-driver.browsers.override {
|
||||||
|
withChromium = false;
|
||||||
|
withFirefox = false;
|
||||||
|
withWebkit = false;
|
||||||
|
withFfmpeg = false;
|
||||||
|
withChromiumHeadlessShell = true;
|
||||||
|
};
|
||||||
|
chromium = pkgs.runCommand "chromium-headless-shell" { } ''
|
||||||
|
mkdir -p $out/bin
|
||||||
|
ln -s ${chromiumHeadlessShellBrowsers}/chromium_headless_shell-*/chrome-headless-shell-linux64/chrome-headless-shell $out/bin/chromium
|
||||||
|
'';
|
||||||
extraPrograms = [ chromium ];
|
extraPrograms = [ chromium ];
|
||||||
|
|
||||||
# Management script
|
# Management script
|
||||||
@@ -486,7 +500,6 @@ in
|
|||||||
|
|
||||||
recommendedTlsSettings = (if (cfg.hostname == "localhost") then false else true);
|
recommendedTlsSettings = (if (cfg.hostname == "localhost") then false else true);
|
||||||
recommendedGzipSettings = true;
|
recommendedGzipSettings = true;
|
||||||
recommendedProxySettings = true;
|
|
||||||
recommendedOptimisation = true;
|
recommendedOptimisation = true;
|
||||||
|
|
||||||
clientMaxBodySize = cfg.maxUploadSize;
|
clientMaxBodySize = cfg.maxUploadSize;
|
||||||
@@ -498,28 +511,34 @@ in
|
|||||||
addSSL = lib.mkForce (if (cfg.hostname == "localhost") then false else true);
|
addSSL = lib.mkForce (if (cfg.hostname == "localhost") then false else true);
|
||||||
enableACME = lib.mkForce (if (cfg.hostname == "localhost") then false else true);
|
enableACME = lib.mkForce (if (cfg.hostname == "localhost") then false else true);
|
||||||
locations = {
|
locations = {
|
||||||
|
# Handle Laravel Routes
|
||||||
"/".tryFiles = "$uri $uri/ /index.php?$query_string";
|
"/".tryFiles = "$uri $uri/ /index.php?$query_string";
|
||||||
"/".extraConfig = ''
|
|
||||||
if (!-e $request_filename) {
|
# PHP Processing
|
||||||
rewrite ^(.+)$ /index.php?q=$1 last;
|
"~ \\.php$".extraConfig = ''
|
||||||
}
|
include ${config.services.nginx.package}/conf/fastcgi_params;
|
||||||
add_header 'Access-Control-Allow-Origin' '*';
|
fastcgi_param SCRIPT_FILENAME $request_filename;
|
||||||
add_header 'Access-Control-Allow-Methods' '*';
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||||
add_header 'Access-Control-Max-Age' 0;
|
|
||||||
add_header 'Content-Length' 0;
|
|
||||||
add_header 'Access-Control-Allow-Headers' 'X-API-COMPANY-KEY,X-API-SECRET,X-API-TOKEN,X-API-PASSWORD,DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Disposition,Content-Type,Range,X-CSRF-TOKEN,X-XSRF-TOKEN,X-LIVEWIRE';
|
|
||||||
add_header 'Access-Control-Expose-Headers' 'X-APP-VERSION,X-MINIMUM-CLIENT-VERSION,X-CSRF-TOKEN,X-XSRF-TOKEN,X-LIVEWIRE';
|
|
||||||
add_header 'Access-Control-Allow-Credentials' false;
|
|
||||||
'';
|
|
||||||
"~ \\.php$".extraConfig = "return 403;";
|
|
||||||
"= /index.php".extraConfig = ''
|
|
||||||
fastcgi_pass unix:${config.services.phpfpm.pools.invoiceninja.socket};
|
fastcgi_pass unix:${config.services.phpfpm.pools.invoiceninja.socket};
|
||||||
|
fastcgi_index index.php;
|
||||||
'';
|
'';
|
||||||
|
|
||||||
|
# Security: Deny access to hidden files
|
||||||
"~ /\\.ht".extraConfig = "deny all;";
|
"~ /\\.ht".extraConfig = "deny all;";
|
||||||
|
|
||||||
|
# Static Files Caching
|
||||||
|
"~* \\.(jpg|jpeg|png|gif|ico|css|js)$".extraConfig = ''
|
||||||
|
expires 1y;
|
||||||
|
add_header Cache-Control "public, immutable";
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
extraConfig = ''
|
extraConfig = ''
|
||||||
index index.html index.htm index.php;
|
index index.php index.html index.htm;
|
||||||
error_page 404 /index.php;
|
error_page 404 /index.php;
|
||||||
|
|
||||||
|
if (!-e $request_filename) {
|
||||||
|
rewrite ^(.+)$ /index.php?q= last;
|
||||||
|
}
|
||||||
'';
|
'';
|
||||||
}
|
}
|
||||||
(lib.mkIf (cfg.hostname != "localhost") {
|
(lib.mkIf (cfg.hostname != "localhost") {
|
||||||
@@ -551,19 +570,18 @@ in
|
|||||||
cfg.proxy.caddyConfig
|
cfg.proxy.caddyConfig
|
||||||
{
|
{
|
||||||
hostName = lib.mkForce proto_hostname;
|
hostName = lib.mkForce proto_hostname;
|
||||||
|
# Caddy matches vhosts on the exact Host header, unlike nginx's single-vhost-is-default
|
||||||
|
# behavior. For local dev, accept requests to 127.0.0.1/[::1] too - otherwise visiting
|
||||||
|
# via the IP literal instead of "localhost" hits no vhost and gets an empty 200 response
|
||||||
|
# (a silent white screen, no error anywhere).
|
||||||
|
serverAliases = lib.mkIf (cfg.hostname == "localhost") [
|
||||||
|
"127.0.0.1:80"
|
||||||
|
"[::1]:80"
|
||||||
|
];
|
||||||
extraConfig = ''
|
extraConfig = ''
|
||||||
encode zstd gzip
|
encode zstd gzip
|
||||||
root * ${invoiceninja}/public
|
root ${invoiceninja}/public
|
||||||
php_fastcgi unix/${config.services.phpfpm.pools.invoiceninja.socket}
|
php_fastcgi unix/${config.services.phpfpm.pools.invoiceninja.socket}
|
||||||
try_files {path} /index.html
|
|
||||||
header {
|
|
||||||
Access-Control-Allow-Origin "*"
|
|
||||||
Access-Control-Allow-Methods "*"
|
|
||||||
Access-Control-Max-Age "0"
|
|
||||||
Access-Control-Allow-Headers "X-API-COMPANY-KEY,X-API-SECRET,X-API-TOKEN,X-API-PASSWORD,DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Disposition,Content-Type,Range,X-CSRF-TOKEN,X-XSRF-TOKEN,X-LIVEWIRE"
|
|
||||||
Access-Control-Expose-Headers "X-APP-VERSION,X-MINIMUM-CLIENT-VERSION,X-CSRF-TOKEN,X-XSRF-TOKEN,X-LIVEWIRE"
|
|
||||||
Access-Control-Allow-Credentials false
|
|
||||||
}
|
|
||||||
file_server
|
file_server
|
||||||
'';
|
'';
|
||||||
}
|
}
|
||||||
@@ -610,6 +628,32 @@ in
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
systemd.services.invoiceninja-scheduler = {
|
||||||
|
description = "Invoice Ninja scheduled tasks (artisan schedule:run)";
|
||||||
|
after = [ "invoiceninja-data-setup.service" ];
|
||||||
|
requires = [ "phpfpm-invoiceninja.service" ];
|
||||||
|
# Ensure chromium is available, for any scheduled tasks that generate PDFs.
|
||||||
|
path = extraPrograms;
|
||||||
|
|
||||||
|
serviceConfig = {
|
||||||
|
Type = "oneshot";
|
||||||
|
ExecStart = "${invoiceninja-manage}/bin/invoiceninja-manage schedule:run";
|
||||||
|
User = user;
|
||||||
|
Group = group;
|
||||||
|
StateDirectory = lib.mkIf (cfg.dataDir == "/var/lib/invoiceninja") "invoiceninja";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
systemd.timers.invoiceninja-scheduler = {
|
||||||
|
description = "Run Invoice Ninja's scheduled tasks every minute";
|
||||||
|
wantedBy = [ "timers.target" ];
|
||||||
|
timerConfig = {
|
||||||
|
OnCalendar = "minutely";
|
||||||
|
Persistent = true;
|
||||||
|
Unit = "invoiceninja-scheduler.service";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
systemd.services.invoiceninja-data-setup = {
|
systemd.services.invoiceninja-data-setup = {
|
||||||
description = "Invoice Ninja setup: migrations, environment file update, cache reload, data changes";
|
description = "Invoice Ninja setup: migrations, environment file update, cache reload, data changes";
|
||||||
wantedBy = [ "multi-user.target" ];
|
wantedBy = [ "multi-user.target" ];
|
||||||
@@ -658,13 +702,24 @@ in
|
|||||||
# We cannot link the cache folder only because bootstrap folder needs to be writeable.
|
# We cannot link the cache folder only because bootstrap folder needs to be writeable.
|
||||||
ln -sf ${invoiceninja}/bootstrap-static/app.php ${cfg.runtimeDir}/app.php
|
ln -sf ${invoiceninja}/bootstrap-static/app.php ${cfg.runtimeDir}/app.php
|
||||||
|
|
||||||
# Perform the first migration
|
# Run migrations on every activation, not just the first: `migrate` is idempotent
|
||||||
[[ ! -f ${cfg.dataDir}/.initial-migration ]] && invoiceninja-manage migrate --force && touch ${cfg.dataDir}/.initial-migration
|
# (Laravel tracks applied migrations in the DB and only runs new ones), and gating this
|
||||||
|
# behind a marker file meant migrations shipped by a later invoiceninja version upgrade
|
||||||
|
# would never run.
|
||||||
|
invoiceninja-manage migrate --force
|
||||||
|
|
||||||
# Seed database with records
|
# Seed database with records
|
||||||
# Necessary for languages, currencies, countries, etc.
|
# Necessary for languages, currencies, countries, etc.
|
||||||
[[ ! -f ${cfg.dataDir}/.db-seeded ]] && invoiceninja-manage db:seed --force && touch ${cfg.dataDir}/.db-seeded
|
[[ ! -f ${cfg.dataDir}/.db-seeded ]] && invoiceninja-manage db:seed --force && touch ${cfg.dataDir}/.db-seeded
|
||||||
|
|
||||||
|
# Work around an upstream bug: migration 2025_08_31_224356_additional_languages_af_ca_id.php
|
||||||
|
# runs during `migrate` (before db:seed's LanguageSeeder has populated the other 42 rows) and
|
||||||
|
# does `Cache::forever('languages', Language::all())`, permanently caching just the 3 languages
|
||||||
|
# it sees at that moment. Without this, the language list stays stuck at those 3 forever,
|
||||||
|
# since StaticServiceProvider checks this cache key before ever querying the DB again.
|
||||||
|
# Unconditional (not marker-gated) so it also self-heals installs that hit this before the fix.
|
||||||
|
invoiceninja-manage cache:forget languages
|
||||||
|
|
||||||
# Create Invoice Ninja admin account
|
# Create Invoice Ninja admin account
|
||||||
[[ (! -f ${cfg.dataDir}/.admin-created) && (${
|
[[ (! -f ${cfg.dataDir}/.admin-created) && (${
|
||||||
if cfg.adminAccount.enable then "true" else "false"
|
if cfg.adminAccount.enable then "true" else "false"
|
||||||
|
|||||||
+101
-25
@@ -1,37 +1,125 @@
|
|||||||
{ lib
|
{ lib
|
||||||
, php
|
, buildNpmPackage
|
||||||
, openssl
|
, npmHooks
|
||||||
, writers
|
|
||||||
, fetchFromGitHub
|
, fetchFromGitHub
|
||||||
|
, fetchNpmDeps
|
||||||
|
, jq
|
||||||
|
, php82
|
||||||
|
, nodejs_22
|
||||||
|
, npm-lockfile-fix
|
||||||
, dataDir ? "/var/lib/invoiceninja"
|
, dataDir ? "/var/lib/invoiceninja"
|
||||||
, runtimeDir ? "/run/invoiceninja"
|
, runtimeDir ? "/run/invoiceninja"
|
||||||
}:
|
}:
|
||||||
|
|
||||||
php.buildComposerProject (finalAttrs: {
|
let
|
||||||
pname = "invoiceninja";
|
pname = "invoiceninja";
|
||||||
version = "5.11.41";
|
|
||||||
|
|
||||||
|
version = "5.13.50";
|
||||||
src = fetchFromGitHub {
|
src = fetchFromGitHub {
|
||||||
owner = "invoiceninja";
|
name = "${pname}";
|
||||||
repo = "invoiceninja";
|
owner = pname;
|
||||||
rev = "v${finalAttrs.version}";
|
repo = pname;
|
||||||
hash = "sha256-6fCuNv+PIlUe9fOZwP6VfLuomSlUTmBiF/bjxKfs9Ig=";
|
rev = "v${version}";
|
||||||
|
hash = "sha256-UU0Q2WReh8LXBGClQqw1QmOVG6I5Ho27U/u4fTHiwE0=";
|
||||||
|
|
||||||
|
postFetch = ''
|
||||||
|
# add missing integrity fields to lockfile
|
||||||
|
${npm-lockfile-fix}/bin/npm-lockfile-fix $out/package-lock.json
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
vendorHash = "sha256-KoBJJU0ViX99dNVxO8/7gk2SuDwuXbcHkqI5CpiHoLE=";
|
uiVersion = "18.10.2026.1";
|
||||||
|
uiSrc = fetchFromGitHub {
|
||||||
|
name = "${pname}-ui";
|
||||||
|
owner = pname;
|
||||||
|
repo = "ui";
|
||||||
|
tag = uiVersion;
|
||||||
|
hash = "sha256-56szHmIWU9De04Orykp2RxrW0RV87JxB7Y1yvdrSJm4=";
|
||||||
|
|
||||||
patches = [
|
postFetch = ''
|
||||||
./disable-react-for-admin.patch
|
# add missing integrity fields to lockfile
|
||||||
|
${npm-lockfile-fix}/bin/npm-lockfile-fix $out/package-lock.json
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
# React frontend
|
||||||
|
ui = buildNpmPackage {
|
||||||
|
pname = "${pname}-ui";
|
||||||
|
version = uiVersion;
|
||||||
|
src = uiSrc;
|
||||||
|
|
||||||
|
nodejs = nodejs_22;
|
||||||
|
|
||||||
|
npmDepsHash = "sha256-j5XocHvBfMvzNrkaVkTsck2+yPraYWrXQxAbf3EYfIk=";
|
||||||
|
|
||||||
|
preConfigure = ''
|
||||||
|
sed -i 's/VITE_IS_TEST=true/VITE_IS_TEST=false/' .env.example
|
||||||
|
|
||||||
|
cp .env.example .env
|
||||||
|
cp ${src}/vite.config.ts.react ./vite.config.js
|
||||||
|
'';
|
||||||
|
|
||||||
|
installPhase = ''
|
||||||
|
runHook preInstall
|
||||||
|
|
||||||
|
mkdir $out
|
||||||
|
cp -a * $out
|
||||||
|
|
||||||
|
runHook postInstall
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
in
|
||||||
|
|
||||||
|
php82.buildComposerProject (finalAttrs: {
|
||||||
|
inherit src version;
|
||||||
|
pname = "${pname}-composer";
|
||||||
|
|
||||||
|
passthru.ui = ui;
|
||||||
|
|
||||||
|
nativeBuildInputs = [
|
||||||
|
jq
|
||||||
|
nodejs_22
|
||||||
|
npmHooks.npmConfigHook
|
||||||
|
npmHooks.npmBuildHook
|
||||||
];
|
];
|
||||||
|
|
||||||
|
vendorHash = "sha256-z/DX3w0F8FfejnK84yMawKuvft8I4I51Xn7Kgiy/DQo=";
|
||||||
|
|
||||||
# Upstream composer.json has invalid license, webpatser/laravel-countries package is pointing
|
# Upstream composer.json has invalid license, webpatser/laravel-countries package is pointing
|
||||||
# to commit-ref, and php required in require and require-dev
|
# to commit-ref, and php required in require and require-dev
|
||||||
composerStrictValidation = false;
|
composerStrictValidation = false;
|
||||||
|
|
||||||
|
CYPRESS_INSTALL_BINARY = 0;
|
||||||
|
|
||||||
|
npmDeps = fetchNpmDeps {
|
||||||
|
name = "${pname}-${version}-npm-deps";
|
||||||
|
inherit src;
|
||||||
|
hash = "sha256-1Bw8m4JdCXQ48p9eO936OP3qW8n0sbrDfzBA2y+dcqY=";
|
||||||
|
};
|
||||||
|
|
||||||
|
preConfigure = ''
|
||||||
|
cp -r ${ui}/dist/* public/
|
||||||
|
cp public/index.html resources/views/react/index.blade.php
|
||||||
|
'';
|
||||||
|
|
||||||
postInstall = ''
|
postInstall = ''
|
||||||
mv "$out/share/php/${finalAttrs.pname}"/* $out
|
mv "$out/share/php/${finalAttrs.pname}"/* $out
|
||||||
rm -R $out/bootstrap/cache
|
|
||||||
|
|
||||||
|
# Remove JS/CSS build artifacts
|
||||||
|
rm -rf $out/node_modules
|
||||||
|
|
||||||
|
# composer.lock and vendor/composer/installed.json record each package's "dist.url" as the
|
||||||
|
# store path of the composer-repository mirror it was installed from, which otherwise drags
|
||||||
|
# that whole (500+MB) fixed-output derivation into the runtime closure for no reason -- it's
|
||||||
|
# provenance metadata, not something Laravel's package manifest (which only reads
|
||||||
|
# name/extra) or Composer\InstalledVersions (which reads vendor/composer/installed.php, not
|
||||||
|
# this file) consult at runtime.
|
||||||
|
jq '(.packages[]?.dist.url) |= "removed"' $out/vendor/composer/installed.json > $out/vendor/composer/installed.json.tmp
|
||||||
|
mv $out/vendor/composer/installed.json.tmp $out/vendor/composer/installed.json
|
||||||
|
jq '(.packages[]?.dist.url, .["packages-dev"][]?.dist.url) |= "removed"' $out/composer.lock > $out/composer.lock.tmp
|
||||||
|
mv $out/composer.lock.tmp $out/composer.lock
|
||||||
|
|
||||||
|
rm -r $out/bootstrap/cache
|
||||||
rm -rf $out/public/storage
|
rm -rf $out/public/storage
|
||||||
|
|
||||||
# Move static contents for the NixOS module to pick it up, if needed.
|
# Move static contents for the NixOS module to pick it up, if needed.
|
||||||
@@ -44,16 +132,4 @@ php.buildComposerProject (finalAttrs: {
|
|||||||
ln -s ${dataDir}/storage/app/public $out/public/storage
|
ln -s ${dataDir}/storage/app/public $out/public/storage
|
||||||
ln -s ${runtimeDir} $out/bootstrap
|
ln -s ${runtimeDir} $out/bootstrap
|
||||||
'';
|
'';
|
||||||
|
|
||||||
meta = {
|
|
||||||
description = "Open-source, self-hosted invoicing application";
|
|
||||||
homepage = "https://www.invoiceninja.com/";
|
|
||||||
license = with lib.licenses; {
|
|
||||||
fullName = "Elastic License 2.0";
|
|
||||||
shortName = "Elastic-2.0";
|
|
||||||
free = false;
|
|
||||||
};
|
|
||||||
platforms = lib.platforms.all;
|
|
||||||
};
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{ proxyServer ? "nginx" }:
|
||||||
|
{ ... }:
|
||||||
|
|
||||||
|
{
|
||||||
|
imports = [ ../nixos-module/invoiceninja.nix ];
|
||||||
|
|
||||||
|
services.invoiceninja = {
|
||||||
|
enable = true;
|
||||||
|
proxy.server = proxyServer;
|
||||||
|
adminAccount.passwordFile = ./invoice_ninja_test_password;
|
||||||
|
secretFile = ./test.env;
|
||||||
|
settings.APP_DEBUG = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
networking.firewall.enable = false;
|
||||||
|
}
|
||||||
+40
-18
@@ -1,30 +1,52 @@
|
|||||||
{ modulesPath, ... }:
|
{ proxyServer ? "nginx" }:
|
||||||
|
{ pkgs, modulesPath, ... }:
|
||||||
|
|
||||||
{
|
{
|
||||||
imports = [
|
imports = [
|
||||||
(modulesPath + "/profiles/qemu-guest.nix")
|
(modulesPath + "/profiles/qemu-guest.nix")
|
||||||
../nixos-module/invoiceninja.nix
|
# Not imported by default for a plain nixosSystem in this nixpkgs (only nixosTest nodes get it
|
||||||
|
# automatically) - needed explicitly so virtualisation.cores/memorySize below are real options.
|
||||||
|
(modulesPath + "/virtualisation/qemu-vm.nix")
|
||||||
|
(import ./common.nix { inherit proxyServer; })
|
||||||
];
|
];
|
||||||
|
|
||||||
system.stateVersion = "24.11";
|
# `nix flake check` evaluates config.system.build.toplevel directly, which asserts a real root
|
||||||
|
# filesystem and bootloader are configured. `just build-vm` builds config.system.build.vm
|
||||||
nixpkgs.config.allowUnfree = true;
|
# instead, where the qemu-vm module overrides both of these with a tmpfs root and direct
|
||||||
|
# kernel boot (virtualisation.useBootLoader defaults to false) - so these values just need to
|
||||||
users.users.test = {
|
# satisfy the assertions and are otherwise unused.
|
||||||
isNormalUser = true;
|
fileSystems."/" = {
|
||||||
extraGroups = [ "wheel" ];
|
device = "/dev/disk/by-label/nixos";
|
||||||
initialPassword = "test";
|
fsType = "ext4";
|
||||||
};
|
};
|
||||||
|
boot.loader.grub.enable = false;
|
||||||
|
|
||||||
services.invoiceninja = {
|
users.users.root = {
|
||||||
enable = true;
|
initialPassword = "toor";
|
||||||
proxy.server = "caddy";
|
|
||||||
adminAccount.passwordFile = ./invoice_ninja_test_password;
|
|
||||||
secretFile = ./test.env;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
networking.firewall.enable = false;
|
|
||||||
|
|
||||||
services.resolved.enable = true;
|
services.resolved.enable = true;
|
||||||
}
|
|
||||||
|
|
||||||
|
# `just boot-vm` forwards the guest's port 80 to host port 8080 (QEMU_NET_OPTS in the justfile),
|
||||||
|
# but the backend builds absolute URLs (e.g. the stored company logo path) from APP_URL, which
|
||||||
|
# defaults to plain "http://localhost" with no port. The SPA's own relative URLs are fine (they
|
||||||
|
# inherit whatever port the browser is already on), but any backend-generated absolute URL then
|
||||||
|
# points at host port 80 - where nothing is listening - instead of the forwarded 8080, giving a
|
||||||
|
# silent net::ERR_CONNECTION_REFUSED for things like the logo image. Override to match the actual
|
||||||
|
# forwarded port.
|
||||||
|
services.invoiceninja.settings.APP_URL = "http://localhost:8080";
|
||||||
|
|
||||||
|
# The qemu-vm module's defaults (1 core, 1024MB) are too tight for real interactive use: MySQL +
|
||||||
|
# Redis + PHP-FPM + chromium (PDF generation, spawned per request - each is a full multi-process
|
||||||
|
# browser, not a lightweight renderer) running concurrently can exhaust 1GB fast, and this VM
|
||||||
|
# boots with panic_on_oom - so it's not a graceful slowdown, the whole VM goes down. Confirmed by
|
||||||
|
# reproducing a "logo upload hangs" report this way: at the 1024MB default, even a couple of
|
||||||
|
# concurrent PDF-generation requests triggered `redis-server invoked oom-killer` and a kernel
|
||||||
|
# panic. 2 cores / 2560MB comfortably handles 2 concurrent PDF generations alongside normal
|
||||||
|
# traffic (verified: ~1.4GB still free afterward); a deliberate flood of many concurrent PDF
|
||||||
|
# requests can still exhaust even this, since each is a full chromium instance - if that's a
|
||||||
|
# concern for your deployment, consider capping `phpfpm.settings."pm.max_children"` below its
|
||||||
|
# default of 8, or provisioning more RAM.
|
||||||
|
virtualisation.cores = 2;
|
||||||
|
virtualisation.memorySize = 2560;
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,131 @@
|
|||||||
|
{ nixpkgsPath, system }:
|
||||||
|
|
||||||
|
let
|
||||||
|
pkgs = import nixpkgsPath { inherit system; };
|
||||||
|
|
||||||
|
adminEmail = "admin@email.com";
|
||||||
|
adminPassword = pkgs.lib.strings.trim (builtins.readFile ./invoice_ninja_test_password);
|
||||||
|
in
|
||||||
|
pkgs.testers.nixosTest {
|
||||||
|
name = "invoiceninja";
|
||||||
|
|
||||||
|
nodes = {
|
||||||
|
nginx.imports = [ (import ./common.nix { proxyServer = "nginx"; }) ];
|
||||||
|
caddy.imports = [ (import ./common.nix { proxyServer = "caddy"; }) ];
|
||||||
|
};
|
||||||
|
|
||||||
|
testScript = ''
|
||||||
|
import json
|
||||||
|
|
||||||
|
def api_get(machine, path, token):
|
||||||
|
return json.loads(machine.succeed(f"curl -sf http://localhost{path} -H 'X-API-TOKEN: {token}'"))
|
||||||
|
|
||||||
|
def api_post(machine, path, payload, token=None):
|
||||||
|
auth_header = f"-H 'X-API-TOKEN: {token}' " if token else ""
|
||||||
|
return json.loads(machine.succeed(
|
||||||
|
f"curl -sf -X POST http://localhost{path} "
|
||||||
|
+ auth_header
|
||||||
|
+ "-H 'Content-Type: application/json' "
|
||||||
|
+ f"-d '{json.dumps(payload)}'"
|
||||||
|
))
|
||||||
|
|
||||||
|
def check_invoiceninja(machine, proxy_unit):
|
||||||
|
machine.wait_for_unit("mysql.service")
|
||||||
|
machine.wait_for_unit("redis-invoiceninja.service")
|
||||||
|
machine.wait_for_unit("phpfpm-invoiceninja.service")
|
||||||
|
machine.wait_for_unit("invoiceninja-queue-worker.service")
|
||||||
|
machine.wait_for_unit(proxy_unit)
|
||||||
|
machine.wait_for_open_port(80)
|
||||||
|
|
||||||
|
# phpfpm-invoiceninja/invoiceninja-queue-worker both Require= invoiceninja-data-setup,
|
||||||
|
# so systemd already waited for it to finish above. Confirm the one-time setup steps
|
||||||
|
# it guards actually completed, rather than just that the unit exited. (Migrations run
|
||||||
|
# unconditionally on every activation rather than being marker-gated, so there's no
|
||||||
|
# marker file to check for them here.)
|
||||||
|
with subtest("one-time setup (seed, admin account) completed"):
|
||||||
|
machine.succeed("test -f /var/lib/invoiceninja/.db-seeded")
|
||||||
|
machine.succeed("test -f /var/lib/invoiceninja/.admin-created")
|
||||||
|
|
||||||
|
with subtest("application shell is served over HTTP"):
|
||||||
|
response = machine.succeed("curl -sf http://localhost/")
|
||||||
|
assert "Invoice Ninja" in response, f"unexpected response from /: {response}"
|
||||||
|
|
||||||
|
with subtest("web UI login page is served"):
|
||||||
|
# The UI is a client-side-routed React SPA, so curl (no JS) only sees the same
|
||||||
|
# index.html shell as "/" - this confirms the proxy/Laravel resolve the /login route
|
||||||
|
# to that shell instead of 404ing, which is what a browser needs before it can
|
||||||
|
# render the actual login form.
|
||||||
|
login_page = machine.succeed("curl -sf http://localhost/login")
|
||||||
|
assert "Invoice Ninja" in login_page, f"unexpected response from /login: {login_page}"
|
||||||
|
|
||||||
|
with subtest("invoiceninja-manage wrapper can run artisan commands"):
|
||||||
|
machine.succeed("invoiceninja-manage migrate:status")
|
||||||
|
|
||||||
|
with subtest("scheduler timer is enabled and schedule:run succeeds"):
|
||||||
|
# Without this, the app's dashboard reports "cron jobs are not enabled".
|
||||||
|
machine.succeed("systemctl is-active invoiceninja-scheduler.timer")
|
||||||
|
machine.succeed("systemctl start --wait invoiceninja-scheduler.service")
|
||||||
|
|
||||||
|
with subtest("admin account can log in via the API"):
|
||||||
|
login_response = api_post(machine, "/api/v1/login", {"email": "${adminEmail}", "password": "${adminPassword}"})
|
||||||
|
assert "${adminEmail}" in json.dumps(login_response), f"login did not succeed: {login_response}"
|
||||||
|
token = login_response["data"][0]["token"]["token"]
|
||||||
|
|
||||||
|
with subtest("full language list is available, not just the af/ca/id migration's 3"):
|
||||||
|
# Regression check: migration 2025_08_31_224356_additional_languages_af_ca_id.php runs
|
||||||
|
# during `migrate`, before db:seed's LanguageSeeder has populated the other 42 rows, and
|
||||||
|
# does Cache::forever('languages', Language::all()) - permanently caching just the 3
|
||||||
|
# languages it sees at that moment. invoiceninja-data-setup works around this with
|
||||||
|
# `invoiceninja-manage cache:forget languages`; this confirms the workaround is in place.
|
||||||
|
language_count = len(api_get(machine, "/api/v1/statics", token)["languages"])
|
||||||
|
assert language_count > 40, f"expected ~45 languages, got {language_count}"
|
||||||
|
|
||||||
|
with subtest("PDF generation works (chromium/snappdf)"):
|
||||||
|
# /api/v1/preview with no entity falls back to a self-contained mock PDF (no invoice/client
|
||||||
|
# setup needed), exercising the same chromium/snappdf pipeline real invoice PDFs use.
|
||||||
|
# This fallback only triggers when the company has no invoices/invitations at all yet
|
||||||
|
# (PreviewController::blankEntity), so this must run before the client/invoice/payment
|
||||||
|
# subtest below creates one.
|
||||||
|
machine.succeed(
|
||||||
|
"curl -sf -X POST http://localhost/api/v1/preview "
|
||||||
|
+ f"-H 'X-API-TOKEN: {token}' -H 'Content-Type: application/json' "
|
||||||
|
+ "-d '{}' -o /tmp/preview.pdf"
|
||||||
|
)
|
||||||
|
magic_bytes = machine.succeed("head -c 4 /tmp/preview.pdf")
|
||||||
|
assert magic_bytes == "%PDF", f"expected a PDF, got: {magic_bytes!r}"
|
||||||
|
|
||||||
|
with subtest("a client can be created, invoiced, and pay that invoice in full"):
|
||||||
|
client = api_post(machine, "/api/v1/clients", {"name": "Test Client"}, token)["data"]
|
||||||
|
|
||||||
|
invoice = api_post(machine, "/api/v1/invoices", {
|
||||||
|
"client_id": client["id"],
|
||||||
|
"line_items": [
|
||||||
|
{"quantity": 1, "cost": 100, "product_key": "test-product", "notes": "test line item"},
|
||||||
|
],
|
||||||
|
}, token)["data"]
|
||||||
|
assert invoice["amount"] == 100, f"unexpected invoice amount: {invoice}"
|
||||||
|
|
||||||
|
# Mirrors the normal workflow of sending an invoice to a client before it's paid,
|
||||||
|
# rather than relying on the fact that draft invoices also happen to be payable.
|
||||||
|
api_get(machine, f"/api/v1/invoices/{invoice['id']}/mark_sent", token)
|
||||||
|
|
||||||
|
payment = api_post(machine, "/api/v1/payments", {
|
||||||
|
"client_id": client["id"],
|
||||||
|
"amount": invoice["amount"],
|
||||||
|
"invoices": [{"invoice_id": invoice["id"], "amount": invoice["amount"]}],
|
||||||
|
}, token)["data"]
|
||||||
|
assert payment["applied"] == invoice["amount"], f"payment not fully applied: {payment}"
|
||||||
|
|
||||||
|
paid_invoice = api_get(machine, f"/api/v1/invoices/{invoice['id']}", token)["data"]
|
||||||
|
# status_id 4 == STATUS_PAID
|
||||||
|
assert paid_invoice["status_id"] == "4", f"invoice not marked paid: {paid_invoice}"
|
||||||
|
assert paid_invoice["balance"] == 0, f"invoice balance not zero: {paid_invoice}"
|
||||||
|
|
||||||
|
|
||||||
|
nginx.start()
|
||||||
|
caddy.start()
|
||||||
|
|
||||||
|
check_invoiceninja(nginx, "nginx.service")
|
||||||
|
check_invoiceninja(caddy, "caddy.service")
|
||||||
|
'';
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user