Get Started

Requirements

If Docker

• Docker: docs.docker.com/engine/install
• Docker Compose: docs.docker.com/compose/install

Without Docker

• Node: nodejs.org

With Docker

docker pull diced/zipline:trunk

docker run -p 3000:3000 -v $PWD/config.toml:/zipline/config.toml -d diced/zipline:trunk

With Docker Compose (recomended)

This is the most easy way to setup zipline as it takes virtually zero work from you to setup.

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

The configuration is editable via environment variables inside the docker-compose.yml file.

docker-compose up -d

Updating with Docker Compose (recomended)

# make sure you're in zipline dirdocker-compose pulldocker-compose up -d

Without Docker (using plain node)

1. Clone the repo

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

2. Change the config.example.toml, and then rename it to config.toml
3. Install Dependencies

npm

npm install

Yarn

yarn install

4. Build Zipline

npm

npm run build

Yarn

yarn run build

5. Run Zipline with

npm

npm run start

Yarn

yarn run start