Installation

Unraid

Simply search for Pinchflat in the Community Apps store!

Portainer

Docker Compose file:

version: '3'
services:
  pinchflat:
    image: keglin/pinchflat:latest
    ports:
      - '8945:8945'
    volumes:
      - /host/path/to/config:/config
      - /host/path/to/downloads:/downloads

Docker

1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container.
2. Prepare the docker image in one of the two ways below:
   • From Docker Hub: docker pull keglin/pinchflat:latest, or;
   • Building locally: docker build . --file selfhosted.Dockerfile -t keglin/pinchflat:latest
3. Run the container:

# Be sure to replace /host/path/to/config and /host/path/to/downloads below with
# the paths to the directories you created in step 1
docker run \
  -p 8945:8945 \
  -v /host/path/to/config:/config \
  -v /host/path/to/downloads:/downloads \
  keglin/pinchflat:latest

IMPORTANT: File permissions

You must ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See #106 for more.

It's recommended to not run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. If you need to run any command as root, you can run su from the container's shell as there is no password set for the root user.