Installation

Unraid

Simply search for Pinchflat in the Community Apps store!

Portainer

Important: See the note below about storing config on a network file share. It's preferred to store the config on a local disk if at all possible.

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 GHCR: docker pull ghcr.io/kieraneglin/pinchflat:latest
     • NOTE: also available on Docker Hub at keglin/pinchflat:latest
   • Building locally: docker build . --file selfhosted.Dockerfile -t ghcr.io/kieraneglin/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 \
  ghcr.io/kieraneglin/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.

Advanced: storing Pinchflat config directory on a network share

README: This is currently in the testing phase and not a recommended option (yet). The implications of changing this setting isn't clear and this could, conceivably, result in data loss. Only change this setting if you know what you're doing, why this is important, and are okay with possible data loss or DB corruption. This may become the default in the future once it's been tested more thoroughly.

As pointed out in #137, SQLite doesn't like being run in WAL mode on network shares. If you're running Pinchflat on a network share, you can disable WAL mode by setting the JOURNAL_MODE environment variable to delete. This will make Pinchflat run in rollback journal mode which is less performant but should work on network shares.

If you change this setting and it works well for you, please leave a comment on #137! Doubly so if it does not work well.