Invoiceplane - Revision history

Onny: /* Invoice templates */ Update example template

2025-08-21T13:10:11Z

Invoice templates: Update example template

← Older revision		Revision as of 13:10, 21 August 2025
Line 36:		Line 36:
	owner = "onny";		owner = "onny";
	repo = "invoiceplane-vtdirektmarketing";		repo = "invoiceplane-vtdirektmarketing";
	rev = "~~a8c272a2d6947d0d33cc4285bea8490f443906f5~~";		rev = "a779ea08aaf88d4a4e8afb555a8953f5432f7d49";
	hash = "sha256-~~v11Z0cQlV/cUijj0gEcDwdupX~~+~~EFGmdlNweo00na/r0~~=";		hash = "sha256-H82p46n7OuJA8nzSZWcVRnxfmTrrqaNy+R5qbj0EWtw=";
	};		};
	makeFlags = [ "DESTDIR=$(out)" ];		makeFlags = [ "DESTDIR=$(out)" ];

Onny: /* Invoice templates */

2025-08-21T12:37:04Z

Invoice templates

← Older revision		Revision as of 12:37, 21 August 2025
Line 26:		Line 26:
	Invoiceplane will render and export invoices as PDF. You can create your own invoice templates or reuse existing ones. The following example fetches an invoice template and makes it available to your running Invoiceplane instance		Invoiceplane will render and export invoices as PDF. You can create your own invoice templates or reuse existing ones. The following example fetches an invoice template and makes it available to your running Invoiceplane instance

	{{file\|~~/etc/nixos/configuration.nix~~\|~~nix~~\|<nowiki>		{{file\|\|\|<nowiki>
	{ config, pkgs, lib, ... }:		{ config, pkgs, lib, ... }:
	let		let
Line 50:		Line 50:

	}		}
	</nowiki>\|name=\|lang=}}		</nowiki>\|name=\|lang=Nix}}

	=== Invoice mail delivery ===		=== Invoice mail delivery ===

Onny: /* Invoice templates */ Update template example

2025-08-21T12:34:46Z

Invoice templates: Update template example

← Older revision		Revision as of 12:34, 21 August 2025
Line 30:		Line 30:
	let		let

	template-vtdirektmarketing = pkgs.stdenv.mkDerivation {		invoiceplane-template-vtdirektmarketing = pkgs.stdenv.mkDerivation {
	name = "vtdirektmarketing";		name = "vtdirektmarketing";
	src = pkgs.~~fetchgit~~ {		src = pkgs.fetchFromGitLab {
	~~url~~ = "~~https://~~git.project-insanity.org/onny/invoiceplane-vtdirektmarketing~~.git~~";		domain = "git.project-insanity.org";
	rev = "~~0a891d836e199cf0f6bd2c4276991665d5d3405e~~";		owner = "onny";
	hash = "sha256-~~GhKd~~+~~dviufeGi3ZnyukzvwzVE5BO7jAx1SdsG~~/~~ioSeU~~=";		repo = "invoiceplane-vtdirektmarketing";
			rev = "a8c272a2d6947d0d33cc4285bea8490f443906f5";
			hash = "sha256-v11Z0cQlV/cUijj0gEcDwdupX+EFGmdlNweo00na/r0=";
	};		};
	makeFlags = [ "DESTDIR=$(out)" ];		makeFlags = [ "DESTDIR=$(out)" ];
Line 44:		Line 46:
	services.invoiceplane.sites."localhost" = {		services.invoiceplane.sites."localhost" = {
	enable = true;		enable = true;
	invoiceTemplates = [ template-vtdirektmarketing ];		invoiceTemplates = [ invoiceplane-template-vtdirektmarketing ];
	};		};

	}		}
	</nowiki>}}		</nowiki>\|name=\|lang=}}

	=== Invoice mail delivery ===		=== Invoice mail delivery ===

Onny: Add dev env example

2025-03-08T15:52:17Z

Add dev env example

