Upgrading Obsidian - Revision history

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

2026-07-31T15:02:38Z

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

← Older revision		Revision as of 15:02, 31 July 2026
Line 63:		Line 63:

	== Database Upgrade Scripts ==		== Database Upgrade Scripts ==
	~~''Available as of version 3.0''~~

	When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download zip file under the "db_scripts" directory.		When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download zip file under the "db_scripts" directory.

Craig at 20:53, 9 July 2026

2026-07-09T20:53:56Z

← Older revision		Revision as of 20:53, 9 July 2026
Line 15:		Line 15:
	==== Migrating saved automated install XML (Obsidian 6 → 7) ====		==== Migrating saved automated install XML (Obsidian 6 → 7) ====

	If you use headless / automated install with an XML file saved from Obsidian 6 (IzPack 4.3.5), you must migrate that file before installing with Obsidian 7. Unzip the Obsidian 7.0.0 download and run the migrate helper (Windows: '''migrate-headless.bat --in my-old-config.xml --out my-config-izpack5.xml''', Unix: '''migrate-headless.sh''' with the same arguments, or '''java -jar Obsidian-Install-Migrate.jar --in my-old-config.xml --out my-config-izpack5.xml'''). Review '''my-config-izpack5.xml.migration-report.txt''' only if the tool creates one — if it lists unknown panels or keys, contact [[~~Support~~\|Carfey support]]. Then install with the migrated file: '''java -jar Obsidian-Install-7.0.0.jar my-config-izpack5.xml'''. The migrate helper covers Obsidian's standard installer panels only and does not modify product installer descriptors or custom installers.		If you use headless / automated install with an XML file saved from Obsidian 6 (IzPack 4.3.5), you must migrate that file before installing with Obsidian 7. Unzip the Obsidian 7.0.0 download and run the migrate helper (Windows: '''migrate-headless.bat --in my-old-config.xml --out my-config-izpack5.xml''', Unix: '''migrate-headless.sh''' with the same arguments, or '''java -jar Obsidian-Install-Migrate.jar --in my-old-config.xml --out my-config-izpack5.xml'''). Review '''my-config-izpack5.xml.migration-report.txt''' only if the tool creates one — if it lists unknown panels or keys, contact [[Contact_the_Obsidian_Scheduler_Team\|Carfey support]]. Then install with the migrated file: '''java -jar Obsidian-Install-7.0.0.jar my-config-izpack5.xml'''. The migrate helper covers Obsidian's standard installer panels only and does not modify product installer descriptors or custom installers.

	==== Upgrading evaluation installs (Jetty quick start → embedded Tomcat) ====		==== Upgrading evaluation installs (Jetty quick start → embedded Tomcat) ====

Craig at 20:53, 9 July 2026

2026-07-09T20:53:11Z

← Older revision		Revision as of 20:53, 9 July 2026
Line 16:		Line 16:

	If you use headless / automated install with an XML file saved from Obsidian 6 (IzPack 4.3.5), you must migrate that file before installing with Obsidian 7. Unzip the Obsidian 7.0.0 download and run the migrate helper (Windows: '''migrate-headless.bat --in my-old-config.xml --out my-config-izpack5.xml''', Unix: '''migrate-headless.sh''' with the same arguments, or '''java -jar Obsidian-Install-Migrate.jar --in my-old-config.xml --out my-config-izpack5.xml'''). Review '''my-config-izpack5.xml.migration-report.txt''' only if the tool creates one — if it lists unknown panels or keys, contact [[Support\|Carfey support]]. Then install with the migrated file: '''java -jar Obsidian-Install-7.0.0.jar my-config-izpack5.xml'''. The migrate helper covers Obsidian's standard installer panels only and does not modify product installer descriptors or custom installers.		If you use headless / automated install with an XML file saved from Obsidian 6 (IzPack 4.3.5), you must migrate that file before installing with Obsidian 7. Unzip the Obsidian 7.0.0 download and run the migrate helper (Windows: '''migrate-headless.bat --in my-old-config.xml --out my-config-izpack5.xml''', Unix: '''migrate-headless.sh''' with the same arguments, or '''java -jar Obsidian-Install-Migrate.jar --in my-old-config.xml --out my-config-izpack5.xml'''). Review '''my-config-izpack5.xml.migration-report.txt''' only if the tool creates one — if it lists unknown panels or keys, contact [[Support\|Carfey support]]. Then install with the migrated file: '''java -jar Obsidian-Install-7.0.0.jar my-config-izpack5.xml'''. The migrate helper covers Obsidian's standard installer panels only and does not modify product installer descriptors or custom installers.

			==== Upgrading evaluation installs (Jetty quick start → embedded Tomcat) ====

			Obsidian 7.0.0 removes the Jetty quick-start pack and '''jetty-home''' distribution. If you previously installed with a Jetty-based quick start or embedded Jetty pack:

			# Re-run the installer or edit your automated install XML to select '''Obsidian Embedded Tomcat JAR''' (scheduler) or '''Obsidian Standalone Admin Embedded Tomcat JAR''' (admin), '''and''' the matching WAR pack.
			# Remove references to legacy Jetty pack names in any saved automated install XML. If the file is still IzPack 4 format, run the migrate helper first (see [[Upgrading_Obsidian#Migrating_saved_automated_install_XML_.28Obsidian_6_.E2.86.92_7.29\|Migrating saved automated install XML]]).
			# After install, use '''webObsidian start scheduler''' (or '''start adminOnly''') instead of the Jetty '''start.jar'''.

			If the migrate helper produces a '''.migration-report.txt''' file, review it before running the install — it will flag any pack renames that need attention.

	==== Installer breaking changes (Obsidian 6 → 7) ====		==== Installer breaking changes (Obsidian 6 → 7) ====

Craig at 19:22, 9 July 2026

2026-07-09T19:22:24Z

← Older revision		Revision as of 19:22, 9 July 2026
Line 2:		Line 2:

	Note that you don't necessarily need to go through the installer UI again, although you're free to do so. Since the primary purpose of the installer is to provide fully configured Obsidian artifacts and your environment would already be configured, you really just need the updated artifacts (libraries and WAR files). Even if you want to take advantage of new configuration options, you could use the [[Advanced_Configuration\|Configuration Reference]] to make the necessary changes.		Note that you don't necessarily need to go through the installer UI again, although you're free to do so. Since the primary purpose of the installer is to provide fully configured Obsidian artifacts and your environment would already be configured, you really just need the updated artifacts (libraries and WAR files). Even if you want to take advantage of new configuration options, you could use the [[Advanced_Configuration\|Configuration Reference]] to make the necessary changes.

			=== Upgrading to 7.0.0 ===

			==== Remember Me removal ====

			The Remember Me feature has been removed. No operator action is required. On first startup after the upgrade, ''Release7Dot0Dot0Upgrader'' runs automatically and drops the ''USER_COOKIE'' table (if it exists) and removes the ''allowRememberMe'' system parameter. Users who had active Remember Me sessions will be prompted to log in on their next visit.

			==== OAuth / OIDC authentication (optional) ====

			Obsidian 7.0.0 adds an optional OAuth / OIDC authenticator. Existing installations continue to use their current authenticator (DB or LDAP) with no changes required. To switch to OAuth / OIDC: configure ''OAuthAuthenticator'' properties in the Obsidian configuration file (''com.carfey.properties'' or YAML equivalent) — see [[Authenticator#OAuthAuthenticator_(OIDC_SSO)]] and [[Advanced_Configuration#OAuth_/_OIDC_Authentication_Properties]] — then restart Obsidian.

			==== Migrating saved automated install XML (Obsidian 6 → 7) ====

			If you use headless / automated install with an XML file saved from Obsidian 6 (IzPack 4.3.5), you must migrate that file before installing with Obsidian 7. Unzip the Obsidian 7.0.0 download and run the migrate helper (Windows: '''migrate-headless.bat --in my-old-config.xml --out my-config-izpack5.xml''', Unix: '''migrate-headless.sh''' with the same arguments, or '''java -jar Obsidian-Install-Migrate.jar --in my-old-config.xml --out my-config-izpack5.xml'''). Review '''my-config-izpack5.xml.migration-report.txt''' only if the tool creates one — if it lists unknown panels or keys, contact [[Support\|Carfey support]]. Then install with the migrated file: '''java -jar Obsidian-Install-7.0.0.jar my-config-izpack5.xml'''. The migrate helper covers Obsidian's standard installer panels only and does not modify product installer descriptors or custom installers.

			==== Installer breaking changes (Obsidian 6 → 7) ====

			* Headless automated install XML must use IzPack 5 panel class names and ''id'' attributes — migrate saved Obsidian 6 files with the tooling above.
			* GUI installer — same configuration panels and outcomes; underlying engine is IzPack 5.
			* Release zip — adds migrate JAR/scripts.
			* Groovy and Flexmark libraries are now modular — see [[Advanced_Configuration#Dependent_Libraries]].

	== Automated Installer File ==		== Automated Installer File ==

Craig: /* Existing Configuration with QuickStart */

2024-12-27T22:05:38Z

Existing Configuration with QuickStart

← Older revision		Revision as of 22:05, 27 December 2024
Line 20:		Line 20:

	==== Existing Configuration with QuickStart ====		==== Existing Configuration with QuickStart ====
	If you are using [[Advanced_Configuration#~~Properties_File~~\|overrides]] support to specify '''ALL''' your configuration items, you likely are ready to go as the default configuration items are being overridden.		If you are using [[Advanced_Configuration#Properties.2FYaml_File\|overrides]] support to specify '''ALL''' your configuration items, you likely are ready to go as the default configuration items are being overridden.

	Otherwise, you are relying at least partially on embedded configuration items. You will need to replace the quickstart configuration values with your existing configuration values. The Obsidian WAR files have the <code>com.carfey.properties</code> file inside at <code>WEB-INF/classes/com.carfey.properties</code> and the standalone installation has it at the root of ''obsidian-~~props~~.jar''.		Otherwise, you are relying at least partially on embedded configuration items. You will need to replace the quickstart configuration values with your existing configuration values. The Obsidian WAR files have the <code>com.carfey.(properties/yaml)</code> file inside at <code>WEB-INF/classes/com.carfey.(properties/yaml)</code> and the standalone installation has it at the root of ''obsidian-properties-configuration.jar'' or ''obsidian-yaml-configuration.jar''.

	== Performing the Upgrade ==		== Performing the Upgrade ==

Craig: /* Database Upgrade Scripts */

2023-02-24T13:29:20Z

Database Upgrade Scripts

← Older revision		Revision as of 13:29, 24 February 2023
Line 39:		Line 39:

	Then, in your SQL client of choice, execute the scripts in order of their version numbers. This will upgrade your schema to your target version.		Then, in your SQL client of choice, execute the scripts in order of their version numbers. This will upgrade your schema to your target version.

			You'll need to allow the data portion of the migrations to execute while preventing the DDL scripts to run. To do this, you need to [[Getting_Started#Disabling_DDL_Updates\|disable DDL Updates]].

	== Performing an Always On Cluster Upgrade ==		== Performing an Always On Cluster Upgrade ==

Carfey: /* Database Upgrade Scripts */

2015-01-23T23:20:14Z

Database Upgrade Scripts

← Older revision		Revision as of 23:20, 23 January 2015
Line 38:		Line 38:
	First locate all files named "*upgrade.sql" under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.		First locate all files named "*upgrade.sql" under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.

	Then, in your SQL client of choice, execute the scripts in order of their version numbers. This ~~should~~ upgrade your schema to your target version.		Then, in your SQL client of choice, execute the scripts in order of their version numbers. This will upgrade your schema to your target version.

	== Performing an Always On Cluster Upgrade ==		== Performing an Always On Cluster Upgrade ==

Carfey: /* Database Upgrade Scripts */

2015-01-23T23:19:47Z

Database Upgrade Scripts

← Older revision		Revision as of 23:19, 23 January 2015
Line 36:		Line 36:
	When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download zip file under the "db_scripts" directory.		When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download zip file under the "db_scripts" directory.

	First locate all files named "*upgrade.sql" ~~located~~ under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.		First locate all files named "*upgrade.sql" under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.

	Then, in your SQL client of choice, execute the scripts in order of their version numbers. This should upgrade your schema to your target version.		Then, in your SQL client of choice, execute the scripts in order of their version numbers. This should upgrade your schema to your target version.

Carfey: /* Database Upgrade Scripts */

2015-01-23T23:19:12Z

Database Upgrade Scripts

← Older revision		Revision as of 23:19, 23 January 2015
Line 34:		Line 34:
	''Available as of version 3.0''		''Available as of version 3.0''

	When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download ~~package~~ under the "db_scripts" directory.		When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download zip file under the "db_scripts" directory.

	First locate all files named "*upgrade.sql" located under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.		First locate all files named "*upgrade.sql" located under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.

Carfey: /* Database Upgrade Scripts */

2015-01-23T23:18:56Z

Database Upgrade Scripts

← Older revision		Revision as of 23:18, 23 January 2015
Line 34:		Line 34:
	''Available as of version 3.0''		''Available as of version 3.0''

	When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download package under the "db_scripts" directory.		When you start Obsidian, it will automatically upgrade the schema in your target database. However, if you wish to run Obsidian with a database user without create and drop privileges, or simply wish to prepare your database structure ahead of time, you can use the database upgrade scripts provided with your download package under the "db_scripts" directory.

	First locate all files named "*upgrade.sql" located under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.		First locate all files named "*upgrade.sql" located under the directory for the database you are using under the "db_scripts" directory. Statements within these files contain the token "$px$" to enable table prefixes. Before you run the SQL files, replace all instances of the token "$px$" (without quotes) with a table prefix 6 characters or shorter (letters and underscores supported), or with blank.