Skip to content
Get packs

Guide · Open source

How to use zfile: install, connect storage and share files

Updated · written with AI from the project's own documentation and checked against our catalogue data

ZFile is an open-source web program for individuals and small teams who keep files across several cloud storage services. You run it on your own server, then browse, preview and share files from one interface. This guide covers what it does, how to install it from the README commands, and how to set up storage sources, users and share links.

ZFilezfile-dev/zfile · ★ 10.9k · MIT

Quick start

  1. 1Check prerequisites. Make sure you have a server you control and Docker or Docker Compose installed. ZFile is self-hosted.
  2. 2Download the install script. Run the curl command from the README to save install.sh locally.
  3. 3Make the script executable. Run chmod +x install.sh so you can execute it.
  4. 4Run the installer. Run ./install.sh and follow the prompts it shows.
  5. 5Add storage sources. Sign in to the admin backend and add the storage services you already use.
  6. 6Create users and share. Assign storage or folders to users, then generate direct or short links as needed.

What ZFile does and who it suits

ZFile is a web-based cloud drive program. It connects to existing storage such as S3, OneDrive, SharePoint, Google Drive, local storage, FTP and SFTP, and manages them in one place.

It is aimed at individuals and small teams. The README describes self-hosting, so you need a server you control. Documentation is available in Chinese at docs.zfile.vip.

  • Unified management of multiple storage sources
  • Online preview for images, audio and video, text, PDF, Office and OBJ (3D) files
  • Direct links and short links, with a validity period on short links
  • Responsive layout for phones, tablets and computers
  • Multi-user support, with storage sources or folders assigned per user

Install ZFile with the one-click script or Docker

The README's quick start uses a one-click install script. Download it, make it executable, then run it. Check the install documentation at docs.zfile.vip/install/ for other methods.

The README lists Docker and Docker Compose for container deployment, on AMD64 and ARM64 servers. You need Docker or Docker Compose installed first.

  • Requirement: Docker or Docker Compose for container deployment
  • Supported architectures: AMD64 and ARM64
curl -fsSL https://docs.zfile.vip/install.sh -o install.sh chmod +x install.sh ./install.sh

Connect your storage sources

After installation, sign in to the admin backend. The README includes screenshots of the storage source list and the add local storage form, so the storage section is where you add each source.

Start with the one or two sources you use most. Each source you add becomes available to browse from the same web interface.

  • Open the storage source list in the admin backend
  • Add a source such as S3, OneDrive, Google Drive, local storage, FTP or SFTP
  • Check that the files appear in the file list

Create users and limit access

ZFile supports multiple users. You can assign specific storage sources or folders to each user, so people only see what you give them access to.

Use this when a family or small team shares one server but should not all see the same files.

  • Create a user in the user management screen
  • Assign the storage source or folder that user should access

Share files with direct and short links

ZFile can generate a direct link to a file. It can also create short links, and you can set an expiry period on a short link.

Expiring short links suit one-off sharing. The README's file-type restriction and rate-limited download features are marked as donor-edition only, so do not rely on them unless you have confirmed the edition you run includes them.

  • Generate a direct link from the file view
  • Generate a short link and set its validity period

Browse and preview efficiently

The file list supports gallery mode and previews for many formats. Keyboard shortcuts help with selecting multiple files.

Use Ctrl + A to select all, Ctrl + left click for multi-select, Shift + left click for range selection, and Esc to clear the selection.

  • Ctrl + A: select all
  • Ctrl + left click: multi-select
  • Shift + left click: range selection
  • Esc: cancel selection

What people use it for

  • Browsing files spread across S3, OneDrive and Google Drive from one page
  • Sending a colleague a short link to a document that expires
  • Giving a family member access to one folder on a shared server
  • Previewing PDFs, Office files and videos without downloading them first

Frequently asked questions

Is ZFile free?

ZFile is released under the MIT License, according to the README. The README also says the open-source and donor editions have been merged into one version, but it marks rate-limited downloads and file-type restrictions as donor-edition only.

What do I need to install ZFile?

The README lists Docker or Docker Compose for container deployment, on AMD64 or ARM64 servers. You also need a server you manage, because ZFile is self-hosted.

How do I install ZFile?

Download install.sh with curl from docs.zfile.vip, make it executable with chmod +x, and run ./install.sh. The full installation guide is at docs.zfile.vip/install/.

Is there a hosted version of ZFile?

The README describes self-hosting, and does not describe a hosted service. It links to an online demo at demo.zfile.vip, which you can use to look at the interface.

What storage services does ZFile support?

The README lists S3, OneDrive, SharePoint, Google Drive, Duoyun, Upyun, local storage, FTP and SFTP. Check the documentation for the setup details of each one.

How does ZFile compare to Alist or Nextcloud?

The README does not compare ZFile with other projects, so this guide makes no claims about them. ZFile is described as a web drive for individuals and small teams that unifies existing storage, which may suit you if that is your need.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

ZFile suits individuals and small teams who already have files across several cloud storage services and can run a Docker-based server. It is a poor fit if you want a hosted service with no maintenance, need the donor-only download limits or file-type restrictions, or need a large enterprise deployment.

Install options & downloads