## Set up `docker-compose.yml` [#set-up-docker-composeyml-step]
First, download the `docker-compose.yml` file:
curl
wget
```bash
curl -LO https://zipline.diced.sh/docker-compose.yml
```
```bash
wget https://zipline.diced.sh/docker-compose.yml
```
**If you don't already have a `.env`** file with a database password and zipline secret, you can generate one with the following command:
```bash copy
echo "POSTGRESQL_PASSWORD=$(openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n')" > .env
echo "CORE_SECRET=$(openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n')" >> .env
```
```bash
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.
Zipline will fail to start without the `POSTGRESQL_PASSWORD` and `CORE_SECRET` variables.
You will also want to setup a [datasource](/docs/config/datasource) for your instance. By default, Zipline
will use `./uploads` (the docker-compose.yml also includes a volume for this) for local file storage. You
can configure a different datasource (e.g. S3) by setting the appropriate environment variables in the
`.env` file.
## Run the server [#run-the-server-step]
```bash copy
docker compose pull
docker compose up -d
```
After starting, Zipline will be available at `http://:3000` where `` is the IP address of the machine running Zipline.
You will be redirected to a setup page where you can configure the default super administrator username and password.
## Updating [#updating]
To update Zipline, simply run the following command:
```bash copy
docker compose pull
docker compose up -d
```
This will pull the latest Zipline image and restart the server.
## Next steps [#next-steps]
After setting up Zipline, you may want to:
* Harden your instance by following the [hardening guide](/docs/guides/hardening)
* Setup [2FA](/docs/guides/2fa) or [Passkeys](/docs/guides/passkeys) for extra security
* Explore the [configuration options](/docs/config) to customize your instance
* Setup a [reverse proxy](/docs/guides/reverse-proxy) for better performance and security
# Get started (/docs/get-started)
## Install Prerequisites [#install-prerequisites-step]
* [nodejs@22](https://nodejs.org/)
* [pnpm@11](https://pnpm.io/installation)
* [ffmpeg](https://ffmpeg.org/download.html) (for generating thumbnails, optional)
If you would like to see what versions Zipline has been successfully built on, visit the [actions
history](https://github.com/diced/zipline/actions/workflows/build.yml?query=branch%3Av4). Click the latest
one on the top, and you can see runs labelled like `build (20.x, amd64)`. This means that Zipline was
successfully built on node version 20.x on an amd64 architecture.
## Clone the repository [#clone-the-repository-step]
```bash copy
git clone https://github.com/diced/zipline
cd zipline
```
## Install dependencies [#install-dependencies-step]
```bash copy
pnpm install
```
## Building Zipline [#building-zipline-step]
Before building Zipline, you will have to create a `.env` file, as well as have a PostgreSQL database running. An example .env looks like this:
```bash copy
# 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=3000
```
You will also want to setup a [datasource](/docs/config/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:
```bash copy
echo "CORE_SECRET=$(openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n')" >> .env
```
What does this command do?
```bash
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:
```bash copy
pnpm build
```
## Run the server [#run-the-server-step]
```bash copy
pnpm start
```
## Updating [#updating]
To update Zipline, simply run the following command:
```bash copy
git pull
```
Then update dependencies and build Zipline:
```bash copy
pnpm install
pnpm build
```
Then start the server:
```bash copy
pnpm start
```
## Next steps [#next-steps]
After setting up Zipline, you may want to:
* Harden your instance by following the [hardening guide](/docs/guides/hardening)
* Setup [2FA](/docs/guides/2fa) or [Passkeys](/docs/guides/passkeys) for extra security
* Explore the [configuration options](/docs/config) to customize your instance
* Setup a [reverse proxy](/docs/guides/reverse-proxy) for better performance and security
# 2FA (/docs/guides/2fa)
TOTP (time-based one-time password) adds a six-digit code on top of your password at login. The code comes from an authenticator app on your phone like [2FAS](https://2fas.com/), [Authy](https://authy.com/), [Aegis](https://getaegis.app/), Google Authenticator, or whatever password manager you already use.
## Enabling TOTP on your instance [#enabling-totp-on-your-instance]
1. Head to **Server Settings**
2. Scroll down to **Multi-Factor Authentication**
3. Toggle **Enable TOTP** and click **Save**
