Zipline - Getting Started

Getting Started

Install & run with Docker

This section requires Docker and docker compose.

git clone https://github.com/diced/zipline
cd zipline

docker compose up -d

Here is a default docker-compose.yml file to get Zipline running instantly:

version: '3'
services:
  postgres:
    image: postgres:15
    restart: unless-stopped
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DATABASE=postgres
    volumes:
      - pg_data:/var/lib/postgresql/data
    healthcheck:
      test: ['CMD-SHELL', 'pg_isready -U postgres']
      interval: 10s
      timeout: 5s
      retries: 5

  zipline:
    image: ghcr.io/diced/zipline
    restart: unless-stopped
    ports:
      - '3000:3000'
    environment:
      - CORE_SECRET=changethis
      - CORE_DATABASE_URL=postgres://postgres:postgres@postgres/postgres
    volumes:
      - './uploads:/zipline/uploads'
      - './public:/zipline/public'
    depends_on:
      - 'postgres'

volumes:
  pg_data:

Danger

After installing, please edit the docker-compose.yml file and find the line that says CORE_SECRET=changethis and replace changethis with a random string.

Ways you could generate the string could be from a password managers generator, or you could just slam your keyboard and hope for the best.

Building & running from source

This section requires nodejs (v18 (or current LTS) or later), yarn.

Info

NPM is not supported as it produces unintended side effects during the build process. Try at your own risk.

git clone https://github.com/diced/zipline
cd zipline

yarn install

Warning

Building from source requires having a valid configuration through environment variables. This does not have to be an exhaustive list of variables, but it does require the following variables to be set: CORE_SECRET and CORE_DATABASE_URL.

yarn build

yarn start

After this rename the .env.local.example file to .env.local and feel free to configure as needed.

Danger

After installing, please edit the .env.local file and find the line that says SECRET=changethis and replace changethis with a random string.

Ways you could generate the string could be from a password managers generator, or you could just slam your keyboard and hope for the best.

Install on Unraid

Info

The Unraid template for Zipline is maintained seperately, for support visit the Zipline Support topic on the Unraid forums. The Zipline Discord server or GitHub issues are not the place to ask for support for the Unraid template, and will be ignored or at best redirected to the Unraid forums.

This section is specific to Unraid OS and uses the default Community Apps plugin.

Warning

An existing PostgreSQL (15 or higher) database is required! If you do not already have one you can install postgresql15 from the app center.

Zipline is available on the Community Application Center and can be installed from there:

Search for "zipline" in community applications and install the app from ImSkully's Repository
Update the required variables:
- CORE_SECRET: Used to sign sensitive data, replace this with a random string
- CORE_DATABASE_URL: Your Postgres database connection string
(Optional) Adjust default configuration as required, see Configuration for more variables and their usage

Once created, Zipline should be running at the configured webUI port, by default this is 8092.

Default administrator password

After setting up Zipline for the first time, you may login to the dashboard with the username administrator and the password password.

Danger

Remember to change this password in the manage user page.

Updating

Docker

To update with docker you can simply run:

docker compose pull

then run

docker compose up -d

to restart.

From Source

To update from source you can simply run:

git pull

then run

yarn install

yarn build

then run

yarn start

to start.

Unraid

The Unraid application automatically updates with the latest released image from ghcr.io/diced/zipline:latest.

You will be notified of future updates that are ready to install by the application center, or visit the Action Center to manually install the latest update when available.

NGINX Proxy

This section requires NGINX.

Last updated: 9/1/2024

Edit this page on GitHub