Outline - Revision history

Bmillwood: /* SSL example */ enablePasswordDB is in services.dex

2025-12-29T19:31:22Z

SSL example: enablePasswordDB is in services.dex

← Older revision		Revision as of 19:31, 29 December 2025
Line 125:		Line 125:
	forceHttps = false;		forceHttps = false;
	storage.storageType = "local";		storage.storageType = "local";
	~~enablePasswordDB = true;~~
	oidcAuthentication = {		oidcAuthentication = {
	authUrl = "https://dex.example.tld/auth";		authUrl = "https://dex.example.tld/auth";
Line 152:		Line 151:
	}		}
	];		];
			enablePasswordDB = true;
	staticPasswords = [		staticPasswords = [
	{		{

Bmillwood: /* SSL example */ staticPasswords requires enablePasswordDB

2025-12-29T19:30:37Z

SSL example: staticPasswords requires enablePasswordDB

← Older revision		Revision as of 19:30, 29 December 2025
Line 88:		Line 88:
	Similar as before but this time with Nginx handling SSL.		Similar as before but this time with Nginx handling SSL.

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

Line 125:		Line 125:
	forceHttps = false;		forceHttps = false;
	storage.storageType = "local";		storage.storageType = "local";
			enablePasswordDB = true;
	oidcAuthentication = {		oidcAuthentication = {
	authUrl = "https://dex.example.tld/auth";		authUrl = "https://dex.example.tld/auth";
Line 165:		Line 166:


	</nowiki>}}		</nowiki>\|name=/etc/nixos/configuration.nix\|lang=nix}}

	== Troubleshooting ==		== Troubleshooting ==

Klinger at 19:16, 24 April 2024

2024-04-24T19:16:52Z

← Older revision		Revision as of 19:16, 24 April 2024
Line 178:		Line 178:
	* [[Dokuwiki]], simple PHP- and web-based wiki software which uses file based storage for its content.		* [[Dokuwiki]], simple PHP- and web-based wiki software which uses file based storage for its content.

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

imported>Onny at 13:14, 30 January 2024

2024-01-30T13:14:27Z

← Older revision		Revision as of 13:14, 30 January 2024
Line 5:		Line 5:
	The most minimal local installation of Outline can be enabled with the following configuration		The most minimal local installation of Outline can be enabled with the following configuration

	{{note\|Previous example used the <code>mockPassword</code> connector, which is [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/server.go#L566 an undocumented configuration option] in Dex, used solely to [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/handlers_test.go#L250 run some tests]. Use [https://dexidp.io/docs/connectors/local/ staticPasswords] configuration instead, which allows using a hash for the password and setting a real email for the user which can be used to send notifications if an SMTP server is configured. Keep in mind, if you created your first user with the previous method (mockPassword), that user is your only <code>admin</code> user and you need to keep it around in order to confer <code>admin</code> privileges to the next user.~~</nowiki>~~}}		{{note\|Previous example used the <code>mockPassword</code> connector, which is [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/server.go#L566 an undocumented configuration option] in Dex, used solely to [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/handlers_test.go#L250 run some tests]. Use [https://dexidp.io/docs/connectors/local/ staticPasswords] configuration instead, which allows using a hash for the password and setting a real email for the user which can be used to send notifications if an SMTP server is configured. Keep in mind, if you created your first user with the previous method (mockPassword), that user is your only <code>admin</code> user and you need to keep it around in order to confer <code>admin</code> privileges to the next user.}}

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

imported>Onny: Restructuring

2024-01-30T13:10:44Z

Restructuring

← Older revision		Revision as of 13:10, 30 January 2024
Line 4:		Line 4:

	The most minimal local installation of Outline can be enabled with the following configuration		The most minimal local installation of Outline can be enabled with the following configuration

			{{note\|Previous example used the <code>mockPassword</code> connector, which is [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/server.go#L566 an undocumented configuration option] in Dex, used solely to [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/handlers_test.go#L250 run some tests]. Use [https://dexidp.io/docs/connectors/local/ staticPasswords] configuration instead, which allows using a hash for the password and setting a real email for the user which can be used to send notifications if an SMTP server is configured. Keep in mind, if you created your first user with the previous method (mockPassword), that user is your only <code>admin</code> user and you need to keep it around in order to confer <code>admin</code> privileges to the next user.</nowiki>}}

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 39:		Line 41:
	storage.type = "sqlite3";		storage.type = "sqlite3";
	web.http = "127.0.0.1:5556";		web.http = "127.0.0.1:5556";
			enablePasswordDB = true;
	staticClients = [		staticClients = [
	{		{
Line 47:		Line 50:
	}		}
	];		];
	~~connectors~~ = [		staticPasswords = [
	{		{
	~~type~~ = "~~mockPassword~~";		email = "user.email@example.com";
	~~id =~~ "~~mock~~";		# bcrypt hash of the string "password": $(echo password \| htpasswd -BinC 10 admin \| cut -d: -f2)
	~~name~~ = "~~Example~~";		hash = "10$TDh68T5XUK10$TDh68T5XUK10$TDh68T5XUK";
	~~config = {~~		username = "test";
	username = "~~admin~~";		# easily generated with `$ uuidgen`
	~~password~~ = "~~password~~";		userID = "6D196B03-8A28-4D6E-B849-9298168CBA34";
	};
	}		}
	];		];
	};		};
	};		};
Line 80:		Line 82:
	</nowiki>}}		</nowiki>}}

	Outline is available at http://localhost . Choose login provider "Dex" and authenticate with the example mock login <code>~~admin~~</code> and <code>password</code>.		Outline is available at http://localhost . Choose login provider "Dex" and authenticate with the example mock login <code>user.email@example.com</code> and <code>password</code>.

	== ~~Setup with Nginx~~ ==		=== SSL example ===

	Similar as before but this time with Nginx handling SSL. We are also going to use a better way of adding static passwords in our configuration. Previous example used the <code>mockPassword</code> connector, which is [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/server.go#L566 an undocumented configuration option] in Dex, used solely to [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/handlers_test.go#L250 run some tests]. In the following example the [https://dexidp.io/docs/connectors/local/ staticPasswords] configuration is used instead, this allows using a hash for the password instead of clear text. This also allows setting a real email to the users which can be used to send notifications if an SMTP server is configured (e.g. <code>AWS SES, Postmark, Sendgrid</code>) through [https://search.nixos.org/options?channel=23.11&from=0&size=50&sort=relevance&type=packages&query=services.outline.smtp services.outline.smtp].		Similar as before but this time with Nginx handling SSL.

	Keep in mind, if you created your first user with the previous method (mockPassword), that user is your only <code>admin</code> user and you need to keep it around in order to confer <code>admin</code> privileges to the next user.

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 167:		Line 167:
	</nowiki>}}		</nowiki>}}

	== ~~Reminder~~ ==		== Troubleshooting ==

			=== Option storageType does not exist ===

	If you see an error that says something like <code>option "services.outline.storage.storageType" does not exist"</code> you may need to update your channels (<code>nix-channel --update</code>)		If you see an error that says something like <code>option "services.outline.storage.storageType" does not exist"</code> you may need to update your channels (<code>nix-channel --update</code>)

