1.0.0 • Published 6 years ago

transmission-proxy v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

Transmission Proxy

npm JavaScript Standard Style

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:

  1. Create a PostgreSQL database with the following schema:

    ```sql
    CREATE TABLE "queue" (
      "id" SERIAL PRIMARY KEY,
      "filename" TEXT NOT NULL,
      "time" TIMESTAMP WITH TIME ZONE NOT NULL
    );
    ```
  2. 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

Tim De Pauw

License

MIT

1.0.0

6 years ago

0.10.1

6 years ago

0.10.0

6 years ago

0.9.3

6 years ago

0.9.2

6 years ago

0.9.1

6 years ago

0.9.0

6 years ago

0.8.1

6 years ago

0.8.0

6 years ago

0.4.0

6 years ago