Installation Guide - Revision history

Craig at 19:03, 12 December 2024

2024-12-12T19:03:03Z

← Older revision		Revision as of 19:03, 12 December 2024
Line 1:		Line 1:
	'''This installation guide applies to Obsidian versions 4.0 and newer. See the [[Installation_Guide_(3.x.x_and_earlier)\|Installation Guide]] for prior versions.		'''This installation guide generally applies to Obsidian versions 4.0 and newer but is specific to 6.0. You may see a few minor differences in 4.x and 5.x releases. See the [[Installation_Guide_(3.x.x_and_earlier)\|Installation Guide]] for all prior versions.

	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: /* Selecting Script Libraries */

2024-12-12T19:01:11Z

Selecting Script Libraries

← Older revision		Revision as of 19:01, 12 December 2024
Line 98:		Line 98:
	==== Selecting Script Libraries ====		==== Selecting Script Libraries ====

	[[Image:Obsidian-5.0.0~~.Installer.ScriptingJar.Configuration~~.png]]		[[Image:Obsidian-6.0.0-Choose-Scripting-Libraries.png]]

	The Obsidian installer allows you to select which script libraries you wish to include. Jython and JRuby are incompatible with each other, so the installer will only allow one of the two selected. If all script libraries are deselected, the only script jobs that can be run in Obsidian will be Javascript jobs as that engine is built into Java.		The Obsidian installer allows you to select which script libraries you wish to include. Jython and JRuby are incompatible with each other, so the installer will only allow one of the two selected. If all script libraries are deselected, the only script jobs that can be run in Obsidian will be Javascript jobs as that engine is built into Java.

Craig: /* Configuring 3rd Party Library Conflict Management */

2024-12-12T19:00:10Z

Configuring 3rd Party Library Conflict Management

