Skip to main content

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
danger

After installing, please edit the docker-compose.yml 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.

Building & running from source

This section requires nodejs (v16 or later), yarn or npm.

git clone https://github.com/diced/zipline
cd zipline
npm install
npm run build
npm run 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.

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

npm install
npm run build

then run

npm run start

to start.