Traefik - Revision history

Eepystrawberry: moved a closing bracket in the config example, previous example does not build because "log" and "certificateResolvers" are listed under "entryPoints", rather than "staticConigOptions"

2024-11-26T22:26:11Z

moved a closing bracket in the config example, previous example does not build because "log" and "certificateResolvers" are listed under "entryPoints", rather than "staticConigOptions"

← Older revision		Revision as of 22:26, 26 November 2024
Line 29:		Line 29:
	http.tls.certResolver = "letsencrypt";		http.tls.certResolver = "letsencrypt";
	};		};
			};

	log = {		log = {
	level = "INFO";		level = "INFO";
	filePath = "${config.services.traefik.dataDir}/traefik.log";		filePath = "${config.services.traefik.dataDir}/traefik.log";
	format = "json";		format = "json";
	};		};

	certificatesResolvers.letsencrypt.acme = {		certificatesResolvers.letsencrypt.acme = {
	email = "postmaster@YOUR.DOMAIN";		email = "postmaster@YOUR.DOMAIN";
	storage = "${config.services.traefik.dataDir}/acme.json";		storage = "${config.services.traefik.dataDir}/acme.json";
	httpChallenge.entryPoint = "web";		httpChallenge.entryPoint = "web";
	};
	};		};

Dander: be more specific that "Using files"

2024-10-23T20:25:42Z

be more specific that "Using files"

← Older revision		Revision as of 20:25, 23 October 2024
Line 55:		Line 55:
	</syntaxhighlight>		</syntaxhighlight>

	==== Using files ====		==== Using non-Nix configuration files ====
	If you are migrating from a Non-NixOS system, you might be interested in the <code>staticConfigFile</code> and <code>dynamicConfigFile</code> options.		If you are migrating from a Non-NixOS system, you might be interested in the <code>staticConfigFile</code> and <code>dynamicConfigFile</code> options.

Dander: no need to specify "Nix (the language)", no ambiguity

2024-10-23T20:22:56Z

no need to specify "Nix (the language)", no ambiguity

