Upgrading Obsidian - Revision history

Craig: /* Upgrading to 7.1.0 */

2026-10-29T20:15:06Z

Upgrading to 7.1.0

← Older revision		Revision as of 20:15, 29 October 2026
Line 14:		Line 14:
	* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.		* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.
	* Standalone stop listens on loopback only. Stop on the scheduler host (<code>standaloneObsidian stop</code>).		* Standalone stop listens on loopback only. Stop on the scheduler host (<code>standaloneObsidian stop</code>).
	* If you enabled the optional Linux user systemd unit from 7.0.0, re-run <code>./linux/install-embedded-linux-integration.sh "$PWD" scheduler</code> (use '''adminOnly''' for Standalone Admin embed) so the template unit replaces the old concrete file. See [[Linux_Service]].		* If you enabled the optional Linux user systemd unit from 7.0.0, re-run <code>./linux/install-embedded-linux-integration.sh "$PWD" scheduler</code> (use '''adminOnly''' for Standalone Admin embed) so the template unit replaces the old concrete file. See [[Linux_Service\|Linux Service]].

	=== Upgrading to 7.0.0 ===		=== Upgrading to 7.0.0 ===

Craig: /* Upgrading to 7.1.0 */

2026-10-29T20:14:51Z

Upgrading to 7.1.0

← Older revision		Revision as of 20:14, 29 October 2026
Line 11:		Line 11:
	* Finish upgrading every scheduler node that uses ''DBAuthenticator'' before allowing password logins against the shared database. Mixed 7.0.x and 7.1.0 nodes would store different password encodings.		* Finish upgrading every scheduler node that uses ''DBAuthenticator'' before allowing password logins against the shared database. Mixed 7.0.x and 7.1.0 nodes would store different password encodings.
	** After every node is on 7.1.0, have each active user sign in or change password so the stored password is rewritten. A later Obsidian release will stop accepting the previous encoding. Accounts that never sign in will then need an admin password reset.		** After every node is on 7.1.0, have each active user sign in or change password so the stored password is rewritten. A later Obsidian release will stop accepting the previous encoding. Accounts that never sign in will then need an admin password reset.
	* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy]].		* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy\|Key Server Proxy]].
	* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.		* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.
	* Standalone stop listens on loopback only. Stop on the scheduler host (<code>standaloneObsidian stop</code>).		* Standalone stop listens on loopback only. Stop on the scheduler host (<code>standaloneObsidian stop</code>).

Craig: Wiki update

2026-10-29T18:57:34Z

Wiki update

← Older revision		Revision as of 18:57, 29 October 2026
Line 13:		Line 13:
	* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy]].		* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy]].
	* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.		* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.
	* Standalone stop listens on loopback only. Stop on the scheduler host ({{standaloneObsidian stop}}).		* Standalone stop listens on loopback only. Stop on the scheduler host (<code>standaloneObsidian stop</code>).
	* If you enabled the optional Linux user systemd unit from 7.0.0, re-run <code>./linux/install-embedded-linux-integration.sh "$PWD" scheduler</code> (use '''adminOnly''' for Standalone Admin embed) so the template unit replaces the old concrete file. See [[Linux_Service]].		* If you enabled the optional Linux user systemd unit from 7.0.0, re-run <code>./linux/install-embedded-linux-integration.sh "$PWD" scheduler</code> (use '''adminOnly''' for Standalone Admin embed) so the template unit replaces the old concrete file. See [[Linux_Service]].

Craig at 18:54, 29 October 2026

2026-10-29T18:54:52Z

← Older revision		Revision as of 18:54, 29 October 2026
Line 9:		Line 9:
	* Existing JavaScript jobs: select Script Libraries JavaScript, or set <code>script.javascript=true</code>. The option is off by default.		* Existing JavaScript jobs: select Script Libraries JavaScript, or set <code>script.javascript=true</code>. The option is off by default.
	* REST event-hook URLs (<code>com.carfey.obsidian.restfulEventHook.url</code>) and client licence URLs must use a publicly routable <code>http</code>/<code>https</code> host. Point REST hooks at a public HTTPS endpoint (or a publicly reachable reverse proxy).		* REST event-hook URLs (<code>com.carfey.obsidian.restfulEventHook.url</code>) and client licence URLs must use a publicly routable <code>http</code>/<code>https</code> host. Point REST hooks at a public HTTPS endpoint (or a publicly reachable reverse proxy).
	* Finish upgrading every scheduler node that uses ''DBAuthenticator'' before allowing password logins against the shared database. ~~Have~~ every active user sign in (or change password~~) within six months of 7~~.1.~~0 GA so stored hashes are upgraded~~.		* Finish upgrading every scheduler node that uses ''DBAuthenticator'' before allowing password logins against the shared database. Mixed 7.0.x and 7.1.0 nodes would store different password encodings.
			** After every node is on 7.1.0, have each active user sign in or change password so the stored password is rewritten. A later Obsidian release will stop accepting the previous encoding. Accounts that never sign in will then need an admin password reset.
	* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy]].		* The ''allowSelfSignedCert'' scheduler setting is removed. If the licence URL uses a private CA or self-signed certificate, import it and set ''licenceTruststorePath'' / ''licenceTruststorePassword'' — see [[Key_Server_Proxy]].
	* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.		* Mail JNDI: <code>mail.session.jndi.path</code> must be a JNDI name (optional <code>java:</code> prefix). Typical names such as <code>java:comp/env/mail/Session</code> still work.

Craig: Wiki update

2026-10-29T18:40:14Z

Wiki update

@@ 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.
 === Upgrading to 7.0.0 ===
@@ Line 16: / Line 28: @@
 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) ====

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 ==