Getting Started - Revision history

Craig: /* Updating the Properties File in Admin Web Applications */

2024-12-28T02:07:50Z

Updating the Properties File in Admin Web Applications

← Older revision		Revision as of 02:07, 28 December 2024
Line 247:		Line 247:
	# Obtain the WAR artifact from your installation that requires changes. This is either <code>obsidian.war</code> or <code>standaloneObsidianAdmin.war</code>.		# Obtain the WAR artifact from your installation that requires changes. This is either <code>obsidian.war</code> or <code>standaloneObsidianAdmin.war</code>.
	# Extract the WAR file to a clean directory.		# Extract the WAR file to a clean directory.
	# Edit the <code>com.carfey.properties</code> file within the subdirectory <code>WEB-INF/classes</code> and save your changes.		# Edit the <code>com.carfey.(yaml/properties)</code> file within the subdirectory <code>WEB-INF/classes</code> and save your changes.
	# Rebundled the WAR artifact using a zip utility or the JDK <code>jar</code> utility.		# Rebundled the WAR artifact using a zip utility or the JDK <code>jar</code> utility.
	#* Some zip utilities such as 7Zip will allow you to edit files within an archive directly without the previous steps. It is generally safe to do so.		#* Some zip utilities such as 7Zip will allow you to edit files within an archive directly without the previous steps. It is generally safe to do so.

Craig: /* Embedding Obsidian - Importing Libraries and Properties File */

2024-12-28T02:07:31Z

Embedding Obsidian - Importing Libraries and Properties File

← Older revision		Revision as of 02:07, 28 December 2024
Line 211:		Line 211:
	#* These can be obtained from the <code>standalone</code> directory of your installation. Make sure you '''exclude''' <code>obsidian-(yaml/properties)-configuration.jar</code>		#* These can be obtained from the <code>standalone</code> directory of your installation. Make sure you '''exclude''' <code>obsidian-(yaml/properties)-configuration.jar</code>
	#* Ensure your Maven, Gradle or Ant files are updated to include all required libraries in your build, along with your IDE.		#* Ensure your Maven, Gradle or Ant files are updated to include all required libraries in your build, along with your IDE.
	# Make a copy of <code>com.carfey.yaml.reference</code> or <code>com.carfey.properties.reference</code> from your installation with the <code>.~~copy~~</code> suffix removed, and add it to your project's classpath.		# Make a copy of <code>com.carfey.yaml.reference</code> or <code>com.carfey.properties.reference</code> from your installation with the <code>.reference</code> suffix removed, and add it to your project's classpath.
	#* This is typically just a matter of adding it to your project's resources directory.		#* This is typically just a matter of adding it to your project's resources directory.
	#* From now on, you can update this file to change the various configuration options such as database connection details.		#* From now on, you can update this file to change the various configuration options such as database connection details.

Craig: /* Embedding Obsidian - Importing Libraries and Properties File */

2024-12-28T02:07:13Z

Embedding Obsidian - Importing Libraries and Properties File

← Older revision		Revision as of 02:07, 28 December 2024
Line 209:		Line 209:

	# Import all required [[Advanced_Configuration#Dependent_Libraries\|Obsidian JAR files]] into your project and reference them in your build files.		# Import all required [[Advanced_Configuration#Dependent_Libraries\|Obsidian JAR files]] into your project and reference them in your build files.
	#* These can be obtained from the <code>standalone</code> directory of your installation. Make sure you '''exclude''' <code>obsidian-~~props~~.jar</code>		#* These can be obtained from the <code>standalone</code> directory of your installation. Make sure you '''exclude''' <code>obsidian-(yaml/properties)-configuration.jar</code>
	#* Ensure your Maven, Gradle or Ant files are updated to include all required libraries in your build, along with your IDE.		#* Ensure your Maven, Gradle or Ant files are updated to include all required libraries in your build, along with your IDE.
	# Make a copy of <code>com.carfey.properties.~~copy~~</code> from your installation with the <code>.copy</code> suffix removed, and add it to your project's classpath.		# Make a copy of <code>com.carfey.yaml.reference</code> or <code>com.carfey.properties.reference</code> from your installation with the <code>.copy</code> suffix removed, and add it to your project's classpath.
	#* This is typically just a matter of adding it to your project's resources directory.		#* This is typically just a matter of adding it to your project's resources directory.
	#* From now on, you can update this file to change the various configuration options such as database connection details.		#* From now on, you can update this file to change the various configuration options such as database connection details.

