Operations grimoire/Orbeon - Revision history

Dereckson: /* Authentication */

2025-10-13T22:40:45Z

Authentication

← Older revision		Revision as of 22:40, 13 October 2025
Line 55:		Line 55:
	$ bin/digest.sh -a sha-256 -h org.apache.catalina.realm.MessageDigestCredentialHandler $(cat /tmp/.token)		$ bin/digest.sh -a sha-256 -h org.apache.catalina.realm.MessageDigestCredentialHandler $(cat /tmp/.token)
	$ exit		$ exit

			The result will be salted. That's the reason it's recommended to use the Java utility instead of sha256 command.

	== Database ==		== Database ==

Dereckson: /* Authentication */

2025-10-13T22:39:55Z

Authentication

← Older revision		Revision as of 22:39, 13 October 2025
Line 35:		Line 35:

	== Authentication ==		== Authentication ==
	Users are configured at Tomcat level. To add an user:		Users are configured at Tomcat level.

			To add an user:
			* Hash the password with any Tomcat installation
	* Provide Vault credential		* Provide Vault credential
	*# Create Vault credential under ops/secrets/nasqueron/orbeon/users/		*# Create Vault credential under ops/secrets/nasqueron/orbeon/users/
Line 44:		Line 47:
	*# Deploy it with <code>salt dwellers state.sls_id /srv/orbeon/nasqueron_forms/conf/tomcat-users.xml roles/paas-docker/containers/orbeon</code>, where <code>nasqueron_forms</code> is the name of our forms.nasqueron.orf instance		*# Deploy it with <code>salt dwellers state.sls_id /srv/orbeon/nasqueron_forms/conf/tomcat-users.xml roles/paas-docker/containers/orbeon</code>, where <code>nasqueron_forms</code> is the name of our forms.nasqueron.orf instance
	*# Restart container: <code>docker restart nasqueron_forms</code>		*# Restart container: <code>docker restart nasqueron_forms</code>

			To hash the password, you can use on your local machine or Dwellers:

			$ docker run --rm -it tomcat:9 bash
			$ cat > /tmp/.password
			<the password>
			$ bin/digest.sh -a sha-256 -h org.apache.catalina.realm.MessageDigestCredentialHandler $(cat /tmp/.token)
			$ exit

	== Database ==		== Database ==

Dereckson: /* Troubleshoot */

2023-06-02T04:04:58Z

Troubleshoot

