Installation Guide - Revision history

Craig: /* Offline or restricted-network install */

2026-08-02T02:26:32Z

Offline or restricted-network install

← Older revision		Revision as of 02:26, 2 August 2026
Line 260:		Line 260:
	# Run the installer with offline mode and the cache directory:		# Run the installer with offline mode and the cache directory:

	java -Dobsidian.install.deps.offline=true -Dobsidian.install.deps.cache.dir=/path/to/cache -jar Obsidian-Install-7.0.0.jar		java -Dobsidian.install.deps.offline=true -Dobsidian.install.deps.cache.dir=/path/to/cache -jar Obsidian-Install-7.x.x.jar

	If a required library is missing from the cache, the install stops with an error naming the coordinate — add that artifact to the cache and re-run.		If a required library is missing from the cache, the install stops with an error naming the coordinate — add that artifact to the cache and re-run.
Line 268:		Line 268:
	When your site mirrors Maven Central, point the installer at your repository base URL:		When your site mirrors Maven Central, point the installer at your repository base URL:

	java -Dobsidian.install.deps.repo.url=https://nexus.example.com/repository/maven-public/ -jar Obsidian-Install-7.0.0.jar		java -Dobsidian.install.deps.repo.url=https://nexus.example.com/repository/maven-public/ -jar Obsidian-Install-7.x.x.jar

	The installer reuses resolved artifacts for the duration of one install session.		The installer reuses resolved artifacts for the duration of one install session.

Craig: /* Offline or restricted-network install */

2026-08-02T02:26:07Z

Offline or restricted-network install

← Older revision		Revision as of 02:26, 2 August 2026
Line 252:		Line 252:
	==== Offline or restricted-network install ====		==== Offline or restricted-network install ====

	Obsidian 7.0.0 resolves third-party libraries when you run the installer. For environments without direct access to Maven Central:		Obsidian 7.x.x resolves third-party libraries when you run the installer. For environments without direct access to Maven Central:

	# Pre-stage a local dependency cache containing every coordinate listed in the Obsidian dependency inventory for your release (contact Carfey support or your account team for the checklist file matching '''Obsidian-Install-7.0.0.jar''').		# Pre-stage a local dependency cache containing every coordinate listed in the Obsidian dependency inventory for your release (contact Carfey support or your account team for the checklist file matching '''Obsidian-Install-7.x.x.jar''').
	# Copy the cache to the install host. Two layouts are supported:		# Copy the cache to the install host. Two layouts are supported:
	#* '''Flat:''' one file per installed JAR name directly under the cache root.		#* '''Flat:''' one file per installed JAR name directly under the cache root.
Line 271:		Line 271:

	The installer reuses resolved artifacts for the duration of one install session.		The installer reuses resolved artifacts for the duration of one install session.


	== Completing the Installation ==		== Completing the Installation ==

Craig: /* Provider-Specific Settings */

2026-08-02T02:25:43Z

Provider-Specific Settings

← Older revision		Revision as of 02:25, 2 August 2026
Line 110:		Line 110:
	* '''Scopes''' — ''openid profile email''.		* '''Scopes''' — ''openid profile email''.
	Note: the ''groups'' claim contains GUIDs by default; configure Optional Claims in the Azure portal to receive group display names.		Note: the ''groups'' claim contains GUIDs by default; configure Optional Claims in the Azure portal to receive group display names.
	'''Multi-tenant applications are not supported in Obsidian 7.0.0.'''		'''Multi-tenant applications are not supported in Obsidian 7.0.x.'''

	[[Image:Obsidian-7.0.0-Configuring-Okta.png]]		[[Image:Obsidian-7.0.0-Configuring-Okta.png]]
Line 133:		Line 133:
	* '''Client ID''' and '''Client Secret''' from the provider.		* '''Client ID''' and '''Client Secret''' from the provider.
	* '''Scopes''' — at minimum ''openid''; add ''profile'' and your groups scope as needed.		* '''Scopes''' — at minimum ''openid''; add ''profile'' and your groups scope as needed.


	===== Group → Role Mapping =====		===== Group → Role Mapping =====

Craig: /* Deployment options */

2026-08-02T02:25:20Z

Deployment options

← Older revision		Revision as of 02:25, 2 August 2026
Line 32:		Line 32:
	==== Deployment options ====		==== Deployment options ====

	Obsidian 7~~.0.0~~ offers four deployment profiles in the installer:		Obsidian 7 offers four deployment profiles in the installer:

	* '''Obsidian WAR''' — deploy '''obsidian.war''' to your own servlet container (Tomcat, WebLogic, etc.).		* '''Obsidian WAR''' — deploy '''obsidian.war''' to your own servlet container (Tomcat, WebLogic, etc.).

Craig at 15:37, 31 July 2026

2026-07-31T15:37:28Z

@@ Line 78: / Line 78: @@
 If you selected '''OAuth (OIDC)''' as the authentication type, the installer displays additional panels for OAuth configuration.
@@ Line 143: / Line 144: @@
 Before starting Obsidian, register the redirect URI shown in the installer at your IdP: Keycloak — Client → Settings → Valid Redirect URIs; Entra ID — App Registration → Authentication → Redirect URIs; Okta — Application → General Settings → Sign-in Redirect URIs; Auth0 — Application → Settings → Allowed Callback URLs. The URI must match ''com.carfey.suite.security.OAuthAuthenticator.redirectUri'' exactly, including scheme and port.
 ==== LDAP Configuration ====

