alist README

The project's README from github.com/AlistGo/alist. As one markdown file: README.md.

logo

🗂️A file list program that supports multiple storages, powered by Gin and Solidjs.

latest version License Build status latest version
discussions discussions Downloads Downloads sponsor

English | 中文 | 日本語 | Contributing | CODE_OF_CONDUCT

Features

Document

https://alistgo.com/

API Documentation (via Apifox):

https://alist-public.apifox.cn/

Demo

https://al.nn.ci

Discussion

Please go to our discussion forum for general questions, issues are for bug reports and feature requests only.

Sponsor

AList is an open-source software, if you happen to like this project and want me to keep going, please consider sponsoring me or providing a single donation! Thanks for all the love and support: https://alistgo.com/guide/sponsor.html

Special sponsors

Contributors

Thanks goes to these wonderful people:

Contributors

License

The AList is open-source software licensed under the AGPL-3.0 license.

Disclaimer


@GitHub · @TelegramGroup · @Discord

alist (AlistGo/alist)

Searching Database…

50.3K ·GitHub
What is this?Alist is a self-hosted file list and WebDAV program that lets you browse and manage files stored across dozens of different cloud storage providers through one unified web interface.
Is this a standalone app or a library I'd embed?It is a standalone self-hosted server application: a Go backend (Gin) with a Solid.js frontend, deployed as a binary or Docker container.
How do I get it running?The recommended way is Docker Deploy using the provided image and docker-compose setup; binaries are also available for manual installation.
Do I need accounts for each cloud drive I want to connect?You need credentials/API access for whichever storages you connect (OneDrive, Google Drive, S3, FTP/SFTP, etc.) since Alist just acts as a unified frontend for them.
Does it support every cloud drive equally well?Not stated explicitly, but the huge storage list (20+ providers from OneDrive to Terabox to SMB) suggests varying levels of maturity per backend; README does not detail per-provider limitations.
What platforms can I run the server on?It runs as a Linux server (commonly via Docker), with a web UI accessible from any browser.
Can I password-protect or restrict access to my files?Yes, Alist supports protected routes with password protection and authentication, and you can allow or restrict visitor uploads per folder.
Can I preview files without downloading them?Yes, it supports preview for images (gallery mode), video/audio with lyrics and subtitles, office documents (docx, pptx, xlsx), PDFs, markdown, and plain text/code, plus rendered README.md previews.
Can I move or copy files between two different cloud storages?Yes, Alist lets you copy files between two different storage backends directly through its interface.
Does it support WebDAV so other apps can mount it as a drive?Yes, Alist exposes a WebDAV endpoint, letting storages like OneDrive/SharePoint be accessed via WebDAV even without using their native APIs.
Can visitors upload files to my Alist instance?Yes, you can enable web upload for visitors, along with delete, mkdir, rename, move, and copy operations, controlled via permissions.
What are similar projects?rclone, sftpgo, filestash, OpenList, copyparty, cloudreve, minio, puter
Creator
AlistGo
Size
6.7 MB
Stars
50.3K
Age
5y
Commits · 90 Days