← Older revision		Revision as of 15:52, 8 March 2025
Line 103:		Line 103:

	Access your Invoiceplane instance again in your browser and rerun the setup. After upgrading the tables you can login as usual. It is now recommended to change both variables in the config file above back to <code>true</code>.		Access your Invoiceplane instance again in your browser and rerun the setup. After upgrading the tables you can login as usual. It is now recommended to change both variables in the config file above back to <code>true</code>.

			== Tips and tricks ==

			=== Invoice template development ===
			Following <code>flake.nix</code> file helps you spawning a virtual machine running a development environment of Invoiceplane. The local directory <code>/home/user/my_invoiceplane_template</code> containing a modified invoice or quote template will be mounted into the Invoiceplane web app, allowing to change the template and directly render the invoice PDF in the local web server at http://localhost:8080<syntaxhighlight lang="nix">
			{
			description = "Invoiceplane invoice template development shell";

			inputs.nixpkgs.url = "nixpkgs/nixos-24.11";

			outputs = { self, nixpkgs, ... }@inputs:
			let
			pkgs = nixpkgs.legacyPackages.x86_64-linux;
			start =
			pkgs.writeShellScriptBin "start" ''
			set -e
			export QEMU_NET_OPTS="hostfwd=tcp::8080-:80"
			${pkgs.nixos-shell}/bin/nixos-shell --flake .
			'';
			in {
			nixosConfigurations.vm = nixpkgs.lib.nixosSystem {
			system = "x86_64-linux";
			specialArgs.inputs = inputs;
			pkgs = import nixpkgs {
			overlays = [
			(self: super: {
			invoiceplane = super.invoiceplane.overrideAttrs (oldAttrs: rec {
			installPhase = oldAttrs.installPhase + ''
			rm -r $out/application/views/invoice_templates/pdf
			ln -sf /var/lib/invoiceplane/localhost/pdf $out/application/views/invoice_templates/pdf
			'';
			});
			})
			];
			};
			modules = [
			({ lib, config, pkgs, ... }: {

			services.invoiceplane.sites."localhost" = {
			enable = true;
			settings.IP_URL = "http://localhost:8080";
			};

			nixos-shell.mounts.extraMounts = {
			"/var/lib/invoiceplane/localhost/pdf" = {
			target = /home/user/my_invoiceplane_template;
			cache = "none";
			};
			};

			system.stateVersion = "24.11";
			services.getty.autologinUser = "root";
			})
			];
			};

			packages = { inherit start; };
			defaultPackage.x86_64-linux = start;

			};
			}
			</syntaxhighlight>To run the web server simply execute following command in the same directory as the <code>flake.nix</code> file<syntaxhighlight lang="shell">
			nix run
			</syntaxhighlight>

	== See also ==		== See also ==

Onny: /* Invoice templates */ Update example template

2024-12-31T16:22:00Z

Invoice templates: Update example template

← Older revision		Revision as of 16:22, 31 December 2024
Line 34:		Line 34:
	src = pkgs.fetchgit {		src = pkgs.fetchgit {
	url = "https://git.project-insanity.org/onny/invoiceplane-vtdirektmarketing.git";		url = "https://git.project-insanity.org/onny/invoiceplane-vtdirektmarketing.git";
	rev = "~~0c5807132ea6cecdb9d031d9b61e478d371f7607~~";		rev = "0a891d836e199cf0f6bd2c4276991665d5d3405e";
	hash = "sha256-~~sVunmCWRYcZwADQLhQHiuU4faMB05hEqwH1~~/~~os1Rxqo~~=";		hash = "sha256-GhKd+dviufeGi3ZnyukzvwzVE5BO7jAx1SdsG/ioSeU=";
	};		};
	makeFlags = [ "DESTDIR=$(out)" ];		makeFlags = [ "DESTDIR=$(out)" ];

Onny: Remove unstable notice

2024-05-31T08:08:37Z

Remove unstable notice

← Older revision		Revision as of 08:08, 31 May 2024
Line 12:		Line 12:

	It is recommended to disable the setup wizard after installation is complete. Add following arguments to the settings option:		It is recommended to disable the setup wizard after installation is complete. Add following arguments to the settings option:

	~~{{note\|The <code>settings</code> option is not yet available in the stable release channel and will be available with NixOS 24.05.}}~~

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 96:		Line 94:

	After upgrading to a new version of Invoiceplane, change following two lines of your Invoiceplane config to re-enable the setup wizard, required for database upgrades.		After upgrading to a new version of Invoiceplane, change following two lines of your Invoiceplane config to re-enable the setup wizard, required for database upgrades.

	~~{{note\|The <code>settings</code> option is not yet available in the stable release channel and will be available with NixOS 24.05.}}~~

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>

Klinger: Category:Server Category:Web Applications

2024-04-24T19:15:42Z

Category:Server Category:Web Applications

← Older revision		Revision as of 19:15, 24 April 2024
Line 111:		Line 111:
	* [[Crater]], alternative self-hosted invoicing application		* [[Crater]], alternative self-hosted invoicing application

			[[Category:Server]]
	[[Category:Web Applications]]		[[Category:Web Applications]]