imported>Sleepful: using staticpasswords instead

2024-01-30T09:49:59Z

using staticpasswords instead

← Older revision		Revision as of 09:49, 30 January 2024
Line 84:		Line 84:
	== Setup with Nginx ==		== Setup with Nginx ==

	Similar as before but this time with Nginx handling SSL		Similar as before but this time with Nginx handling SSL. We are also going to use a better way of adding static passwords in our configuration. Previous example used the <code>mockPassword</code> connector, which is [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/server.go#L566 an undocumented configuration option] in Dex, used solely to [https://github.com/dexidp/dex/blob/8e07edc188222fed79a6db7c8e3e57e6d8e82df7/server/handlers_test.go#L250 run some tests]. In the following example the [https://dexidp.io/docs/connectors/local/ staticPasswords] configuration is used instead, this allows using a hash for the password instead of clear text. This also allows setting a real email to the users which can be used to send notifications if an SMTP server is configured (e.g. <code>AWS SES, Postmark, Sendgrid</code>) through [https://search.nixos.org/options?channel=23.11&from=0&size=50&sort=relevance&type=packages&query=services.outline.smtp services.outline.smtp].

			Keep in mind, if you created your first user with the previous method (mockPassword), that user is your only <code>admin</code> user and you need to keep it around in order to confer <code>admin</code> privileges to the next user.

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 120:		Line 122:
	enable = true;		enable = true;
	publicUrl = "https://outline.example.tld";		publicUrl = "https://outline.example.tld";
	port = 3003; # using 3003 instead of default 3000		port = 3003; # using 3003 instead of default 3000 just in case another service is already using 3000
	forceHttps = false;		forceHttps = false;
	storage.storageType = "local";		storage.storageType = "local";
Line 149:		Line 151:
	}		}
	];		];
	~~connectors~~ = [		staticPasswords = [
	{		{
	~~type~~ = "~~mockPassword~~";		email = "user.email@example.com";
	~~id =~~ "~~mock~~";		# bcrypt hash of the string "password": $(echo password \| htpasswd -BinC 10 admin \| cut -d: -f2)
	~~name~~ = "~~Test~~";		hash = "10$TDh68T5XUK10$TDh68T5XUK10$TDh68T5XUK";
	~~config = {~~		username = "test";
	~~# this is the dex user/pass combo to log into outline~~		# easily generated with `$ uuidgen`
	username = "~~testuser~~";		userID = "6D196B03-8A28-4D6E-B849-9298168CBA34";
	~~password~~ = "~~pass123~~";
	};
	}		}
	];		];
	};		};
	};		};