Craig at 15:34, 31 July 2026

2026-07-31T15:34:09Z

← Older revision		Revision as of 15:34, 31 July 2026
Line 65:		Line 65:

	== Obsidian Configuration ==		== Obsidian Configuration ==

	First, you must choose what [[Authenticator]] mechanism will be used within Obsidian. Select ''Native (Database)'', ''LDAP'', ''OAuth (OIDC)'', ''SAML 2.0'', or ''Other'' (custom). ''Native (Database)'' requires no additional configuration and is what most users will select at least to start.

	[[Image:Obsidian-7.0.0-Configuring-Obsidian.png]]		[[Image:Obsidian-7.0.0-Configuring-Obsidian.png]]

			First, you must choose what [[Authenticator]] mechanism will be used within Obsidian. Obsidian supports five authentication methods: native (database), LDAP, OAuth (OIDC), SAML 2.0, and custom. Select ''Native (Database)'', ''LDAP'', ''OAuth (OIDC)'', ''SAML 2.0'', or ''Other'' (custom). ''Native (Database)'' requires no additional configuration and is what most users will select at least to start.
	First, you must choose what [[Authenticator]] mechanism will be used within Obsidian. ''Native (Database)'' ~~authentication requires no additional configuration and is what most users will select. Select~~ ''~~Other~~'' ~~if you have implemented your own authentication mechanism~~, OAuth (OIDC), SAML or ~~LDAP according~~ to ~~your desired mechanism~~.

	Next, you'll want to select the email usage type. We highly recommend you configure Obsidian for email use as it will allow you to benefit from the event [[Event_Notifications\|notification]] and [[Admin_Notifications\|subscription]] support in Obsidian.		Next, you'll want to select the email usage type. We highly recommend you configure Obsidian for email use as it will allow you to benefit from the event [[Event_Notifications\|notification]] and [[Admin_Notifications\|subscription]] support in Obsidian.

Craig at 15:30, 31 July 2026

2026-07-31T15:30:53Z

← Older revision		Revision as of 15:30, 31 July 2026
Line 66:		Line 66:
	== Obsidian Configuration ==		== Obsidian Configuration ==

	~~The installer~~ will ~~guide you through the~~ configuration ~~Obsidian~~.		First, you must choose what [[Authenticator]] mechanism will be used within Obsidian. Select ''Native (Database)'', ''LDAP'', ''OAuth (OIDC)'', ''SAML 2.0'', or ''Other'' (custom). ''Native (Database)'' requires no additional configuration and is what most users will select at least to start.


	[[Image:Obsidian-7.0.0-Configuring-Obsidian.png]]		[[Image:Obsidian-7.0.0-Configuring-Obsidian.png]]

Craig: Remove pre-4.x version references (4.0.0 is the oldest documented release)

2026-07-31T14:49:54Z

Remove pre-4.x version references (4.0.0 is the oldest documented release)

← Older revision		Revision as of 14:49, 31 July 2026
Line 1:		Line 1:
	'''This installation guide generally applies to Obsidian versions 4.0 and newer but is specific to 7.0. You may see a few minor differences in 4.x, 5.x and 6.x releases~~. See the [[Installation_Guide_(3.x.x_and_earlier)\|Installation Guide]] for all prior versions~~.		'''This installation guide generally applies to Obsidian versions 4.0 and newer but is specific to 7.0. You may see a few minor differences in 4.x, 5.x and 6.x releases.

	This installation guide is a companion to the Obsidian Installer UI. Its purpose is to provide additional detail as to the meaning of various inputs and to provide guidance on advanced usage of the installer.		This installation guide is a companion to the Obsidian Installer UI. Its purpose is to provide additional detail as to the meaning of various inputs and to provide guidance on advanced usage of the installer.

Craig at 21:05, 30 July 2026

2026-07-30T21:05:03Z

← Older revision		Revision as of 21:05, 30 July 2026
Line 11:		Line 11:
	On some platforms, simple double-clicking the JAR file will start it in graphical interface mode.		On some platforms, simple double-clicking the JAR file will start it in graphical interface mode.

	If you are doing a version upgrade of Obsidian or are otherwise uninterested in actually configuring the artifacts, you can run the quick start mode to get the default configured artifacts using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar h2-~~winstone~~-quick-start.xml</code>.		If you are doing a version upgrade of Obsidian or are otherwise uninterested in actually configuring the artifacts, you can run the quick start mode to get the default configured artifacts using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar h2-tomcat-quick-start.xml</code>.

	== Obsidian Installer Artifacts ==		== Obsidian Installer Artifacts ==

Craig at 20:46, 30 July 2026

2026-07-30T20:46:03Z

@@ Line 39: / Line 39: @@
 * '''Obsidian Standalone Admin Embedded Tomcat JAR''' — embedded runtime for the admin WAR ('''start adminOnly'''). '''Requires''' the Standalone Admin WAR pack.
-Embedded Tomcat does '''not''' replace the WAR on disk — it runs the installed WAR via the helper. Do not select an embed pack without its matching WAR pack.
+Embedded Tomcat does '''not''' replace the WAR on disk — it runs the installed WAR via the helper. Do not select an embed pack without its matching WAR pack. For how to start, stop and change the ports of the embedded runtime, see [[Getting_Started#Starting_Obsidian_with_embedded_Tomcat|Starting Obsidian with embedded Tomcat]].
 == Obsidian Configuration ==