← Older revision		Revision as of 20:22, 23 October 2024
Line 8:		Line 8:
	== Configuration ==		== Configuration ==

	==== Using Nix ~~(the language)~~ ====		==== Using Nix ====
	<syntaxhighlight lang="nixos">		<syntaxhighlight lang="nixos">
	services.traefik = {		services.traefik = {

Dander: replace nixlang with nix the language

2024-10-23T20:21:48Z

replace nixlang with nix the language

← Older revision		Revision as of 20:21, 23 October 2024
Line 8:		Line 8:
	== Configuration ==		== Configuration ==

	==== Using ~~Nixlang~~ (~~Nix~~ the language) ====		==== Using Nix (the language) ====
	<syntaxhighlight lang="nixos">		<syntaxhighlight lang="nixos">
	services.traefik = {		services.traefik = {

Klinger: Category:Applications Category:Server Category:Networking

2024-10-23T14:25:31Z

Category:Applications Category:Server Category:Networking

← Older revision		Revision as of 14:25, 23 October 2024
Line 79:		Line 79:
	};		};
	</syntaxhighlight>Additionally, you can not use a <code>...ConfigFile</code> option and a <code>...ConfigOptions</code> for either static or dynamic configuration. The file options always take precedence over the options options, which are ignored.		</syntaxhighlight>Additionally, you can not use a <code>...ConfigFile</code> option and a <code>...ConfigOptions</code> for either static or dynamic configuration. The file options always take precedence over the options options, which are ignored.


			[[Category:Applications]]
			[[Category:Server]]
			[[Category:Networking]]

Dander: edited for clarity

2024-10-23T11:46:34Z

edited for clarity

← Older revision		Revision as of 11:46, 23 October 2024
Line 60:		Line 60:
	You can set <code>staticConfigFile</code> like this:<syntaxhighlight lang="nixos">		You can set <code>staticConfigFile</code> like this:<syntaxhighlight lang="nixos">
	services.traefik.staticConfigFile = ./static_config.toml;		services.traefik.staticConfigFile = ./static_config.toml;
	</syntaxhighlight>But you need to be careful about how you set the <code>services.traefik.dynamicConfigFile</code> option, if you use a path like shown above, your file will end up in the [[Nix store]], ~~so the path to your config file~~ will change every time you update it, which means Traefik won't be able to reload with your changes automatically, which defeats the point of using the dynamic config file.		</syntaxhighlight>But you need to be careful about how you set the <code>services.traefik.dynamicConfigFile</code> option, if you use a path like shown above, your file will end up in the [[Nix store]], and it will change every time you update your configuration, which means Traefik won't be able to reload with your changes automatically, which defeats the point of using the dynamic config file.

	A way to avoid this is to use <code>etc.environment</code>:<syntaxhighlight lang="nixos">		A way to avoid this is to use <code>etc.environment</code>:<syntaxhighlight lang="nixos">

Dander: rewording

2024-10-23T11:45:37Z

rewording

← Older revision		Revision as of 11:45, 23 October 2024
Line 60:		Line 60:
	You can set <code>staticConfigFile</code> like this:<syntaxhighlight lang="nixos">		You can set <code>staticConfigFile</code> like this:<syntaxhighlight lang="nixos">
	services.traefik.staticConfigFile = ./static_config.toml;		services.traefik.staticConfigFile = ./static_config.toml;
	</syntaxhighlight>But you need to be careful about how you set the <code>dynamicConfigFile</code>, if you ~~pass~~ a path, your ~~"dynamic" config~~ file will ~~point to a path~~ in the Nix store, ~~which would~~ change on every update ~~to the file~~, ~~so you would need~~ to reload ~~Traefik for the~~ changes ~~to take effect~~, which defeats the point of using the dynamic config file.		</syntaxhighlight>But you need to be careful about how you set the <code>services.traefik.dynamicConfigFile</code> option, if you use a path like shown above, your file will end up in the [[Nix store]], so the path to your config file will change every time you update it, which means Traefik won't be able to reload with your changes automatically, which defeats the point of using the dynamic config file.

	A way to avoid this is to use <code>etc.environment</code>:<syntaxhighlight lang="nixos">		A way to avoid this is to use <code>etc.environment</code>:<syntaxhighlight lang="nixos">

Dander: first draft, will revisit tomorrow

2024-10-22T23:21:23Z

first draft, will revisit tomorrow

New page

[https://traefik.io Traefik] is a [[wikipedia:Reverse_proxy|reverse proxy]] and [[wikipedia:Load_balancing_(computing)|load balancer]].

== Installation ==
To install Traefik, add the following to your NixOS configuration:<syntaxhighlight lang="nixos">
services.traefik.enable = true;
</syntaxhighlight>[https://search.nixos.org/options?show=services.traefik. More options] are available.

== Configuration ==

==== Using Nixlang (Nix the language) ====
<syntaxhighlight lang="nixos">
services.traefik = {
enable = true;

staticConfigOptions = {
entryPoints = {
web = {
address = ":80";
asDefault = true;
http.redirections.entrypoint = {
to = "websecure";
scheme = "https";
};
};

websecure = {
address = ":443";
asDefault = true;
http.tls.certResolver = "letsencrypt";
};

log = {
level = "INFO";
filePath = "${config.services.traefik.dataDir}/traefik.log";
format = "json";
};

certificatesResolvers.letsencrypt.acme = {
email = "postmaster@YOUR.DOMAIN";
storage = "${config.services.traefik.dataDir}/acme.json";
httpChallenge.entryPoint = "web";
};
};

api.dashboard = true;
# Access the Traefik dashboard on <Traefik IP>:8080 of your server
# api.insecure = true;
};

dynamicConfigOptions = {
http.routers = {};
http.services = {};
};
};
</syntaxhighlight>

==== Using files ====
If you are migrating from a Non-NixOS system, you might be interested in the <code>staticConfigFile</code> and <code>dynamicConfigFile</code> options.

You can set <code>staticConfigFile</code> like this:<syntaxhighlight lang="nixos">
services.traefik.staticConfigFile = ./static_config.toml;
</syntaxhighlight>But you need to be careful about how you set the <code>dynamicConfigFile</code>, if you pass a path, your "dynamic" config file will point to a path in the Nix store, which would change on every update to the file, so you would need to reload Traefik for the changes to take effect, which defeats the point of using the dynamic config file.

A way to avoid this is to use <code>etc.environment</code>:<syntaxhighlight lang="nixos">
# Note the quotes around the path!
services.traefik.dynamicConfigFile = "/etc/traefik/dynamic_config.toml";
# If you use staticConfigFile instead, update your file provider accordingly.
services.traefik.staticConfigOptions.providers.file.watch = true;

environment.etc."traefik/dynamic_config.toml" = {
user = config.systemd.services.traefik.serviceConfig.User;
group = config.systemd.services.traefik.serviceConfig.Group;
mode = "400";
text = ''
# ...
'';
# Or,
# source = ./dynamic_config.toml
};
</syntaxhighlight>Additionally, you can not use a <code>...ConfigFile</code> option and a <code>...ConfigOptions</code> for either static or dynamic configuration. The file options always take precedence over the options options, which are ignored.