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

Research lockss.xml values: what are the defaults, which are required? #1

Open
atc0005 opened this issue Aug 8, 2020 · 8 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested
Milestone

Comments

@atc0005
Copy link
Owner

atc0005 commented Aug 8, 2020

Presumably this is well defined in the LOCKSS source, hopefully in one central location.

@atc0005 atc0005 added documentation Improvements or additions to documentation question Further information is requested labels Aug 8, 2020
@atc0005 atc0005 added this to the v0.1.0 milestone Aug 8, 2020
@atc0005 atc0005 self-assigned this Aug 8, 2020
@atc0005
Copy link
Owner Author

atc0005 commented Aug 8, 2020

I found this URL:

http://www.lockss.org/lockssdoc/gamma/daemon/paramdoc.html

listed within the "How to setup a Private LOCKSS Network (PLN)" guide from 2018. Attempting to view the URL results in the connection timing out.

@atc0005
Copy link
Owner Author

atc0005 commented Aug 8, 2020

https://github.com/lockss/lockss-daemon/blob/3cd40b6915b21424fd9d03eb9ab33d6813bc0271/src/overview.html

Has:

The daemon's configuration parameters are
<a href="paramdoc.txt">listed here</a>
and <a href="paramdoc.html">documented here</a>.

@atc0005
Copy link
Owner Author

atc0005 commented Aug 8, 2020

This file also makes a reference to that URL:

https://github.com/lockss/lockss-daemon/blob/3cd40b6915b21424fd9d03eb9ab33d6813bc0271/src/org/lockss/servlet/ExpertConfig.java

  /** URL of parameter documentation page */
  public static final String PARAM_PARAM_DOC_URL =
    Configuration.PREFIX + "config.paramDocUrl";
  public static final String DEFAULT_PARAM_DOC_URL =
    "http://www.lockss.org/lockssdoc/gamma/daemon/paramdoc.html";

@atc0005
Copy link
Owner Author

atc0005 commented Aug 8, 2020

@atc0005
Copy link
Owner Author

atc0005 commented Aug 8, 2020

There are 1,593 entries in that file. That file is from 10 years ago, so I assume that the number of parameters has grown exponentially since then.

I short, there is no reasonable way that I can cover all of those myself unless I use that file as a lookup table somehow.

@atc0005
Copy link
Owner Author

atc0005 commented Aug 9, 2020

I heard back from LOCKSS Support. It sounds like the parameters docs links will be updated/fixed in the near future. For now they shared an internal copy of the docs which confirm that there are 884 total parameters.

No small number.

@atc0005
Copy link
Owner Author

atc0005 commented Aug 9, 2020

I heard back from LOCKSS Support. It sounds like the parameters docs links will be updated/fixed in the near future. For now they shared an internal copy of the docs which confirm that there are 884 total parameters.

No small number.

Unfortunately I don't see any notes indicating which settings are required. Instead, it seems you have to infer which settings are needed.

@atc0005
Copy link
Owner Author

atc0005 commented Aug 15, 2020

Note: Since I don't have confirmation of the license for the current parameters docs, I'm going to leave them out of the branch that I push to this repo for now.

@atc0005 atc0005 modified the milestones: v0.1.0, Future Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant