![Cloudreve]()
Cloudreve
Container
Cloud drive for your own files, with share links, WebDAV, previews for documents, photos and video, and offline downloads. Source: https://github.com/cloudreve/cloudreve
Image details
Source details
Configuration
TypeContainerlinuxcloudreve/cloudreve:v45212:5212/tcp/cloudreve/dataunless-stoppedTemplate by NotAFlightRisk
Report issueNotes
http://<your-host>:5212 and sign up. The first account becomes the admin, and sign-ups stay open after that, so turn them off under Admin panel --> Settings --> User session if it's just you. Open the Admin panel from the address you'll actually use, too. It offers to save that as the Site URL, and until you say yes, download and share links point at localhost. The database, settings and every uploaded file live in the volume. Docs: docs.cloudreve.orgStandalone Install
Select an install method, to see config/commands for deploying Cloudreve
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 Cloudreve, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see cloudreve/cloudreve for app-specific guidance.
Cloudreve
Self-hosted file management system with muilt-cloud support.
<img src="https://img.shields.io/github/actions/workflow/status/cloudreve/Cloudreve/test.yml?branch=master&style=flat-square"
alt="GitHub Test Workflow">
<img src="https://goreportcard.com/badge/github.com/cloudreve/Cloudreve?style=flat-square"><img src="https://img.shields.io/github/v/release/cloudreve/Cloudreve?include_prereleases&style=flat-square" /><img src="https://img.shields.io/docker/image-size/cloudreve/cloudreve?style=flat-square"/>
Homepage • Demo • Discussion • Documents • Download • Telegram Group • License
:sparkles: Features
- :cloud: Support storing files into Local storage, Remote storage, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive, S3 compatible API.
- :outboxtray: Upload/Download in directly transmission with speed limiting support.
- 💾 Integrate with Aria2 to download files offline, use multiple download nodes to share the load.
- 📚 Compress/Extract files, download files in batch.
- 💻 WebDAV support covering all storage providers.
- :zap:Drag&Drop to upload files or folders, with streaming upload processing.
- :cardfilebox: Drag & Drop to manage your files.
- :familywomangirlboy: Multi-users with multi-groups.
- :link: Create share links for files and folders with expiration date.
- :eyespeechbubble: Preview videos, images, audios, texts, Office documents, ePub files online.
- :art: Customize theme colors, dark mode, PWA application, SPA, i18n.
- :rocket: All-In-One packing, with all features out-of-the-box.
- 🌈 ... ...
:hammerandwrench: Deploy
Download the main binary for your target machine OS, CPU architecture and run it directly.# Extract Cloudreve binary
tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz
# Grant execute permission
chmod +x ./cloudreve
# Start Cloudreve
./cloudreveThe above is a minimum deploy example, you can refer to Getting started for a completed deployment.
:gear: Build
You need to haveGo >= 1.18, node.js, yarn, zip and other necessary dependencies before you can build it yourself.Clone the code
git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.gitBuild static resources
# Enter frontend sub-module
cd assets
# Install dependencies
yarn install
# Start building
yarn run build
# Delete unused map files
cd build
find . -name "*.map" -type f -delete
# Return to main folder to pack static files
cd ../../
zip -r - assets/build >assets.zipCompile
# Obtain version number, commit SHA
export COMMIT_SHA=$(git rev-parse --short HEAD)
export VERSION=$(git describe --tags)
# Compile
go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'"You can also start a quick build using
build.sh in the project root directory:./build.sh [-a] [-c] [-b] [-r]
a - Build assets
c - Build binary backend
b - Build both assets and backend
r - Cross-compilation for final release:alembic: Stacks
- Go + Gin
- React + Redux + Material-UI
:scroll: License
GPL V3Serve Cloudreve on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying cloudreve.example.com to http://cloudreve:5212
Add this to your Caddyfile
cloudreve.example.com {
reverse_proxy http://cloudreve:5212
}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 cloudreve - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:5212 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :5212 - Stop the other service, or pick a different host port. In
5212:5212only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:5212. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, cloudreve can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 5212
Image won't pull
Test the pull directly on the host: docker pull cloudreve/cloudreve:v4
- "manifest unknown" means the tag no longer exists.
- "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 - 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 cloudreve --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
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 cloudreve/cloudreve
- Template not working: Open an issue on NotAFlightRisk/portainer-templates-extras
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Cloudreve runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Cloudreve needs bundled into one download. This template pulls cloudreve/cloudreve:v4, which Docker fetches once (about 546 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. Cloudreve's comes from Docker Hub, published by cloudreve.
Version tags
The bit after the colon in the image name is the version tag. This one pins v4, so every redeploy gives you that exact build until you bump it yourself.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 5212:5212 means it's reachable on port 5212 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
5212:5212
Volumes
A volume is where Cloudreve 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:
/cloudreve/dataas a volume Docker manages for you
Restart policy
The restart policy here is unless-stopped, so Docker restarts Cloudreve 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 Cloudreve 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 cloudreve. That's what you'll spot in the containers list and use in commands like docker logs cloudreve.
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
Cloudreve is open source, released under the GPL-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 Cloudreve up. Add the template list to Portainer once, then deploying Cloudreve is a click rather than a wall of config.