← Older revision		Revision as of 04:04, 2 June 2023
Line 98:		Line 98:
	* PDF doesn't have style when generated through nginx. As a work around, you can create SSH tunnel with <code>ssh -L 16080:dwellers:16080</code> and browse http://localhost:16080 if you need a PDF.		* PDF doesn't have style when generated through nginx. As a work around, you can create SSH tunnel with <code>ssh -L 16080:dwellers:16080</code> and browse http://localhost:16080 if you need a PDF.
	* No flat view for multi-files attachment: https://github.com/orbeon/orbeon-forms/issues/1069		* No flat view for multi-files attachment: https://github.com/orbeon/orbeon-forms/issues/1069

			== Timeout when pressing send ==
			When pressing send it follows the workflow configured for the form. For example:

			require-valid
			then save
			then email
			then navigate("https://agora.nasqueron.org/Agora:Request/Successful")
			recover navigate("https://agora.nasqueron.org/Agora:Request/Failure")' />

			If it wait during long dozen of seconds, then go to failure page, it could be a difficulty to reach SMTP server, for example because the <code>orbeon_smtp</code> exim container is down.

	== Useful links ==		== Useful links ==
	* [https://doc.orbeon.com/ Official documentation]		* [https://doc.orbeon.com/ Official documentation]
	* [https://groups.google.com/g/orbeon Google Groups]		* [https://groups.google.com/g/orbeon Google Groups]

Dereckson: /* Shorter URLs */

2023-05-27T14:35:22Z

Shorter URLs

← Older revision		Revision as of 14:35, 27 May 2023
Line 60:		Line 60:
	We proxy /<application name> to avoid the /orbeon/fr/ in the URL and offer a more semantic URL.		We proxy /<application name> to avoid the /orbeon/fr/ in the URL and offer a more semantic URL.

	To add an application there, the pillar must be updated, then nginx vhost updated.		To add an application there, the pillar must be updated, adding your new application under the container arguments `apps`, then the nginx vhost updated.
	For Dwellers, it's {{Ops file\|pillar/paas/docker/dwellers/orbeon.sls}} then <code>salt dwellers state.sls_id /etc/nginx/vhosts/orbeon/nasqueron_forms.conf roles/paas-docker/nginx/config</code>.		For Dwellers, it's {{Ops file\|pillar/paas/docker/dwellers/orbeon.sls}} then <code>salt dwellers state.sls_id /etc/nginx/vhosts/orbeon/nasqueron_forms.conf roles/paas-docker/nginx/config</code>.

Dereckson at 14:34, 27 May 2023

2023-05-27T14:34:23Z

← Older revision		Revision as of 14:34, 27 May 2023
Line 56:		Line 56:
	GRANT USAGE ON SEQUENCE public.orbeon_form_data_id_seq TO orbeon;		GRANT USAGE ON SEQUENCE public.orbeon_form_data_id_seq TO orbeon;
	GRANT USAGE ON SEQUENCE public.orbeon_seq_val_seq TO orbeon;		GRANT USAGE ON SEQUENCE public.orbeon_seq_val_seq TO orbeon;

			== Shorter URLs ==
			We proxy /<application name> to avoid the /orbeon/fr/ in the URL and offer a more semantic URL.

			To add an application there, the pillar must be updated, then nginx vhost updated.
			For Dwellers, it's {{Ops file\|pillar/paas/docker/dwellers/orbeon.sls}} then <code>salt dwellers state.sls_id /etc/nginx/vhosts/orbeon/nasqueron_forms.conf roles/paas-docker/nginx/config</code>.

	== Troubleshoot ==		== Troubleshoot ==

Dereckson: /* Concepts */

2023-05-27T14:31:48Z

Concepts

← Older revision		Revision as of 14:31, 27 May 2023
Line 15:		Line 15:

	Once published, forms can be used different ways:		Once published, forms can be used different ways:
	* '''Through Form Runner.''' You direct the user to <code>https://forms.nasqueron.org/orbeon/fr/<your app name>/<your form name></code>. It fills the form there, and afterwards is redirected to the configured URL.		* '''Through Form Runner.''' You direct the user to <code>https://forms.nasqueron.org/orbeon/fr/<your app name>/<your form name>/new</code>. It fills the form there, and afterwards is redirected to the configured URL.
	* '''As a storage back-end.''' You can also interact through [https://doc.orbeon.com/form-runner/api/persistence Persistence API] with the storage back-end.		* '''As a storage back-end.''' You can also interact through [https://doc.orbeon.com/form-runner/api/persistence Persistence API] with the storage back-end.

Dereckson: /* Troubleshoot */

2023-05-27T14:31:04Z

Troubleshoot

← Older revision		Revision as of 14:31, 27 May 2023
Line 72:		Line 72:
	* If you got a 408 you accessed yourself /fr/login, but web.xml needs to be configured with a <login-config> block using the FORM auth method (that's the default Orbeon web.xml)		* If you got a 408 you accessed yourself /fr/login, but web.xml needs to be configured with a <login-config> block using the FORM auth method (that's the default Orbeon web.xml)
	* To enable login/logout menu, you need to add <code><property as="xs:boolean" name="oxf.fr.authentication.user-menu.enable" value="true" /></code> to properties-local.xml		* To enable login/logout menu, you need to add <code><property as="xs:boolean" name="oxf.fr.authentication.user-menu.enable" value="true" /></code> to properties-local.xml

			=== Forms ===
			* Forms must explicitly use the ''save'' action when you sent or submit them. Symptom if not is a warning do you want to leave this site, and the fact the form is correctly sent by mail but not saved in the database.

	=== Database ===		=== Database ===

Dereckson: /* Database */

2023-05-25T05:17:13Z

Database

← Older revision		Revision as of 05:17, 25 May 2023
Line 47:		Line 47:
	== Database ==		== Database ==
	Nasqueron Forms instance uses the database <code>forms</code> on db-A cluster, through the user <code>orbeon</code>.		Nasqueron Forms instance uses the database <code>forms</code> on db-A cluster, through the user <code>orbeon</code>.

			DDL can be found on repository in [https://github.com/orbeon/orbeon-forms/tree/master/form-runner/jvm/src/main/resources/apps/fr/persistence/relational/ddl form-runner/jvm/src/main/resources/apps/fr/persistence/relational/ddl]. This [https://doc.orbeon.com/form-runner/persistence/relational-db documentation page] indicates what to use.

			Permissions also need to be set:

			$ sudo -u postgres psql forms
			GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO orbeon;
			GRANT USAGE ON SEQUENCE public.orbeon_form_data_id_seq TO orbeon;
			GRANT USAGE ON SEQUENCE public.orbeon_seq_val_seq TO orbeon;

	== Troubleshoot ==		== Troubleshoot ==

Dereckson: /* Database */

2023-05-25T04:25:45Z

Database

← Older revision		Revision as of 04:25, 25 May 2023
Line 70:		Line 70:

	Caused by: org.postgresql.util.PSQLException: FATAL: no pg_hba.conf entry for host "172.27.27.4", user "orbeon", database "forms", no encryption		Caused by: org.postgresql.util.PSQLException: FATAL: no pg_hba.conf entry for host "172.27.27.4", user "orbeon", database "forms", no encryption

			For PostgreSQL, it requires:

			* plain authentication in pg_hba.conf
			* XML support

	=== Features ===		=== Features ===

Dereckson at 04:06, 25 May 2023

2023-05-25T04:06:56Z

← Older revision		Revision as of 04:06, 25 May 2023
Line 45:		Line 45:
	*# Restart container: <code>docker restart nasqueron_forms</code>		*# Restart container: <code>docker restart nasqueron_forms</code>

	== ~~Known issues~~ ==		== Database ==
			Nasqueron Forms instance uses the database <code>forms</code> on db-A cluster, through the user <code>orbeon</code>.

			== Troubleshoot ==
			=== Logs ===
			* Tomcat logs: /usr/local/tomcat/logs
			* Application log: /usr/local/logs/orbeon.log
			* Log4j configuration: /usr/local/tomcat/webapps/orbeon/WEB-INF/resources/config/log4j2.xml

	=== Authentication ===		=== Authentication ===
	Authentication is known to be rather buggy:		Authentication is known to be rather buggy:
Line 56:		Line 64:
	* To enable login/logout menu, you need to add <code><property as="xs:boolean" name="oxf.fr.authentication.user-menu.enable" value="true" /></code> to properties-local.xml		* To enable login/logout menu, you need to add <code><property as="xs:boolean" name="oxf.fr.authentication.user-menu.enable" value="true" /></code> to properties-local.xml

	=== Features ===		=== Database ===
			If the database doesn't work, check the container logs.

			For example, during setup, we've got a org.postgresql.util.PSQLException with:

			Caused by: org.postgresql.util.PSQLException: FATAL: no pg_hba.conf entry for host "172.27.27.4", user "orbeon", database "forms", no encryption

			=== Features ===
			Known issues:
	* PDF doesn't have style when generated through nginx. As a work around, you can create SSH tunnel with <code>ssh -L 16080:dwellers:16080</code> and browse http://localhost:16080 if you need a PDF.		* PDF doesn't have style when generated through nginx. As a work around, you can create SSH tunnel with <code>ssh -L 16080:dwellers:16080</code> and browse http://localhost:16080 if you need a PDF.
	* No flat view for multi-files attachment: https://github.com/orbeon/orbeon-forms/issues/1069		* No flat view for multi-files attachment: https://github.com/orbeon/orbeon-forms/issues/1069