Keycloak - Revision history

Martials: Reword note about 25.05

2025-09-06T14:20:35Z

Reword note about 25.05

← Older revision		Revision as of 14:20, 6 September 2025
Line 20:		Line 20:

	=== Importing realms ===		=== Importing realms ===
	{{Note\|~~The~~ module ~~is not yet part of the latest~~ NixOS ~~stable release and will be available with version~~ 25.05~~. Tracking issue: https://github.com/NixOS/nixpkgs/pull/273833~~}}Using the realmFiles option, it is possible provision a realm from a JSON file or previous JSON export.<syntaxhighlight lang="nix">		{{Note\|This module requires NixOS 25.05}}Using the realmFiles option, it is possible provision a realm from a JSON file or previous JSON export.<syntaxhighlight lang="nix">
	{ ... }: let		{ ... }: let

Zarel: realmsFiles didn't land in specified nixos version

2025-02-03T09:16:13Z

realmsFiles didn't land in specified nixos version

← Older revision		Revision as of 09:16, 3 February 2025
Line 20:		Line 20:

	=== Importing realms ===		=== Importing realms ===
	{{Note\|The module is not yet part of the latest NixOS stable release and will be available with version 24.11.}}Using the realmFiles option, it is possible provision a realm from a JSON file or previous JSON export.<syntaxhighlight lang="nix">		{{Note\|The module is not yet part of the latest NixOS stable release and will be available with version 25.05. Tracking issue: https://github.com/NixOS/nixpkgs/pull/273833}}Using the realmFiles option, it is possible provision a realm from a JSON file or previous JSON export.<syntaxhighlight lang="nix">
	{ ... }: let		{ ... }: let

Onny: /* Importing realms */

2024-07-22T13:24:00Z

Importing realms

← Older revision		Revision as of 13:24, 22 July 2024
Line 48:		Line 48:
	services.keycloak = {		services.keycloak = {
	realmFiles = [		realmFiles = [
	pkgs.writeText "OIDCDemo.json" (builtins.toJSON realm)		(pkgs.writeText "OIDCDemo.json" (builtins.toJSON realm))
	];		];
	};		};

Onny: /* Importing realms */

2024-07-22T13:23:18Z

Importing realms

← Older revision		Revision as of 13:23, 22 July 2024
Line 47:		Line 47:

	services.keycloak = {		services.keycloak = {
	realmFiles.OIDCDemo = builtins.toJSON realm;		realmFiles = [
			pkgs.writeText "OIDCDemo.json" (builtins.toJSON realm)
			];
	};		};

Onny: Importing realms

2024-07-20T21:02:14Z

Importing realms

← Older revision		Revision as of 21:02, 20 July 2024
Line 17:		Line 17:
	</syntaxhighlight>After applying the configuration the Keycloak management interface will be available at http://localhost. Login with username <code>admin</code> and password <code>changeme</code>.		</syntaxhighlight>After applying the configuration the Keycloak management interface will be available at http://localhost. Login with username <code>admin</code> and password <code>changeme</code>.

			== Configuration ==

			=== Importing realms ===
			{{Note\|The module is not yet part of the latest NixOS stable release and will be available with version 24.11.}}Using the realmFiles option, it is possible provision a realm from a JSON file or previous JSON export.<syntaxhighlight lang="nix">
			{ ... }: let

			realm = {
			realm = "OIDCDemo";
			enabled = true;
			clients = [{
			clientId = "mydemo";
			rootUrl = "http://localhost:8080";
			}];
			users = [{
			enabled = true;
			firstName = "Christian";
			lastName = "Bauer";
			username = "cbauer";
			email = "cbauer@localhost";
			credentials = [{
			type = "password";
			temporary = false;
			value = "changeme";
			}];
			}];
			};

			in {

			services.keycloak = {
			realmFiles.OIDCDemo = builtins.toJSON realm;
			};

			}
			</syntaxhighlight>
	== Tips and tricks ==		== Tips and tricks ==

Onny: Fix for running http only

2024-06-26T14:15:23Z

Fix for running http only

← Older revision		Revision as of 14:15, 26 June 2024
Line 4:		Line 4:

	== Setup ==		== Setup ==
	Following configuration will enable a minimal Keycloak instance for '''testing purpose'''.<syntaxhighlight lang="nix">		Following configuration will enable a minimal and insecure Keycloak instance for '''testing purpose'''.<syntaxhighlight lang="nix">
	environment.etc."keycloak-database-pass".text = "PWD";		environment.etc."keycloak-database-pass".text = "PWD";
	services.keycloak = {		services.keycloak = {
Line 11:		Line 11:
	hostname = "localhost";		hostname = "localhost";
	http-enabled = true;		http-enabled = true;
			hostname-strict-https = false;
	};		};
	database.passwordFile = "/etc/keycloak-database-pass";		database.passwordFile = "/etc/keycloak-database-pass";

Onny: /* Setup */ Add login instructions

2024-06-23T18:53:34Z

Setup: Add login instructions

← Older revision		Revision as of 18:53, 23 June 2024
Line 4:		Line 4:

	== Setup ==		== Setup ==
	Following configuration will enable a minimal Keycloak instance for testing purpose<syntaxhighlight lang="nix">		Following configuration will enable a minimal Keycloak instance for '''testing purpose'''.<syntaxhighlight lang="nix">
	environment.etc."keycloak-database-pass".text = "PWD";		environment.etc."keycloak-database-pass".text = "PWD";
	services.keycloak = {		services.keycloak = {
Line 14:		Line 14:
	database.passwordFile = "/etc/keycloak-database-pass";		database.passwordFile = "/etc/keycloak-database-pass";
	};		};
	</syntaxhighlight>		</syntaxhighlight>After applying the configuration the Keycloak management interface will be available at http://localhost. Login with username <code>admin</code> and password <code>changeme</code>.

	== Tips and tricks ==		== Tips and tricks ==

Onny: /* Troubleshooting */

2024-06-23T18:47:53Z

Troubleshooting

@@ Line 15: / Line 15: @@
 };
 </syntaxhighlight>
 == Tips and tricks ==

Onny: Add simple setup instruction

2024-06-23T18:46:32Z

Add simple setup instruction

← Older revision		Revision as of 18:46, 23 June 2024
Line 4:		Line 4:

	== Setup ==		== Setup ==
			Following configuration will enable a minimal Keycloak instance for testing purpose<syntaxhighlight lang="nix">
			environment.etc."keycloak-database-pass".text = "PWD";
			services.keycloak = {
			enable = true;
			settings = {
			hostname = "localhost";
			http-enabled = true;
			};
			database.passwordFile = "/etc/keycloak-database-pass";
			};
			</syntaxhighlight>

	== Troubleshooting ==		== Troubleshooting ==

Onny: Cleanup and restructuring page

2024-06-23T18:18:27Z

Cleanup and restructuring page

← Older revision		Revision as of 18:18, 23 June 2024
Line 1:		Line 1:
	'''[https://keycloak.org/ Keycloak]''' ([[wikipedia:en:Keycloak\|Wikipedia]]) is identity and access management software, and can serve as an authentication server for applications (providing support for OpenID Connect, OAuth 2.0, and SAML.)		'''[https://keycloak.org/ Keycloak]''' ([[wikipedia:en:Keycloak\|Wikipedia]]) is identity and access management software, and can serve as an authentication server for applications (providing support for OpenID Connect, OAuth 2.0, and SAML).

	~~'''~~Keycloak~~''' is...~~		For official documentation on Keycloak please consult the [https://nixos.org/manual/nixos/stable/index.html#module-services-keycloak NixOS manual].

	* covered in the [https://nixos.org/manual/nixos/stable/index.html#module-services-keycloak NixOS manual]
	* packaged [https://search.nixos.~~org/packages?type=packages&query=keycloak for Nix]~~
	* available as a [https://search.nixos.org/options?query=keycloak NixOS service]
	* written in [[Java]]
	* maintained by Red Hat

			== Setup ==
	== Troubleshooting ==		== Troubleshooting ==

Line 46:		Line 41:
	</nowiki>}}		</nowiki>}}

			== Tips and tricks ==

	== Installation in subdirectory ==		=== Installation in subdirectory ===

	Keycloak may be installed in a subdirectory of a domain. Thus you don't need to configure and expose a subdomain. For example with the following configuration, remember to edit <code>domain.tld</code>, reflecting your used domain.		Keycloak may be installed in a subdirectory of a domain. Thus you don't need to configure and expose a subdomain. For example with the following configuration, remember to edit <code>domain.tld</code>, reflecting your used domain.

Line 101:		Line 96:
	</nowiki>}}		</nowiki>}}

	== Keycloak themes on NixOS ==		=== Keycloak themes on NixOS ===

	You need to create a package for your custom theme and configure the keycloak service to use it		You need to create a package for your custom theme and configure the keycloak service to use it

Line 118:		Line 112:
	- keycloak_custom_theme.nix <- package for your theme		- keycloak_custom_theme.nix <- package for your theme

	=== Create a theme ===		==== Create a theme ====


	{{file\|custom.css\|css\|<nowiki>		{{file\|custom.css\|css\|<nowiki>
Line 134:		Line 127:
	</nowiki>}}		</nowiki>}}

	=== Create a package ===		==== Create a package ====

	{{file\|keycloak_custom_theme.nix\|nix\|<nowiki>		{{file\|keycloak_custom_theme.nix\|nix\|<nowiki>
	{ stdenv }:		{ stdenv }:
Line 154:		Line 146:
	</nowiki>}}		</nowiki>}}

	=== Create a packages set ===		==== Create a packages set ====


	{{file\|default.nix\|nix\|<nowiki>		{{file\|default.nix\|nix\|<nowiki>
Line 169:		Line 160:
	</nowiki>}}		</nowiki>}}

			==== Configure your keycloak service ====
	=== Configure your keycloak service ===

	{{file\|configuration.nix\|nix\|<nowiki>		{{file\|configuration.nix\|nix\|<nowiki>
	{ config, pkgs, lib, ... }:		{ config, pkgs, lib, ... }: