Advanced Configuration - Revision history

Craig: /* Required Libraries for Embedded API */

2026-06-06T23:45:54Z

Required Libraries for Embedded API

← Older revision		Revision as of 23:45, 6 June 2026
Line 359:		Line 359:
	To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code>/<code>com.carfey.yaml</code> file can be extracted from the <code>obsidian-properties-configuration.jar</code>/<code>obsidian-yaml-configuration.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.		To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code>/<code>com.carfey.yaml</code> file can be extracted from the <code>obsidian-properties-configuration.jar</code>/<code>obsidian-yaml-configuration.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.

	* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-~~props~~.jar, which contains the configuration file		* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-properties-configuration.jar/obsidian-yaml-configuration.jar, which contains the configuration file
	* obsidian.jar		* obsidian.jar
	* dom4j-2.1.3.jar		* dom4j-2.1.3.jar

Craig: /* Required Libraries for Embedded API */

2026-06-06T23:45:28Z

Required Libraries for Embedded API

← Older revision		Revision as of 23:45, 6 June 2026
Line 357:		Line 357:
	=== Required Libraries for Embedded API ===		=== Required Libraries for Embedded API ===

	To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code>/<code>com.carfey.yaml</code> file can be extracted from the <code>obsidian-~~props~~.jar</code>/<code>obsidian-yaml-configuration.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.		To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code>/<code>com.carfey.yaml</code> file can be extracted from the <code>obsidian-properties-configuration.jar</code>/<code>obsidian-yaml-configuration.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.

	* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-props.jar, which contains the configuration file		* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-props.jar, which contains the configuration file

Craig: /* Required Libraries for Embedded API */

2026-06-06T23:44:46Z

Required Libraries for Embedded API

← Older revision		Revision as of 23:44, 6 June 2026
Line 357:		Line 357:
	=== Required Libraries for Embedded API ===		=== Required Libraries for Embedded API ===

	To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code> file can be extracted from the <code>obsidian-props.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.		To use the [[Embedded_API\|Embedded API]], the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the ''standalone'' directory if your installation. The <code>com.carfey.properties</code>/<code>com.carfey.yaml</code> file can be extracted from the <code>obsidian-props.jar</code>/<code>obsidian-yaml-configuration.jar</code> in the ''standalone'' directory, or from an Obsidian WAR file under <code>WEB-INF/classes</code>.

	* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-props.jar, which contains the configuration file		* com.carfey.properties/com.carfey.yaml (configuration file), or obsidian-props.jar, which contains the configuration file

Craig: /* Database Properties */

2025-07-01T19:08:47Z

Database Properties

← Older revision		Revision as of 19:08, 1 July 2025
Line 97:		Line 97:

	# Sample JDBC URL formats for all platforms		# Sample JDBC URL formats for all platforms
	#com.carfey.obsidian.db.url=jdbc:mysql://localhost/obsidian		#com.carfey.obsidian.db.url=jdbc:mysql://localhost:3306/obsidian
	#com.carfey.obsidian.db.url=jdbc:h2:C:/dev/workspace/obsidian;MVCC=TRUE		#com.carfey.obsidian.db.url=jdbc:h2:C:/dev/workspace/obsidian;MVCC=TRUE
	#com.carfey.obsidian.db.url=jdbc:oracle:thin:@localhost:1521:obsidian		#com.carfey.obsidian.db.url=jdbc:oracle:thin:@localhost:1521:obsidian
	#com.carfey.obsidian.db.url=jdbc:postgresql://localhost:5432/obsidian		#com.carfey.obsidian.db.url=jdbc:postgresql://localhost:5432/obsidian
	#com.carfey.obsidian.db.url=jdbc~~:jtds~~:sqlserver://localhost:1433;databaseName=obsidian		#com.carfey.obsidian.db.url=jdbc:sqlserver://localhost:1433;databaseName=obsidian

			# As of Obsidian 6.3.0, we support constructing simple JDBC urls from component properties
			# Only supports basic URL formats noted above and does not support H2
			#com.carfey.obsidian.db.host=localhost
			#com.carfey.obsidian.db.port=3306
			#com.carfey.obsidian.db.databaseName=obsidianDB
			#com.carfey.obsidian.db.dbType=mariadb/mysql/oracle/postgresql/sqlserver
			#com.carfey.obsidian.db.oracleSid=SIDORCL


	# As of Obsidian 2.5.0, we support JNDI lookups for database connectivity.		# As of Obsidian 2.5.0, we support JNDI lookups for database connectivity.

Craig at 22:01, 27 December 2024

2024-12-27T22:01:24Z

← Older revision		Revision as of 22:01, 27 December 2024
Line 3:		Line 3:
	== Configuration Details ==		== Configuration Details ==

	The following sections show the available properties and sample values that can be used in the <code>com.carfey.properties</code> properties file. While properties format is shown, all the same configuration items apply to yaml support. See [[#Properties ~~File~~\|Properties File]] for more details on this file.		The following sections show the available properties and sample values that can be used in the <code>com.carfey.properties</code> properties file. While properties format is shown, all the same configuration items apply to yaml support. See [[#Properties.2FYaml_File\|Properties/Yaml File]] for more details on this file.

	=== Authentication Properties ===		=== Authentication Properties ===

Craig: /* Properties File */

2024-12-27T21:59:33Z

Properties File

← Older revision		Revision as of 21:59, 27 December 2024
Line 221:		Line 221:
	</pre>		</pre>

	== Properties File ==		== Properties/Yaml File ==

	The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.		The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.

Craig at 21:52, 27 December 2024

2024-12-27T21:52:13Z

← Older revision		Revision as of 21:52, 27 December 2024
Line 223:		Line 223:
	== Properties File ==		== Properties File ==

	~~== Yaml File ==~~
	The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.		The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.

Craig: /* Properties File */

2024-12-27T21:51:34Z

Properties File

← Older revision		Revision as of 21:51, 27 December 2024
Line 222:		Line 222:

	== Properties File ==		== Properties File ==

			== Yaml File ==
	The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.		The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.

Craig: /* Configuration Details */

2024-12-27T21:50:04Z

Configuration Details

← Older revision		Revision as of 21:50, 27 December 2024
Line 3:		Line 3:
	== Configuration Details ==		== Configuration Details ==

	The following sections show the available properties and sample values that can be used in the <code>com.carfey.properties</code> properties file. See [[#Properties File\|Properties File]] for more details on this file.		The following sections show the available properties and sample values that can be used in the <code>com.carfey.properties</code> properties file. While properties format is shown, all the same configuration items apply to yaml support. See [[#Properties File\|Properties File]] for more details on this file.

	=== Authentication Properties ===		=== Authentication Properties ===

Craig: /* Properties File */

2024-12-27T21:48:00Z

Properties File

← Older revision		Revision as of 21:48, 27 December 2024
Line 222:		Line 222:

	== Properties File ==		== Properties File ==
	The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.properties/yaml</code>, a <code>com.carfey.properties/yaml</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.		The above configuration must reside in a properties file named <code>com.carfey.properties</code> or a yaml file named <code>com.carfey.yaml</code> found according to the rules of [http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String) ClassLoader.getResource]. If both yaml and properties files are found, yaml is loaded first and properties values will override. Some possibilities include <code>WEB-INF/classes/com.carfey.(properties/yaml)</code>, a <code>com.carfey.(properties/yaml)</code> file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in <code>obsidian-props.jar</code> for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.

	Instead of using a classpath resource for properties, you can specify an external properties file using the Java system property <code>carfey.properties.file</code>. All expected properties must be specified in either the default <code>com.carfey.properties</code> file on the classpath or in the override file. Any properties found in both files will use the override file's values. Usage: <code>-Dcarfey.properties.file=/home/obsidian/obsidian.properties</code>.		Instead of using a classpath resource for properties, you can specify an external properties file using the Java system property <code>carfey.properties.file</code>. All expected properties must be specified in either the default <code>com.carfey.properties</code> file on the classpath or in the override file. Any properties found in both files will use the override file's values. Usage: <code>-Dcarfey.properties.file=/home/obsidian/obsidian.properties</code>.