Craig: /* Installer-Created Artifacts */

2024-12-28T02:05:11Z

Installer-Created Artifacts

← Older revision		Revision as of 02:05, 28 December 2024
Line 165:		Line 165:
	<pre>		<pre>
	├───db_scripts		├───db_scripts
	└───Obsidian-5.n.n		└───Obsidian-6.n.n
	│ com.carfey.~~properties~~.~~copy~~		│ com.carfey.yaml.reference
	│ obsidian.war		│ obsidian.war
	│ obsidian-builtin-job-src.jar		│ obsidian-builtin-job-src.jar
Line 183:		Line 183:
	└───standalone		└───standalone
	(various JAR files...)		(various JAR files...)
	obsidian-~~props~~.jar		obsidian-yaml-configuration.jar
	obsidian.jar		obsidian.jar
	</pre>		</pre>
	The installer creates a top-level directory named <code>Obsidian-''n''.''n''.''n''</code> containing generated artifacts. The key files and directories are:		The installer creates a top-level directory named <code>Obsidian-''n''.''n''.''n''</code> containing generated artifacts. The key files and directories are:

	* '''com.carfey.properties.~~copy~~''' - Copy of ~~properties~~ file generated by the installer.		* '''com.carfey.yaml.reference''' or '''com.carfey.properties.reference''' - Copy of configuration file generated by the installer.
	* '''obsidian.war''' - Combined scheduler and admin web application WAR. This can be deployed directly to a servlet container. This artifact can be customized by adding your job code and dependencies as JARS to the <code>/WEB-INF/lib</code> directory within the archive.		* '''obsidian.war''' - Combined scheduler and admin web application WAR. This can be deployed directly to a servlet container. This artifact can be customized by adding your job code and dependencies as JARS to the <code>/WEB-INF/lib</code> directory within the archive.
	* '''standaloneObsidian.bat''' and '''standaloneObsidian.sh''' - Windows and Linux scripts to start the standalone scheduler process with no web application. The standalone scheduler can be customized by adding your job code and dependencies as JARS to the <code>standalone</code> directory.		* '''standaloneObsidian.bat''' and '''standaloneObsidian.sh''' - Windows and Linux scripts to start the standalone scheduler process with no web application. The standalone scheduler can be customized by adding your job code and dependencies as JARS to the <code>standalone</code> directory.
Line 194:		Line 194:
	* '''standaloneObsidianAdmin.war''' - Standalone admin web application WAR (no scheduler). This can be deployed directly to a servlet container.		* '''standaloneObsidianAdmin.war''' - Standalone admin web application WAR (no scheduler). This can be deployed directly to a servlet container.
	* '''standalone''' - Directory containing JARs that Obsidian requires to run the standalone scheduler process. The standalone scheduler can be customized by adding your job code and dependencies as JARS to this directory.		* '''standalone''' - Directory containing JARs that Obsidian requires to run the standalone scheduler process. The standalone scheduler can be customized by adding your job code and dependencies as JARS to this directory.
	** '''obsidian-~~props~~.jar''' - JAR file containing the Obsidian ~~properties~~ file <code>com.carfey.properties</code>. If you wish to make configuration changes for the standalone scheduler, the ~~properties~~ file within this JAR will need to be updated.		** '''obsidian-yaml-configuration.jar''' or '''obsidian-properties-configuration.jar''' - JAR file containing the Obsidian configuration file - either <code>com.carfey.yaml</code> or <code>com.carfey.properties</code> respectively. If you wish to make configuration changes for the standalone scheduler, the configuration file within this JAR will need to be updated.

	= Embedding Obsidian & Customizing Artifacts =		= Embedding Obsidian & Customizing Artifacts =

Craig: /* Quick Method Using Existing Database */

2024-12-28T02:02:26Z

Quick Method Using Existing Database

← Older revision		Revision as of 02:02, 28 December 2024
Line 96:		Line 96:
	If you wish to get Obsidian running quickly using a database platform you already have running, follow these steps:		If you wish to get Obsidian running quickly using a database platform you already have running, follow these steps:

	# Ensure you have a JDK (11 or up for Obsidian 5.x.x, 1.7 or up for Obsidian 4.x.x) installed and that the <code>JAVA_HOME</code> environment variable is set to your JDK installation directory.		# Ensure you have a JDK (11 or up for Obsidian 6.x.x and 5.x.x, 1.7 or up for Obsidian 4.x.x) installed and that the <code>JAVA_HOME</code> environment variable is set to your JDK installation directory.
	# Unzip the Obsidian download zip file to a directory of your choice.		# Unzip the Obsidian download zip file to a directory of your choice.
	# At the command line, in the zip extraction directory, run the [[Installation_Guide\|installer]] using this command, substituting the appropriate Obsidian version number: <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar</code>		# At the command line, in the zip extraction directory, run the [[Installation_Guide\|installer]] using this command, substituting the appropriate Obsidian version number: <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar</code>

