Getting Started
Install & run with Docker
This section requires Docker and docker compose.
git clone https://github.com/diced/ziplinecd ziplinedocker compose up -d
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.
NPM is not supported as it produces unintended side effects during the build process.
git clone https://github.com/diced/ziplinecd zipline
yarn install
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.
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.
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.