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

Readme is not exhaustive about configuration options #103

Open
almereyda opened this issue May 24, 2017 · 1 comment
Open

Readme is not exhaustive about configuration options #103

almereyda opened this issue May 24, 2017 · 1 comment

Comments

@almereyda
Copy link

The Readme explains how to pass Server Options, but doesn't show a simple list which ones exist. The ones explained below at least lack an explanation about farm mode.
There are also a plenty of other options in the JSON objects at fedwiki/wiki-security-passportjs#10 (comment)

@WardCunningham
Copy link
Member

We are certainly behind on documenting options and happy to have this reminder in the issues. We have recently talked of updating the list. However, we have some trouble making the list complete. There are no invalid options. Plugins can look for whatever options they choose. A plugin should certainly document any options it examines but that probably wouldn't end up in the wiki command Readme.

There probably exists strategies for parameters that should be discussed somewhere. When to use the various forms and which ones do and don't make sense together. This would be best documented in the Tips for Administrator pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants