Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 3.17 KB

INSTALL.md

File metadata and controls

98 lines (73 loc) · 3.17 KB
Raw

Installation details

PtpUploader needs Python 3.7+, as well as a couple other programs. The docker image contains all these images by default, and most distrubutions provide easy-to-install packages.

Required external programs:

  • rTorrent or transmission
    • if transmission is being used, the transmissionrpc package must be installed
  • One of: mpv (preferred), ffmpeg, mplayer
  • Mediainfo

Optional external programs:

  • ImageMagick: Highly recommended for losslessly compressing PNG screenshots
  • FlexGet: Can be used to write announce files
  • autodl-irssi: Can be used to write announce files

Upgrading

Pip

pip install -U PtpUploader

Docker

When stopping the daemon in docker, be sure to fully remove the existing container:

sudo docker rm ptpuploader
cd PtpUploader
git pull
# Re-do installation steps

Usage

Uploading

To start your first upload, go to http://localhost:8000/upload, and use the form to fill out as much information as possible about your upload. One of the first three fields (link, local path, or file) must be filled out, but anything else can be left blank, and PtpUploader will alert you if anything is missing.

Once the job is submitted, it can viewed on the jobs page at http://localhost:8000/jobs.

Automatic announcing

PtpUploader has the ability to receive jobs from files placed in the announce folder ($WORK_DIR/announce/). These files are JSON formatted, and allow for customizing the submitted job with some additional information. An example of using flexget and autodl-irssi to create these files is available in the repo.

Configuration

Configuring Django

Django's settings also allows for complex configurations. Some will be discussed here, however trying to list all of the neat things you can do is beyond the scope of this document.

Using an external database

By default PtpUploader will set up and use a SQLite database automatically. For most setups, this will work perfectly fine, however if you want to use a separate database such as PostgreSQL or MySQL/MariaDB for performance (e.g. adding more workers) or conveience, that's made possible by overriding the Django settings.

As an example for PostgreSQL, in your config.yml add the following section:

DATABASES:
  default:
    ENGINE: 'django.db.backends.postgresql_psycopg2'
    NAME: 'ptpuploader'
    USER: 'ptpuploader'
    PASSWORD: '&PtPuPlOaDeR!'
    HOST: 'sql.example.com'
    PORT: ''

Command line only usage

PtpUploader can create release description (with media info and screenshots) for manual uploading from command line.

# source ~/.venv/ptpuploader/bin/activate # Optional, if a virtualenv was used during installation.
ReleaseInfoMaker --help

Syntax:

  • ReleaseInfoMaker <target directory or filename> creates the release description and starts seeding the torrent.
  • ReleaseInfoMaker --notorrent <target directory or filename> creates the release description.
  • ReleaseInfoMaker --noscreens <target directory or filename> creates the release description, without screenshots.

Use the resulting torrent that starts with PTP for uploading to the tracker.