Craig: /* Really Quick Method Using Embedded Database */

2024-12-28T02:02:10Z

Really Quick Method Using Embedded Database

← Older revision		Revision as of 02:02, 28 December 2024
Line 80:		Line 80:
	''We do not recommend this setup for production use. ''		''We do not recommend this setup for production use. ''

	# Ensure you have a JDK (11 or up for Obsidian 5.x.x, 1.7 or up for Obsidian 4.x.x) installed and that the <code>JAVA_HOME</code> environment variable is set to your JDK installation directory.		# Ensure you have a JDK (11 or up for Obsidian 6.x.x & 5.x.x, 1.7 or up for Obsidian 4.x.x) installed and that the <code>JAVA_HOME</code> environment variable is set to your JDK installation directory.
	# Unzip the Obsidian download zip file to a directory of your choice.		# Unzip the Obsidian download zip file to a directory of your choice.
	# At the command line, in the zip extraction directory, run the [[Installation_Guide\|installer]] using this command, substituting the appropriate Obsidian version number: <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar h2-jetty-quick-start.xml</code>		# At the command line, in the zip extraction directory, run the [[Installation_Guide\|installer]] using this command, substituting the appropriate Obsidian version number: <code>java -jar Obsidian-Install-''n''-''n''-''n''.jar h2-jetty-quick-start.xml</code>

Craig at 02:01, 28 December 2024

2024-12-28T02:01:55Z

← Older revision		Revision as of 02:01, 28 December 2024
Line 14:		Line 14:
	* Obsidian 5.x.x and 6.x.x run on Java 11 or above (Obsidian 4.x.x runs on Java 1.7 or above)		* Obsidian 5.x.x and 6.x.x run on Java 11 or above (Obsidian 4.x.x runs on Java 1.7 or above)
	* Obsidian's administration web application is a servlet application.		* Obsidian's administration web application is a servlet application.
	** 6.x.x has been tested on Tomcat 10.x and Jetty 11.x		** 6.x.x has been tested on Tomcat 10.x and Jetty 11.x (Jakarta Servlet 5.0)
	** 5.x.x has been tested on Tomcat 9.x and Jetty 10.x		** 5.x.x has been tested on Tomcat 9.x and Jetty 10.x (Javax Servlet 4.0)
	** 4.x.x has been tested on Tomcat 7, 8 & 8.5 and Jetty 9.x		** 4.x.x has been tested on Tomcat 7, 8 & 8.5 and Jetty 9.x (Javax Servlet 4.0)
	* It works on all modern browsers and is tested on recent versions of Chrome, Edge and Firefox.		* It works on all modern browsers and is tested on recent versions of Chrome, Edge and Firefox.
	* Obsidian requires one of the following fully-supported database platforms:		* Obsidian requires one of the following fully-supported database platforms:

Craig: /* Embedding Obsidian - Importing Libraries and Properties File */

2024-12-27T22:02:27Z

Embedding Obsidian - Importing Libraries and Properties File

← Older revision		Revision as of 22:02, 27 December 2024
Line 214:		Line 214:
	#* This is typically just a matter of adding it to your project's resources directory.		#* This is typically just a matter of adding it to your project's resources directory.
	#* From now on, you can update this file to change the various configuration options such as database connection details.		#* From now on, you can update this file to change the various configuration options such as database connection details.
	#* You may wish to leave this file out of source control and let developers configure their own installations. However, any running Obsidian instance will need access to a valid [[Advanced_Configuration#~~Properties_File~~\|properties file]].		#* You may wish to leave this file out of source control and let developers configure their own installations. However, any running Obsidian instance will need access to a valid [[Advanced_Configuration#Properties.2FYaml_File\|properties file]].

	'''Maven users:''' Note that we do not publish Maven artifacts for Obsidian, so you will not be able to include them by referencing a public repository.		'''Maven users:''' Note that we do not publish Maven artifacts for Obsidian, so you will not be able to include them by referencing a public repository.

Craig at 21:38, 27 December 2024

