Skip to content

Installation

The easiest way to install Plank on Linux. This script handles everything, including dependencies, configuration, and service setup.

Terminal window
bash <(curl -fsSL https://raw.githubusercontent.com/logscore/plank/master/scripts/deploy.sh)

The script will prompt you to choose between Docker and bare metal, then walk you through the setup.

Supported distros: Debian/Ubuntu, Fedora/RHEL, Arch, and Alpine.

If you’d rather set things up manually with Docker:

Terminal window
git clone https://github.com/logscore/plank.git && cd plank
cp .env.example .env
docker compose -f docker/docker-compose.yml --env-file .env up -d

This starts three containers:

  • Plank on port 3300
  • Prowlarr (torrent indexer) on port 9696
  • FlareSolverr (captcha solving) on port 8191

Edit the .env file before starting to configure API keys and other settings. See Environment Variables for the full reference.

Requirements:

  • Node.js 22+
  • npm
  • FFmpeg
  • Git
Terminal window
git clone https://github.com/logscore/plank.git && cd plank
cp .env.example .env
npm install
npm run build
npx drizzle-kit migrate
node build

Plank will be available at http://localhost:3300.

For Proxmox users, there’s a dedicated script to set up Plank in an LXC container:

Terminal window
bash <(curl -fsSL https://raw.githubusercontent.com/logscore/plank/master/scripts/setup-plank-lxc.sh)

This creates a Debian-based LXC container with Plank running as a systemd service.