Skip to main content

​
Requirements

Go 1.25+

Required for building and running Pupload

Docker

Required for running processing nodes

Redis

Optional, for standalone server deployments

​
Install from binary

The easiest way to install Pupload is using go install:
go install github.com/pupload/pupload/cmd/pup@latest
This installs the pup CLI to your $GOPATH/bin directory.
Make sure $GOPATH/bin is in your PATH to run pup from anywhere.

​
Verify installation

Confirm that Pupload is installed correctly: 
pup --version
You should see output showing the version number.

​
Set up Docker

Pupload runs processing nodes in Docker containers. Make sure Docker is installed and running: 
docker --version
If you need to install Docker, visit the official Docker documentation.
Make sure your user has permission to run Docker commands. On Linux, you may need to add your user to the docker group:
sudo usermod -aG docker $USER
Log out and back in for changes to take effect.

​
Optional: Redis setup

For production deployments with separate controller and worker processes, you’ll need Redis.
Run Redis in a Docker container:
docker run -d -p 6379:6379 redis:latest
For local development using pup dev, Redis is not required. The dev command runs an in-memory controller.

​
Next steps

Quick start guide

Create your first Pupload project and run a processing flow

Build docs developers (and LLMs) love

Get started for freeTalk to us