OpenList README

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

logo

OpenList is a resilient, long-term governance, community-driven fork of AList — built to defend open source against trust-based attacks.

latest version License Build status latest version

discussions Downloads


Disclaimer

OpenList is an open-source project independently maintained by the OpenList Team, following the AGPL-3.0 license and committed to maintaining complete code openness and modification transparency.

We have noticed the emergence of some third-party projects in the community with names similar to this project, such as OpenListApp/OpenListApp, as well as some paid proprietary software using the same or similar naming. To avoid user confusion, we hereby declare:

We respect the community's rights to free use and derivative development, but we also strongly urge downstream projects:

To better maintain healthy ecosystem development, we recommend:

Thank you for your support and understanding of the OpenList project.

Features

Document

Demo

Discussion

Please refer to Discussions for raising general questions, Issues is for bug reports and feature requests only.

Sponsor

VPS.Town

Donors

Thanks to the following donors for their generous support:

License

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

Disclaimer

Contact Us

Contributors

We sincerely thank the author Xhofe of the original project AlistGo/alist and all other contributors.

Thanks goes to these wonderful people:

Contributors

OpenList (OpenListTeam/OpenList)

s3
Searching Database…

25.1K ·GitHub
What is this?OpenList is a self-hosted file-listing and sharing server, built as a community-driven fork of AList, that lets you browse, preview, and share files from dozens of cloud storage providers through one unified web interface.
Is this a brand-new project or just a patched version of AList?It is a full independent fork maintained by the OpenList Team under AGPL-3.0, created in response to trust issues around the original AList project, not a plugin or wrapper on top of AList.
How do I get it running?The project supports easy Docker deployment with an official Docker image and docker-compose, described as 'easy to deploy and out-of-the-box'; you can also build it from the Go source.
What do I need to connect my cloud drives?For each storage you add (Aliyundrive, GoogleDrive, OneDrive, BaiduNetdisk, S3, WebDAV, etc.) you need the respective account credentials or API tokens; the project itself just needs Docker or a Go build environment to run.
Does it modify or intercept the files from my cloud drives?No — it only forwards or redirects traffic from the official storage SDKs/APIs without altering, storing, or tampering with any user data, so any account bans or speed limits from the underlying service are your own risk.
Where does OpenList run?It runs as a self-hosted server, most commonly deployed via Docker on Linux, and is accessed through a web browser (with WebDAV support too).
Can I use the OpenList name or code in my own paid product?It is AGPL-3.0 licensed, so you can self-host and modify it freely, but you must not distribute closed-source derivatives or use the 'OpenList' name for commercial or impersonation purposes.
How many storage providers does it support?Over 30, including Aliyundrive, GoogleDrive, OneDrive, S3, WebDAV, PikPak, BaiduNetdisk, Dropbox, Mega.nz, GitHub, and many Chinese net-disk services like 115, Quark, and Terabox.
Can files be previewed without downloading them?Yes — it supports in-browser preview for images, video/audio with lyrics and subtitles, Office documents, PDFs, markdown, code, and rendered README.md files.
Why was OpenList created instead of just using AList?It was forked to protect the project's open-source governance after what the team calls 'trust-based attacks' on the original AList, ensuring code openness and modification transparency stay community-controlled.
Can visitors upload or manage files themselves?Yes, if the owner enables it — visitors can be allowed to upload, delete, rename, move, copy files and create folders, and offline downloads and cross-storage copying are also supported.
What are similar projects?alist, cloudreve, sftpgo, filestash, LinkSwift, rclone, tvbox, zfile
Size
9.5 MB
Stars
25.1K
Age
1y
Commits · 90 Days