mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-14 07:24:52 +09:00
Merge pull request #1010 from bbassie/feature/plugin-browser
Plugin management through web interface
This commit is contained in:
1 parent
e36a76acc5
commit
ffe82f81d8
48 files changed
+4275
-536
No files matched your search
@@ -283,10 +283,15 @@ This command lists all plugins currently known to the remote. Newly installed pl
|
||||
|
||||
### Update
|
||||
|
||||
ctl> controller plugin update <name> [--restart]
|
||||
ctl> host plugin update <host> <name> [--restart]
|
||||
ctl> controller plugin update <name>[@<version>] [--restart]
|
||||
ctl> host plugin update <host> <name>[@<version>] [--restart]
|
||||
|
||||
If remote plugin updates are enabled on the remote, this will execute `npm update --save <name>`. Changes will not be applied until the remote is restarted. If the `--restart` flag is provided, the remote will automatically restart once the update is complete.
|
||||
If remote plugin updates are enabled on the remote, this will execute `npm update --save <name>`, which stays within the version range saved in the remote's `package.json`.
|
||||
To update to a specific version, including one outside that range, pass it as `<name>@<version>`, for example `@clusterio/plugin-example@2.1.0`.
|
||||
The version must be published on npm, and the remote then executes `npm install --save <name>@<version>`.
|
||||
The plugin must already be installed on the remote, and only remote plugin updates need to be enabled.
|
||||
Changes will not be applied until the remote is restarted.
|
||||
If the `--restart` flag is provided, the remote will automatically restart once the update is complete.
|
||||
|
||||
### Update All
|
||||
|
||||
@@ -297,10 +302,30 @@ Updates the Clusterio package and all plugins installed from npm in a single `np
|
||||
|
||||
### Install
|
||||
|
||||
ctl> controller plugin install <name> [--restart]
|
||||
ctl> host plugin install <host> <name> [--restart]
|
||||
ctl> controller plugin install <name>[@<version>] [--restart]
|
||||
ctl> host plugin install <host> <name>[@<version>] [--restart]
|
||||
|
||||
If remote plugin installs are enabled on the remote, this will execute `npm install --save <name>`.
|
||||
Pass `<name>@<version>` to install a specific version, for example to match the version used by the rest of the cluster.
|
||||
The package, and the version if given, must be published on npm.
|
||||
Changes will not be applied until the remote is restarted.
|
||||
If the `--restart` flag is provided, the remote will automatically restart once the update is complete.
|
||||
|
||||
### Search
|
||||
|
||||
ctl> controller plugin search [query] [--page <n>] [--page-size <n>]
|
||||
|
||||
Searches the npm registry for packages tagged with the clusterio-plugin keyword.
|
||||
The search is done by the controller and does not require remote installs to be enabled.
|
||||
The web UI has a plugin browser on the plugins page that uses the same search.
|
||||
|
||||
### Concurrent Operations
|
||||
|
||||
Only one npm operation runs at a time on a machine.
|
||||
A standalone controller and host share their working directory, so the operation holds the `npm-operation.lock` file there while npm runs.
|
||||
Other installs and updates on the same machine or installation are rejected with "Another package operation is already in progress on this machine" until it finishes.
|
||||
A lock file left behind by a process that is no longer running is removed automatically.
|
||||
|
||||
If remote plugin installs are enabled on the remote, this will execute `npm install --save <name>`. Changes will not be applied until the remote is restarted. If the `--restart` flag is provided, the remote will automatically restart once the update is complete.
|
||||
|
||||
### Enable/Disable Updates
|
||||
|
||||
|
||||
Reference in new issue
Block a user