← Older revision		Revision as of 19:00, 12 December 2024
Line 92:		Line 92:

	==== Configuring 3rd Party Library Conflict Management ====		==== Configuring 3rd Party Library Conflict Management ====
	[[Image:Obsidian-5.0.0~~.Installer.JarJar.Configuration~~.png]]		[[Image:JarJar-Obsidian-6.0.0.png]]

	The Obsidian installer allows you to use [https://code.google.com/archive/p/jarjar JarJar] to handle potential conflicts between Obsidian's use of 3rd party libraries and versions used within your application. On this screen, simply select which libraries to which you wish to apply the JarJar bytecode modification process. This is optional and is skipped if no libraries are selected. Any jars not listed for which you are using more recent versions can be used and are therefore not included as options in the JarJar processing.		The Obsidian installer allows you to use [https://code.google.com/archive/p/jarjar JarJar] to handle potential conflicts between Obsidian's use of 3rd party libraries and versions used within your application. On this screen, simply select which libraries to which you wish to apply the JarJar bytecode modification process. This is optional and is skipped if no libraries are selected. Any jars not listed for which you are using more recent versions can be used and are therefore not included as options in the JarJar processing.

Craig at 18:58, 12 December 2024

2024-12-12T18:58:12Z

← Older revision		Revision as of 18:58, 12 December 2024
Line 34:		Line 34:


	[[Image:Obsidian-5.0.0~~.Installer.ConfigureStep1~~.png]]		[[Image:Configuring-Obsidian-6.0.0.png]]

Craig at 18:17, 16 October 2024

2024-10-16T18:17:04Z

← Older revision		Revision as of 18:17, 16 October 2024
Line 108:		Line 108:

	[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]		[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]

			==== Additional configuration items ====

			As of Obsidian 5.5.0, if you require any additional configuration items such as additional appenders/loggers or event hook configurations, you can add them here.

			[[Image:Obsidian-5.5.0.Extra.Configuration.png]]

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

Craig: /* Choosing Email Support */

2023-11-30T01:12:40Z

Choosing Email Support

← Older revision		Revision as of 01:12, 30 November 2023
Line 103:		Line 103:

	==== Choosing Email Support ====		==== Choosing Email Support ====
	As of Obsidian 5.2.0, you can choose between JavaMail (javax) and Jakarta mail (Jakarta EE) implementations. When choosing Jakarta, you can also choose to bundle the Angus Jakarta compatible implementation. If you are using JNDI, this will only include the relevant support in the Obsidian WAR artifacts and the actual libraries in use must be provided by you and bundled with your container. If the standalone scheduler is selected along with JNDI, JNDI is assumed only relevant for WARs. As such, default libraries for either JavaMail or Jakarta will be included in the standalone installation.		As of Obsidian 5.2.0, you can choose between JavaMail (javax) and Jakarta mail (Jakarta EE) implementations. When choosing Jakarta, you can also choose to bundle the Angus Jakarta compatible implementation.

			If you are using JNDI, this will only include the relevant support in the Obsidian WAR artifacts and the actual libraries in use must be provided by you and bundled with your container. If the standalone scheduler is selected along with JNDI, JNDI is assumed only relevant for WARs. As such, default libraries for either JavaMail or Jakarta will be included in the standalone installation.

	[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]		[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]

Craig: /* Choosing Email Support */

2023-11-30T01:12:25Z

Choosing Email Support

← Older revision		Revision as of 01:12, 30 November 2023
Line 103:		Line 103:

	==== Choosing Email Support ====		==== Choosing Email Support ====
	As of Obsidian 5.2.0, you can choose between javax and Jakarta mail implementations. When choosing Jakarta, you can also choose to bundle the Angus Jakarta compatible implementation.		As of Obsidian 5.2.0, you can choose between JavaMail (javax) and Jakarta mail (Jakarta EE) implementations. When choosing Jakarta, you can also choose to bundle the Angus Jakarta compatible implementation. If you are using JNDI, this will only include the relevant support in the Obsidian WAR artifacts and the actual libraries in use must be provided by you and bundled with your container. If the standalone scheduler is selected along with JNDI, JNDI is assumed only relevant for WARs. As such, default libraries for either JavaMail or Jakarta will be included in the standalone installation.

	[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]		[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]

Craig at 01:09, 30 November 2023

2023-11-30T01:09:53Z

← Older revision		Revision as of 01:09, 30 November 2023
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-~~jetty~~-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-winstone-quick-start.xml</code>.

	== Obsidian Installer Artifacts ==		== Obsidian Installer Artifacts ==
Line 101:		Line 101:

	The Obsidian installer allows you to select which script libraries you wish to include. Jython and JRuby are incompatible with each other, so the installer will only allow one of the two selected. If all script libraries are deselected, the only script jobs that can be run in Obsidian will be Javascript jobs as that engine is built into Java.		The Obsidian installer allows you to select which script libraries you wish to include. Jython and JRuby are incompatible with each other, so the installer will only allow one of the two selected. If all script libraries are deselected, the only script jobs that can be run in Obsidian will be Javascript jobs as that engine is built into Java.

			==== Choosing Email Support ====
			As of Obsidian 5.2.0, you can choose between javax and Jakarta mail implementations. When choosing Jakarta, you can also choose to bundle the Angus Jakarta compatible implementation.

			[[Image:Obsidian-5.0.0.Installer.EmailImplementation.Configuration.png]]

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

Craig: /* Running the Obsidian Installer */

2023-11-30T01:06:04Z

Running the Obsidian Installer

← Older revision		Revision as of 01:06, 30 November 2023
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-jetty-quick-start.xml</code>.

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

Craig at 20:57, 17 May 2023

2023-05-17T20:57:38Z

← Older revision		Revision as of 20:57, 17 May 2023
Line 5:		Line 5:
	The installer itself installs and configures the artifacts. The configured artifacts will have their [[Advanced_Configuration#Properties_File\|Properties]] file configured according to the choices made during the installation process. You may always change these later or use one of the [[Advanced_Configuration#Properties_File\|override]] mechanisms.		The installer itself installs and configures the artifacts. The configured artifacts will have their [[Advanced_Configuration#Properties_File\|Properties]] file configured according to the choices made during the installation process. You may always change these later or use one of the [[Advanced_Configuration#Properties_File\|override]] mechanisms.
	== Running the Obsidian Installer ==		== Running the Obsidian Installer ==
	The installer is an executable JAR file in the Obsidian download zip package available on our [https://web.obsidianscheduler.com/download download page].		The installer is an executable JAR file in the Obsidian download zip package available on our [https://web.obsidianscheduler.com/download/ download page].

	The installer can be run from the command line as a graphical user interface using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar</code> or in interactive console mode using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar -console</code>. Note that you will have to replace the JAR file name with the actual versioned name in your installation.		The installer can be run from the command line as a graphical user interface using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar</code> or in interactive console mode using <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar -console</code>. Note that you will have to replace the JAR file name with the actual versioned name in your installation.
Line 94:		Line 94:
	[[Image:Obsidian-5.0.0.Installer.JarJar.Configuration.png]]		[[Image:Obsidian-5.0.0.Installer.JarJar.Configuration.png]]

	The Obsidian installer allows you to use [https://code.google.com/p/jarjar/ JarJar] to handle potential conflicts between Obsidian's use of 3rd party libraries and versions used within your application. On this screen, simply select which libraries to which you wish to apply the JarJar bytecode modification process. This is optional and is skipped if no libraries are selected. Any jars not listed for which you are using more recent versions can be used and are therefore not included as options in the JarJar processing.		The Obsidian installer allows you to use [https://code.google.com/archive/p/jarjar JarJar] to handle potential conflicts between Obsidian's use of 3rd party libraries and versions used within your application. On this screen, simply select which libraries to which you wish to apply the JarJar bytecode modification process. This is optional and is skipped if no libraries are selected. Any jars not listed for which you are using more recent versions can be used and are therefore not included as options in the JarJar processing.

	==== Selecting Script Libraries ====		==== Selecting Script Libraries ====