2024-12-27T21:38:38Z

← Older revision		Revision as of 21:38, 27 December 2024
Line 12:		Line 12:

	* Obsidian is OS-independent, and runs on the Java Virtual Machine. It works in a variety of environments, including Linux, OSX and Windows, and can be run inside virtual machines.		* Obsidian is OS-independent, and runs on the Java Virtual Machine. It works in a variety of environments, including Linux, OSX and Windows, and can be run inside virtual machines.
	* Obsidian 5.x.x ~~runs~~ on Java 11 or above (Obsidian 4.x.x runs on Java 1.7 or above)		* Obsidian 5.x.x and 6.x.x run on Java 11 or above (Obsidian 4.x.x runs on Java 1.7 or above)
	* Obsidian's administration web application is a servlet application tested on Tomcat 9.x and Jetty 10.x ~~(Obsidian~~ 4.x.x has been tested ~~against~~ Tomcat 7, 8 & 8.5 and Jetty 9.x~~), but is likely to work in any compliant servlet container version 2.4 or higher, such as WebSphere.~~ It works on all modern browsers and is tested on recent versions of Chrome and Firefox.		* Obsidian's administration web application is a servlet application.
			** 6.x.x has been tested on Tomcat 10.x and Jetty 11.x
			** 5.x.x has been tested on Tomcat 9.x and Jetty 10.x
			** 4.x.x has been tested on Tomcat 7, 8 & 8.5 and Jetty 9.x
			* It works on all modern browsers and is tested on recent versions of Chrome, Edge and Firefox.
	* Obsidian requires one of the following fully-supported database platforms:		* Obsidian requires one of the following fully-supported database platforms:
	** MySQL 8.0.x (Obsidian 5.x and higher), 5.5-5.7 (excluding Galera)		** MySQL 8.0.x (Obsidian 5.x and higher), 5.5-5.7 (excluding Galera)
Line 24:		Line 28:
	** H2 1.4.		** H2 1.4.
	** ''Larger major versions are likely to work without issues but are not officially supported.''		** ''Larger major versions are likely to work without issues but are not officially supported.''


	'''Note:''' With some exceptions, clustered scheduler instances require access to contact license servers over the Internet, or access to an internal proxy license server. See [[Licenses & Nodes]] for more information.		'''Note:''' With some exceptions, clustered scheduler instances require access to contact license servers over the Internet, or access to an internal proxy license server. See [[Licenses & Nodes]] for more information.

Craig: /* Supported Platforms */

2024-02-20T16:10:57Z

Supported Platforms

← Older revision		Revision as of 16:10, 20 February 2024
Line 15:		Line 15:
	* Obsidian's administration web application is a servlet application tested on Tomcat 9.x and Jetty 10.x (Obsidian 4.x.x has been tested against Tomcat 7, 8 & 8.5 and Jetty 9.x), but is likely to work in any compliant servlet container version 2.4 or higher, such as WebSphere. It works on all modern browsers and is tested on recent versions of Chrome and Firefox.		* Obsidian's administration web application is a servlet application tested on Tomcat 9.x and Jetty 10.x (Obsidian 4.x.x has been tested against Tomcat 7, 8 & 8.5 and Jetty 9.x), but is likely to work in any compliant servlet container version 2.4 or higher, such as WebSphere. It works on all modern browsers and is tested on recent versions of Chrome and Firefox.
	* Obsidian requires one of the following fully-supported database platforms:		* Obsidian requires one of the following fully-supported database platforms:
	** MySQL 5.5 ~~through~~ 5.7 (excluding Galera)		** MySQL 8.0.x (Obsidian 5.x and higher), 5.5-5.7 (excluding Galera)
	** MariaDB 5.5		** MariaDB 5.5
	** Oracle 18c, 19c, 21c on Obsidian 5.x and higher		** Oracle 18c, 19c, 21c on Obsidian 5.x and higher
	** Oracle 10g, 11.x, 12c on versions prior to Obsidian 5.0.0		** Oracle 10g, 11.x, 12c on versions prior to Obsidian 5.0.0
			** PostgreSQL 11-16 on Obsidian 5.x and higher
	** PostgreSQL 9, 10		** PostgreSQL 9, 10
	** MS SQL Server 2008-~~2017~~		** MS SQL Server 2008-2019
	** H2 1.4.		** H2 1.4.
	** ''Larger major versions are likely to work without issues but are not officially supported.''		** ''Larger major versions are likely to work without issues but are not officially supported.''