Skip to content

Document --credentials, --apikey and --sessionkey; remove -k (duplicate) #3360

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.

Sign up for GitHub

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

Merged
muxator merged 3 commits into from
Aug 9, 2018
Merged

Document --credentials, --apikey and --sessionkey; remove -k (duplicate) #3360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5dffc5
remove -k argument as it is currently for both sessionkey and apikey
michael-dev Apr 4, 2018
85dfbbf
hint to --sessionkey, --apikey and --credentials in README.md
michael-dev Apr 4, 2018
a08262b
doc: review "Tweak the settings"
muxator Jul 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,10 @@ If cloning to a subdirectory within another project, you may need to do the foll
# Next Steps

## 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 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 a 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.

You should use a dedicated database such as "mysql", if you are planning on using etherpad-in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes.

Expand Down
4 changes: 2 additions & 2 deletions src/node/utils/Cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ for ( var i = 0; i < argv.length; i++ ) {
}

// Override location of settings.json file
if ( prevArg == '--sessionkey' || prevArg == '-k' ) {
Copy link
Copy Markdown
Contributor

@muxator muxator Jul 26, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

if ( prevArg == '--sessionkey' ) {
exports.argv.sessionkey = arg;
}

// Override location of settings.json file
if ( prevArg == '--apikey' || prevArg == '-k' ) {
if ( prevArg == '--apikey' ) {
exports.argv.apikey = arg;
}

Expand Down