imported>Onny: Add security notes on disable setup wizard

2023-11-30T15:24:20Z

Add security notes on disable setup wizard

← Older revision		Revision as of 15:24, 30 November 2023
Line 10:		Line 10:

	After that Invoiceplane will be available at http://localhost . Complete the setup by choosing your default language and setting up your user profile.		After that Invoiceplane will be available at http://localhost . Complete the setup by choosing your default language and setting up your user profile.

			It is recommended to disable the setup wizard after installation is complete. Add following arguments to the settings option:

			{{note\|The <code>settings</code> option is not yet available in the stable release channel and will be available with NixOS 24.05.}}

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			services.invoiceplane.sites."localhost".settings = {
			DISABLE_SETUP=true;
			SETUP_COMPLETED=true;
			};
			</nowiki>}}

	== Configuration ==		== Configuration ==
Line 84:		Line 95:
	=== Upgrading to new versions ===		=== Upgrading to new versions ===

	After upgrading to a new version of Invoiceplane, change following two lines of your Invoiceplane config~~. The path~~ to the ~~file~~		After upgrading to a new version of Invoiceplane, change following two lines of your Invoiceplane config to re-enable the setup wizard, required for database upgrades.
	<code>~~ipconfig.php~~</code> ~~depends on~~ the ~~hostname you configured~~.
	{{file\|/~~var~~/~~lib~~/~~invoiceplane/localhost/ipconfig~~.~~php~~\|nix\|<nowiki>		{{note\|The <code>settings</code> option is not yet available in the stable release channel and will be available with NixOS 24.05.}}
	DISABLE_SETUP=false
	SETUP_COMPLETED=false		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			services.invoiceplane.sites."localhost".settings = {
			DISABLE_SETUP=false;
			SETUP_COMPLETED=false;
			};
	</nowiki>}}		</nowiki>}}

	Access your Invoiceplane instance again in your browser and rerun the setup ~~wizard which now reappears~~. After upgrading the tables you can login as usual. It is now recommended to change both variables in the config file above back to <code>true</code>.		Access your Invoiceplane instance again in your browser and rerun the setup. After upgrading the tables you can login as usual. It is now recommended to change both variables in the config file above back to <code>true</code>.

	== See also ==		== See also ==

imported>Onny at 15:04, 30 November 2023

2023-11-30T15:04:13Z

← Older revision		Revision as of 15:04, 30 November 2023
Line 25:		Line 25:
	src = pkgs.fetchgit {		src = pkgs.fetchgit {
	url = "https://git.project-insanity.org/onny/invoiceplane-vtdirektmarketing.git";		url = "https://git.project-insanity.org/onny/invoiceplane-vtdirektmarketing.git";
	rev = "~~9ac724b207b1f842fe29bb270078f341259785ad~~";		rev = "0c5807132ea6cecdb9d031d9b61e478d371f7607";
	hash = "sha256-~~WYnB5QSNN74eewxNY98iWRwz5kBxbew~~/~~5iAL/N8EIlM~~=";		hash = "sha256-sVunmCWRYcZwADQLhQHiuU4faMB05hEqwH1/os1Rxqo=";
	};		};
	makeFlags = [ "DESTDIR=$(out)" ];		makeFlags = [ "DESTDIR=$(out)" ];

imported>Onny: Add note on enable electronic invoicing

2023-11-27T13:49:45Z

Add note on enable electronic invoicing

← Older revision		Revision as of 13:49, 27 November 2023
Line 59:		Line 59:

	Replace the cron key value with the one given in the Invoiceplane administration web interface.		Replace the cron key value with the one given in the Invoiceplane administration web interface.

			=== Electronic invoice ===

			To enable electronic invoicing using the [http://zugferd.org standard ZUGFeRD], we can hardcode the activation into the InvoicePlane source code. Otherwise it has to be manually enabled in the settings menu of the web app.

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			nixpkgs = {
			overlays = [
			(self: super: {
			invoiceplane = super.invoiceplane.overrideAttrs (oldAttrs: rec {
			postFixup = ''
			sed -i 's/\$include_zugferd = .*/$include_zugferd = true;/g' $out/application/helpers/pdf_helper.php
			'';
			});
			})
			];
			};
			</nowiki>}}

			Enabling this via <code>settings</code> option is [https://github.com/InvoicePlane/InvoicePlane/issues/999 not yet possible].

	== Maintenance ==		== Maintenance ==