/api/user

/api/auth/logout

Getting Started

NGINX Proxy

NGINX Proxy with SSL

NGINX

Caddy Reverse Proxy

Reverse Proxies

If you're using ShareX, you can head to your user management page within Zipline.

ShareX

This section requires Flameshot, jq, and xsel.

Flameshot

cURL

Android: Xshare

iOS: Shortcuts

Uploaders

Zipline now supports user registration via OAuth providers. This guide will walk you through the process of setting up OAuth for your Zipline instance.

This will walk you through the process of setting up Discord OAuth for your Zipline instance.

Discord

This will walk you through the process of setting up GitHub OAuth for your Zipline instance.

GitHub

This will walk you through the process of setting up Google OAuth for your Zipline instance.

Google

OAuth

This script will try to find and delete any files that are 0 bytes in size.

Clear Zero Byte Files

This script will list the users, with any additional properties you specify.

List Users

This script will set the size of all files in the database to the size of the file in the database.

Query Size

This script will read the configuration file and print the values that it has parsed. This may be useful if the environment variables you specify are not being parsed correctly.

Read Config

This script allows you to modify any user in the database.

Set User

Scripts

When uploading files you have a few options to choose from in the form of headers.

Upload Options

Zipline now supports notifications via Discord webhooks.

Discord Webhooks

When using Docker, you have two release channels you can use.

Releases

You can now add external links in the sidebar of Zipline.

External Links

Some config values support human readable byte sizes. For example, UPLOADERADMINLIMIT=50mb is the same as UPLOADERADMINLIMIT=52428800. The following units are supported:

Human Readable Byte Sizes

If you happen to encounter some sort of bug in Zipline, you can enable debug logs to help us figure out the problem.

Debugging

This guide may be useful if you are migrating from another host to Zipline. this may only work if the data is in a directory. Other datasources like S3 will not work with this method.

Importing Data

The LOGGER_FILTERS environment variable is used to filter logs that you want to see. This is useful if you want to see only the logs that are important to you.

Logger Filters

This guide describes how to migrate from PostgreSQL 14 to 15, since migrating through docker is a bit of a chore. This guide also assumes that you are using docker and the provided docker-compose.yml files defaults for postgres.

Docker: Migrate from PostgreSQL 14 to 15

Zipline now supports authentication methods like, Authy and Google Authenticator. This is done via TOTP (Time-based One-time Password Algorithm). This is a standard that is used by many services to provide 2FA.

TOTP (2FA - Authy, Google Authenticator)

Variables can be used to customize the text used in embeds and discord webhook text. Variables allow allow certain modifiers, that modify their appearance.

Variables

Video Thumbnails are generated by ffmpeg, by taking the first frame of a video and saving it as a jpeg file within your datasource.

Video Thumbnails

Guides

You can run Zipline with only a few configuration options, while everything else has a default option.

Zipline supports using different types of ways to store files. It defaults to saving files to the disk but Zipline now supports S3 based storage, and local file storage.

Local

Configuration for the s3 datasource. In theory, when setup with the correct options, any S3 compatible storage should work with Zipline.

Datasource

This page documents the file chunking configuration of Zipline. Chunking may be useful when uploading large files while using Cloudflare's Free Plan which limits the maximum upload size to 100MB.

Chunks

This page documents the core configuration of Zipline.

Core

This page documents the Discord webhook configuration of Zipline.

Discord Notifications

This page documents how Zipline should handle metadata from Exiftool.

Exiftool Metadata

This page documents features that can be disabled or enabled in Zipline.

Features

This page documents multi-factor authentication options, such as Two-Factor Authentication (2FA) via services like Google Authenticator and Authy.

Multi-Factor Authentication

This page documents OAuth variables that can be set in Zipline.

This page documents the ratelimit configuration of Zipline.

Ratelimit

This page documents the SSL configuration of Zipline.

This page documents the uploader configuration of Zipline.

Uploader

This page documents the url shortener configuration of Zipline.

URLs

This page documents the frontend configuration of Zipline.

Website

Configuration

This page attempts to document the entire Zipline API, currently it is a work in progress.

The file model is used to represent a file in the database.

File

The folder model is used to represent a folder in the database.

Folder

The invite model is used to represent a invite in the database.

Invite

The user model is used to represent a user in the database.

User

Models

Whenever there are errors, the response will redirect to the /oautherror page. All responses on this page are based on if FEATURESHEADLESS was set to true, therefore all responses will be JSON.

Field Name	Type	Description
`code`	`string`	The invite code
`username`	`string`	The username
`password`	`string`	The password
`administrator`	`boolean`	Whether to grant admin

Field Name	Type	Description
`username`	`string`	The username of the user
`password`	`string`	The password of the user
`administrator`	`boolean`	Whether the user is an administrator

/api/auth/register

POST
Register a user

Body (JSON)

200
Ok (JSON)

400
Bad Request (JSON)

POST
Create a user (admin)

Body (JSON)

200
Ok (JSON)

400
Bad Request (JSON)

/api/auth/register

POST Register a user

Body (JSON)

200 Ok (JSON)

400 Bad Request (JSON)

POST Create a user (admin)

Body (JSON)

200 Ok (JSON)

400 Bad Request (JSON)

POST
Register a user

200
Ok (JSON)

400
Bad Request (JSON)

POST
Create a user (admin)

200
Ok (JSON)

400
Bad Request (JSON)