Document --credentials, --apikey and --sessionkey; remove -k (duplicate)#3360
Merged
muxator merged 3 commits intoether:developfrom Aug 9, 2018
Merged
Document --credentials, --apikey and --sessionkey; remove -k (duplicate)#3360muxator merged 3 commits intoether:developfrom
muxator merged 3 commits intoether:developfrom
Conversation
ghost
reviewed
Apr 9, 2018
|
|
||
| ## Tweak the settings | ||
| You can initially modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad instances from the same installation.) Once you have access to your /admin section settings can be modified through the web browser. | ||
| You can initially modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad instances from the same installation. Similarly '--credentials' can be used to give an settings override file, '--apikey' to give a different APIKEY.txt file and '--sessionkey' to give a non-default SESSIONKEY.txt.) Once you have access to your /admin section settings can be modified through the web browser. |
There was a problem hiding this comment.
Can we stick to using ` around arguments, as in setting's example?
muxator
reviewed
Jul 26, 2018
| } | ||
|
|
||
| // Override location of settings.json file | ||
| if ( prevArg == '--sessionkey' || prevArg == '-k' ) { |
Contributor
There was a problem hiding this comment.
Removing an argument ruins backward compatibility.
Was this argument so broken that removing it is not going to break any installation?
I am 100% ok merging the doc changes, but would like some details on this change.
This was referenced May 26, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull requests adds some basic documentation for --credentials, --apikey and --sessionkey.
It removes the -k option, as it is currently used for both apikey and sessionkey.