![OpenList]()
OpenList
Stack
File list that puts your cloud drives and storage behind one web UI and WebDAV server, from OneDrive, Google Drive, Dropbox and S3 to SMB, FTP and local folders, with previews, share links and offline downloads. Source: https://github.com/OpenListTeam/OpenList
Image details
Source details
Configuration
TypeComposelinuxopenlistteam/openlist:latest${OPENLIST_PORT:-5244}:5244/opt/openlist/data : openlist-data/opt/openlist/files : openlist-filesOPENLIST_PORT=5244unless-stoppedTemplate by NotAFlightRisk·Source
Report issueNotes
http://<your-host>:5244 (or whichever port you picked) and the setup page asks for an admin username and password. Whoever gets there first owns it, so do it straight away. Nothing's listed until you add a storage, from Manage at the bottom of the page, then Storages --> Add: pick a cloud drive, or Local with root folder /opt/openlist/files for files kept in the openlist-files volume. Settings, users and the database live in openlist-data. WebDAV is at /dav with the same login, but read-only until you tick WebDAV manage on your user under Manage --> Users. Logins are only kept in memory, so a restart or update signs everyone out.The logo, favicon and PDF and ePub viewers load from res.oplist.org, and Office files go through Microsoft's or Google's viewer, which only works for files they can reach (change it under Settings --> Preview). Docs: doc.oplist.orgStandalone Install
Select an install method, to see config/commands for deploying OpenList
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select OpenList, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
services:
openlist:
image: openlistteam/openlist:latest
restart: unless-stopped
user: "0:0"
ports:
- "${OPENLIST_PORT:-5244}:5244"
volumes:
- openlist-data:/opt/openlist/data
- openlist-files:/opt/openlist/files
volumes:
openlist-data:
openlist-files:
Or deploy it directly from the source:
git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/openlist/compose.yml up -dMore install options in our documentation, or see OpenListTeam/OpenList for app-specific guidance.
OpenList is a resilient, long-term governance, community-driven fork of AList — built to defend open source against trust-based attacks.
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:
- OpenList has no official association with any third-party derivative projects.
- All software, code, and services of this project are maintained by the OpenList Team and are freely available on GitHub.
- Project documentation and API services primarily rely on charitable resources provided by Cloudflare. There are currently no paid plans or commercial deployments, and the use of existing features does not involve any costs.
We respect the community's rights to free use and derivative development, but we also strongly urge downstream projects:
- Should not use the "OpenList" name for impersonation promotion or commercial gain;
- Must not distribute OpenList-based code in a closed-source manner or violate AGPL license terms.
To better maintain healthy ecosystem development, we recommend:
- Clearly indicate the project source and choose appropriate open-source licenses in accordance with the open-source spirit;
- If involving commercial use, please avoid using "OpenList" or any confusing naming as the project name;
- If you need to use materials located under OpenListTeam/Logo, you may modify and use them under compliance with the agreement.
Thank you for your support and understanding of the OpenList project.
Features
- x Multiple storages
- x Easy to deploy and out-of-the-box
- x File preview (PDF, markdown, code, plain text, ...)
- x Image preview in gallery mode
- x Video and audio preview, support lyrics and subtitles
- x Office documents preview (docx, pptx, xlsx, ...)
- x
README.mdpreview rendering - x File permalink copy and direct file download
- x Dark mode
- x I18n
- x Protected routes (password protection and authentication)
- x WebDAV
- x Docker Deploy
- x Cloudflare Workers proxy
- x File/Folder package download
- x Web upload(Can allow visitors to upload), delete, mkdir, rename, move and copy
- x Offline download
- x Copy files between two storage
- x Multi-thread downloading acceleration for single-thread download/stream
Document
Demo
- 🌎 Global Demo
- 🇨🇳 CN Demo
Discussion
Please refer to Discussions for raising general questions, Issues is for bug reports and feature requests only.Sponsor
Donors
Thanks to the following donors for their generous support:- HisAtri
- 爱发电用户7jTh
- suka
License
TheOpenList is open-source software licensed under the AGPL-3.0 license.Disclaimer
- This project is a free and open-source software designed to facilitate file sharing via net disks, primarily intended to support the downloading and learning of the Go programming language.
- Please comply with all applicable laws and regulations when using this software. Any form of misuse is strictly prohibited.
- The software is based on official SDKs or APIs without any modification, disruption, or interference with their behavior.
- It only performs HTTP 302 redirects or traffic forwarding, and does not intercept, store, or tamper with any user data.
- This project is not affiliated with any official platform or service provider.
- The software is provided "as is", without any warranties of any kind, either express or implied, including but not limited to warranties of merchantability or fitness for a particular purpose.
- The maintainers are not liable for any direct or indirect damages arising from the use of, or inability to use, this software.
- You are solely responsible for any risks associated with using this software, including but not limited to account bans or download speed limitations.
- This project is licensed under the AGPL-3.0 License. Please see the LICENSE file for details.
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:
Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Image won't pull
Test the pull directly on the host: docker pull openlistteam/openlist:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7, arm/v6, 386, ppc64le, riscv64, loong64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on OpenListTeam/OpenList
- Template not working: Open an issue on NotAFlightRisk/portainer-templates-extras
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
OpenList is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.
The app image
An image is the app packed up ready to go, everything OpenList needs bundled into one download. This template pulls openlistteam/openlist:latest, which Docker fetches once (about 115 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. OpenList's comes from Docker Hub, published by openlistteam.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v4.2.9-aio. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, 386, ppc64le, riscv64, loong64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Volumes
A volume is where OpenList keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/opt/openlist/datakept in theopenlist-datavolume Docker manages/opt/openlist/fileskept in theopenlist-filesvolume Docker manages
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. OpenList takes 1 of them, all with defaults you can leave alone or tweak:
OPENLIST_PORT, defaults to5244. Host port for the web UI
Restart policy
The restart policy here is unless-stopped, so Docker restarts OpenList after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so OpenList sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container openlist. That's what you'll spot in the containers list and use in commands like docker logs openlist.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
OpenList is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set OpenList up. Add the template list to Portainer once, then deploying OpenList is a click rather than a wall of config.