Skip to main content
The deploy script automatically handles dependency installation, repository cloning, environment configuration, and server startup.

​
One-Line Deploy

The fastest way to get Plank running is with our automated deployment script: 
bash <(curl -fsSL https://raw.githubusercontent.com/logscore/plank/master/scripts/deploy.sh)

​
What the Script Does

The deploy script will:
  1. Detect your operating system (Ubuntu, Debian, Fedora, Arch, Alpine, macOS)
  2. Install missing dependencies (Git, Docker, or Node.js/npm/ffmpeg for bare metal)
  3. Clone the Plank repository
  4. Guide you through environment setup
    • TMDB API key configuration
    • Authentication secret generation
    • Port and URL configuration
  5. Choose deployment method
    • Docker Compose (recommended)
    • Bare metal installation
  6. Start the server
1

Run the deploy script

Execute the one-line command above. The script will automatically detect your OS and check for dependencies.
2

Choose deployment method

When prompted, select your preferred deployment:
  • Deploy with Docker (recommended) - Automatically sets up Plank, Prowlarr, and FlareSolverr
  • Deploy Bare Metal - Installs directly on your system
3

Configure environment variables

The script will prompt you for:Other settings like authentication secrets are auto-generated.
4

Access Plank

Once deployment completes, access Plank at:
http://localhost:3300
Or use your server’s IP address if deploying remotely.

​
Post-Installation

After deployment completes:
  1. Create your first account at http://localhost:3300
  2. Configure Prowlarr (Docker only):
    • Access Prowlarr at http://localhost:9696
    • Add torrent indexers (YTS, 1337x, The Pirate Bay, etc.)
    • The API key is automatically configured
  3. Add a TMDB API key in Plank settings if not configured during setup
  4. Start streaming - Search for movies and TV shows
The first account created automatically becomes an administrator. Keep your credentials secure.

​
Next Steps

Docker Setup

Learn about Docker-specific configuration and management

Environment Variables

Customize your installation with environment variables

Bare Metal

Manual installation for advanced users

Configuration

Configure torrent indexers, subtitles, and more

​
System Requirements

​
Docker Deployment

  • OS: Linux, macOS (Docker Desktop required)
  • RAM: 2GB minimum, 4GB recommended
  • Disk: 10GB+ for downloads
  • Dependencies: Git, Docker, Docker Compose

​
Bare Metal Deployment

  • OS: Linux, macOS, Windows (WSL)
  • RAM: 2GB minimum, 4GB recommended
  • Disk: 10GB+ for downloads
  • Dependencies: Node.js 22+, npm, ffmpeg, Git
  • Additional: Prowlarr and FlareSolverr must be installed separately

​
Troubleshooting

Check your internet connection and try again. If the issue persists, manually download the script:
curl -fsSL https://raw.githubusercontent.com/logscore/plank/master/scripts/deploy.sh -o deploy.sh
chmod +x deploy.sh
./deploy.sh
The script will automatically use sudo for privileged operations. If you encounter permission errors:
  • Ensure you have sudo access
  • For Docker: You may need to log out and back in after being added to the docker group
  • Run newgrp docker to refresh group membership without logging out
Check if ports are already in use:
# Check port usage
sudo netstat -tlnp | grep -E '3300|9696|8191'

# View container logs
docker compose -f docker/docker-compose.yml logs
Verify the services are running:Docker:
docker ps
Bare Metal (systemd):
systemctl status plank
journalctl -u plank -f

Build docs developers (and LLMs) love

Get started for freeTalk to us