transmission-proxy
v1.0.0
Published
A simple proxy server for the Transmission RPC API.
Downloads
5
Readme
Transmission Proxy
A simple proxy server for the Transmission RPC API.
The proxy only allows the torrent-add
method. This makes it ideal for use with
external services that are only allowed to push new torrents to your daemon.
One example is showRSS.
The app comes ready for deployment on Heroku as well as OpenShift. However, being a standard node.js app, it can be run pretty much anywhere.
Configuration
In config.json.example
, you will find a sample configuration to get you on
your way. Just copy it to config.json
and paste in your configuration.
By default, the app's queue gets stored in memory. However, for improved robustness and scalability, it can also store it in a relational database. To enable this feature:
Create a PostgreSQL database with the following schema:
CREATE TABLE "queue" ( "id" SERIAL PRIMARY KEY, "filename" TEXT NOT NULL, "time" TIMESTAMP WITH TIME ZONE NOT NULL );
Adapt
config.json
to connect to the database:{ "storage": { "type": "postgresql", "postgresql": { "database_url": "postgresql://USERNAME:PASSWORD@HOST:PORT" } } }
If you use Heroku or OpenShift's native PostgreSQL support, the database URL will be automatically detected from the environment.
API
API documentation is in the works. See src/server.js
for example usage of the
transmission-proxy
module.
Author
License
MIT