Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparatory steps for installation not obvious #47

Open
oughnic opened this issue Dec 10, 2021 · 1 comment
Open

Preparatory steps for installation not obvious #47

oughnic opened this issue Dec 10, 2021 · 1 comment

Comments

@oughnic
Copy link

oughnic commented Dec 10, 2021

A couple of organisations have separately tripped up on failing to change the mandatory authority from the default value. The documentation fails to make it clear that the authority is only configured on the very first start of an endpoint. See https://maurodatamapper.github.io/installing/configuring/mdm-core-config/

Suggested action:

  1. Update the Installation and Administration section to include an additional section before Installation for preparatory steps including steps to set the configuration variables
  2. Make it clear what the impact of failing to set the authority before initial install is
  3. Review all additional configuration variables to identify any additional compulsory overrides where the default option prevents functionality
  4. Amend https://maurodatamapper.github.io/installing/docker-install/ to make it clear that the config for authority (and other parameters) must be done before the install is first run.
@Sunspark
Copy link

Definitely echo point 2 - The install works fine with the defaults, but is broken in non-obvious ways.

Possible mitigations :

  • add something in the build scripts to generate a name/ url if they are not overridden (as I understand it, the name/ url actually don't matter, so long as they are unique).
  • add links in the docs to docs on how to change the defaults after set-up.

@jamesrwelch jamesrwelch moved this to Backlog in MDM State Mar 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

2 participants