Line 169:		Line 169:
	== Reminder ==		== Reminder ==

	If you see an error that says something like `option "services.outline.storage.storageType" does not exist"` you may need to update your channels (`nix-channel --update`)		If you see an error that says something like <code>option "services.outline.storage.storageType" does not exist"</code> you may need to update your channels (<code>nix-channel --update</code>)

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

imported>Sleepful at 07:04, 29 January 2024

2024-01-29T07:04:17Z

← Older revision		Revision as of 07:04, 29 January 2024
Line 166:		Line 166:

	</nowiki>}}		</nowiki>}}

			== Reminder ==

			If you see an error that says something like `option "services.outline.storage.storageType" does not exist"` you may need to update your channels (`nix-channel --update`)

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

imported>Sleepful: adds nginx example

2024-01-29T06:56:37Z

adds nginx example

← Older revision		Revision as of 06:56, 29 January 2024
Line 81:		Line 81:

	Outline is available at http://localhost . Choose login provider "Dex" and authenticate with the example mock login <code>admin</code> and <code>password</code>.		Outline is available at http://localhost . Choose login provider "Dex" and authenticate with the example mock login <code>admin</code> and <code>password</code>.

			== Setup with Nginx ==

			Similar as before but this time with Nginx handling SSL

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

			services.nginx = {
			enable = true;
			recommendedProxySettings = true;
			recommendedTlsSettings = true;
			virtualHosts = {
			"outline.example.tld" = {
			onlySSL = true;
			useACMEHost = "example.tld"; # assuming security.acme.certs."example.tld" with `extraDomainNames = [ "outline.example.tld" ]`
			locations."/" = {
			proxyPass = "http://localhost:${toString config.services.outline.port}";
			proxyWebsockets = true;
			extraConfig = ''
			proxy_set_header X-Scheme $scheme;
			'';
			};
			};
			"dex.example.tld" = {
			onlySSL = true;
			useACMEHost = "example.tld";
			locations."/" = {
			proxyPass = "http://${config.services.dex.settings.web.http}";
			proxyWebsockets = true;
			};
			};
			};
			};


			services.outline = {
			enable = true;
			publicUrl = "https://outline.example.tld";
			port = 3003; # using 3003 instead of default 3000
			forceHttps = false;
			storage.storageType = "local";
			oidcAuthentication = {
			authUrl = "https://dex.example.tld/auth";
			tokenUrl = "https://dex.example.tld/token";
			userinfoUrl = "https://dex.example.tld/userinfo";
			clientId = "outline";
			clientSecretFile = (builtins.elemAt config.services.dex.settings.staticClients 0).secretFile;
			scopes = [ "openid" "email" "profile" ];
			usernameClaim = "preferred_username";
			displayName = "Dex";
			};
			};

			services.dex = {
			enable = true;
			settings = {
			issuer = "https://dex.example.tld";
			storage.type = "sqlite3";
			web.http = "127.0.0.1:5556";
			staticClients = [
			{
			id = "outline";
			name = "Outline Client";
			redirectURIs = [ "https://outline.example.tld/auth/oidc.callback" ];
			secretFile = "${pkgs.writeText "outline-oidc-secret" "test123"}";
			}
			];
			connectors = [
			{
			type = "mockPassword";
			id = "mock";
			name = "Test";
			config = {
			# this is the dex user/pass combo to log into outline
			username = "testuser";
			password = "pass123";
			};
			}
			];
			};
			};


			</nowiki>}}

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

imported>Onny: Remove unstable notice

2023-12-11T10:22:27Z

Remove unstable notice

← Older revision		Revision as of 10:22, 11 December 2023
Line 4:		Line 4:

	The most minimal local installation of Outline can be enabled with the following configuration		The most minimal local installation of Outline can be enabled with the following configuration

	~~{{Note\|The storage configuration is not yet stable and will be available with the upcoming NixOS 23.11 release.}}~~

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

imported>Onny: Simplified Dex setup

2023-11-19T12:41:01Z

Simplified Dex setup

← Older revision		Revision as of 12:41, 19 November 2023
Line 39:		Line 39:
	settings = {		settings = {
	issuer = "http://dex.localhost";		issuer = "http://dex.localhost";
	storage ~~= {~~		storage.type = "sqlite3";
	type = "sqlite3";
	~~config.file = "/var/lib/dex/db.sqlite3";~~
	};
	web.http = "127.0.0.1:5556";		web.http = "127.0.0.1:5556";
	staticClients = [		staticClients = [
Line 82:		Line 79:
	};		};

	};

	~~systemd.services.dex = {~~
	~~serviceConfig.StateDirectory = "dex";~~
	};		};
	</nowiki>}}		</nowiki>}}