Vuze Web Remote

From VuzeWiki
Jump to: navigation, search

Description[edit]

Remote HTML/Javascript interface to control Vuze.

Install and use through: http://remote.vuze.com/ or http://yourcomputer:9091/

This plugin can use Remote Pairing for connectivity

Author[edit]

Parg

Homepage[edit]

http://azureus.sourceforge.net/plugin_details.php?plugin=xmwebui

Version Notes[edit]

  • Default download folder must be configured
  • Default torrent folder must be configured

Features[edit]

  • Start and stop torrents
  • Add torrents
  • Search for torrents using Vuze's search templates
  • Remove torrents
  • Set upload and download speed limits
  • Select which files in a torrent to download

Remote Protocol[edit]

The plugin supports a general JSON-based protocol and can therefore be used to control Vuze directly (as opposed to via the supplied HTML interface).

In the following examples the localhost address is used for your computer (127.0.0.1). If you are using this remotely then make sure you set a password up in the plugin's configuration, either using the remote-pairing protocol (in which case the username is 'vuze' and the password is your access-code) or manually.

Requests are made by JSON encoding the request into the URL using the pattern:

http://127.0.01:9091/vuze/rpc?json={"method":"<method_name>","arguments":{<arguments>}}

For example, to list all the torrents in Vuze, and get their name and the identifier used in other calls to identify the torrents, use

http://127.0.0.1:9091/vuze/rpc?json={"method":"torrent-get","arguments":{"fields":["id","name"]}}

To start a torrent with id 123

http://127.0.0.1:9091/vuze/rpc?json={"method":"torrent-start","arguments":{"ids":[123]}}

To download a torrent from a URL (http://vodo.net/media/torrents/The.Notorious.Newman.Brothers.2009.Xvid-VODO.torrent) and save it in a particular folder (C:\temp)

http://127.0.0.1:9091/vuze/rpc?json={"method":"torrent-add","arguments":{"filename":"http://vodo.net/media/torrents/The.Notorious.Newman.Brothers.2009.Xvid-VODO.torrent","download-dir":"C:\\temp"}}

The best documentation for what is supported is the code itself. This documents the various methods and their arguments (for example, what fields are supported on a torrent)

The RPC is mostly compatible with the Transmission RPC documented at https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt . Most remote uis that support connecting to Transmission will also connect to Vuze Web Remote.

Plugin Options[edit]

Tools->Options->Plugins->Vuze Web Remote

The plugin inherits the options of a generic 'Web Plugin' (those controlling port, protocol, pairing, access control). It also adds a few options to supply a local link to the HTML web UI, control over whether or not 'uninteresting' downloads are made available (typically this applies to downloads associated with Vuze component updates) and whether or not to log interactions.

Plugin Log View[edit]

Tools->Plugins->Log Views->Vuze Web Remote

Plugin Control View[edit]

Tools->Plugins->Vuze Web Remote

This view was added in Vuze version 5.0.0.1, plugin version 0.3.3. Its initial use is mainly as a test mechanism for the various connectivity approaches available for the remote web UI and as a way of launching a securely proxied connection to Vuze instances that are fire-walled.

You can add the various access codes for your remote Vuze instances, connect to them and then perform various commands.

The options section allows each connection to be separately configured:

  • Description: add you own description to be added to the access code so you know which code relates to which Vuze instance
  • Enable basic connection: When attempting to connect the initial method will use HTTP basic authentication over HTTP (or HTTPS if you have configured your remote Vuze to use HTTPS and created a self-signed certificate as required for this)
    • Use default authentication: If selected this corresponds to the default authentication settings for the remote client - here the username is 'vuze' and the password is your access code. You can change this in the remote vuze to use a username and password of your choice - if you have done so you will need to disable this option and enter the username/password here.
  • Secure password
    • Secure pairing uses the 'Secure Remote Password' (SRP) protocol to connect to your remote Vuze and provides a much more secure means of connecting to Vuze. You need to enable this feature in the remote Vuze via Tools->Options->Connecting->Pairing. It requires a secure password to be provided - ensure this is strong as SRP is only as strong as the password you select! Another benefit of this approach is that Vuze can tunnel/proxy the connection through its servers to enable connection to fire-walled remote Vuze instances. Because of the characteristics of SRP there is no way that the Vuze proxy can intercept any of the communications - you are guaranteed end-to-end confidentiality. For performance reasons the connection will first be attempted using SRP directly to Vuze. If this fails a proxied connection will be attempted. If you want to force the connection to be proxied there is an option to do so.

Manual Commands[edit]

  • status: Shows raw data from a 'session-get' command
  • torrents: Lists the remote torrents

Almost anything can be added here, for example synchronization of torrents across Vuze instances, you just need to ask - email paul@vuze.com


Running without GUI[edit]

To get Vuze Web Remote running without a GUI, see Setup WebUI without GUI



Back to Plugin List