IQSS / IQSS/dataverse

Suggestion: Production settings for domain.xml

Open
#11,631 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Size: 10 Type: Suggestion
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Suggestion Suggest settings different from those in Payara's community version domain1 that are more suited to production environments - in terms of performance, scalability, and security.

What kind of user is the suggestion intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin) sysadmin

What inspired this idea? looking through https://docs.payara.fish/community/docs/5.201/documentation/payara-server/production-ready-domain.html and https://github.com/gdcc/dataverse-kubernetes/issues/218, etc.

What existing behavior do you want changed? We should give guidance (e.g. maybe an Admin/Production settings guide?) and/or just suggest changes to the default domain.xml that people should use. For example, to make it easier to see what changes Payara makes between versions to domain.xml, I've started keeping a copy, modified to show where the Dataverse instance specific changes should get added. This commit: https://github.com/QualitativeDataRepository/dataverse/commit/d34f994c7a647d059c6520b726d0bdd5421e599f shows the recommended changes I've been trying so far.

Are you thinking about creating a pull request for this issue?
I'd suggest, as a first step that some performance testing (or test use on Harvard production) be tried with the changes suggested in the commit (and perhaps the ones from https://github.com/gdcc/dataverse-kubernetes/issues/218 as well?) and, if they help, that we use this issue to trigger a PR for some guide material and perhaps an example domain as in the QDR repo.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Payara production-ready-domain guide, domain.xml, and the QDR commit referenced in the issue; compare those changes with the suggestions in dataverse-kubernetes issue 218. Validate proposed settings through performance testing or production use, then document the evidence in a production guide or example domain.xml.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, performance, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.