Skip to content

Add notes about kpm username/password #667

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
pierre merged 1 commit into from
Mar 29, 2026
+15 −2
Merged

Add notes about kpm username/password #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 0 deletions userguide/kaui/includes/plugin-manager.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ image::../assets/img/kaui/kpm_install.png[width=850,align="center"]
. Click on the download icon next to the plugin that you wish to install.
. Wait a few minutes, then refresh the web page.

[NOTE]
====
If you have changed the default admin username or password in your `shiro.ini` file as explained https://docs.killbill.io/latest/user_management#_kill_bill_setup[here], you must also specify the corresponding values for `org.killbill.billing.plugin.kpm.adminUsername` and `org.killbill.billing.plugin.kpm.adminPassword` in your Kill Bill configuration (See https://docs.killbill.io/latest/userguide_configuration[docs]). Otherwise, plugin installation via Kaui will fail because the KPM plugin will not be able to authenticate with the correct credentials.
====

Once the plugin download is complete, it will appear in Stopped status. To start the plugin, click on the *Start* button.

//COPIED FROM:
Expand Down
7 changes: 5 additions & 2 deletions userguide/tutorials/plugin_installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ A key identifies each entry in that repository, and that key is the `pluginKey`.

== Plugin Installation

[NOTE]
====
If you have changed the default admin username or password in your `shiro.ini` file, you must also specify the corresponding values for `org.killbill.billing.plugin.kpm.adminUsername` and `org.killbill.billing.plugin.kpm.adminPassword` in your Kill Bill configuration. Otherwise, plugin installation (including via Kaui, KPM, or the API) will fail because the KPM plugin will not be able to authenticate with the correct credentials.
====

=== Installing via Kaui

In order to deploy a plugin via Kaui, you need to do the following:
Expand Down Expand Up @@ -274,5 +279,3 @@ curl -v \
* https://docs.killbill.io/latest/plugin_management.html[_Plugin Management_]




5 changes: 5 additions & 0 deletions userguide/tutorials/plugin_management.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ The following APIs are supported:

=== Installation

[NOTE]
====
If you have changed the default admin username or password in your `shiro.ini` file as explained https://docs.killbill.io/latest/user_management#_kill_bill_setup[here], you must also specify the corresponding values for `org.killbill.billing.plugin.kpm.adminUsername` and `org.killbill.billing.plugin.kpm.adminPassword` in your Kill Bill configuration (See https://docs.killbill.io/latest/userguide_configuration[docs]). Otherwise, plugin installation (including via Kaui or the API) will fail because the KPM plugin will not be able to authenticate with the correct credentials.
====

The installation of a plugin occurs through the KPM plugin (which itself relies on KPM) and consists of the following sequence:

* Download the binaries and install them on the filesystem at the right place
Expand Down
Loading