Building from source
Build and run Zipline from source. Not recommended for most users.
Build from source if you need to customize Zipline or manage its dependencies yourself. For most installations, use Docker. To work on Zipline, follow the development setup.
Install Prerequisites
- Node.js 24
- pnpm@11
- ffmpeg (for generating thumbnails, optional)
You'll also need a PostgreSQL server or a local PGlite directory.
Clone the repository
Choose a stable version from Zipline's releases. The examples use v4.8.2; replace it with the release tag you want to install.
git clone https://github.com/diced/zipline
cd zipline
git switch --detach v4.8.2Install dependencies
pnpm installBuilding Zipline
Before building Zipline, create a .env file and configure a database. You can use a running PostgreSQL server, as below, or a local PGlite directory.
# Replace username and password with your PostgreSQL credentials
DATABASE_URL=postgresql://username:password@localhost:5432/zipline
# These two are optional, but you can set them to change the hostname and port
CORE_HOSTNAME=0.0.0.0
CORE_PORT=3000You will also want to setup a datasource for your instance. By default, Zipline
will use ./uploads for local file storage. You can configure a different datasource (e.g. S3) by setting
the appropriate environment variables in the .env file.
You will also need to generate a secret for zipline, to do this you can use the command below to append it to your .env file:
echo "CORE_SECRET=$(openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n')" >> .envWhat does this command do?
openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n'openssl rand -base64 42: Generate 42 random bytes in base64 encoding.tr -dc A-Za-z0-9: Remove all characters except for letters and numbers.cut -c -32: Cut the string to 32 characters.tr -d '\n': Remove the newline character.
Then build Zipline:
pnpm buildRun the server
pnpm startUpdating
Before updating, read the 4.8 upgrade notes.
Stop the running Zipline server. Fetch the release tags and select the version you want to install, replacing v4.8.2 below:
git fetch --tags origin
git switch --detach v4.8.2Then update dependencies and build Zipline:
pnpm install
pnpm buildThen start the server:
pnpm startNext steps
After setting up Zipline, you may want to:
- Harden your instance by following the hardening guide
- Setup 2FA or Passkeys for extra security
- Explore the configuration options to customize your instance
- Setup a reverse proxy for better performance and security