💾🎉 copyparty
turn almost any device into a file server with resumable uploads/downloads using any web browser
👉 Get started! or visit the read-only demo server 👀 running on a nuc in my basement
📷 screenshots: browser // upload // unpost // thumbnails // search // fsearch // zip-DL // md-viewer
🎬 videos: upload // cli-upload // race-the-beam // 👉 feature-showcase (youtube)
built in Norway 🇳🇴 with contributions from not-norway
readme toc
- top
- motivations - project goals / philosophy
- bugs - roughly sorted by chance of encounter
- breaking changes - upgrade notes
- FAQ - "frequently" asked questions
- accounts and volumes - per-folder, per-user permissions
- the browser - accessing a copyparty server using a web-browser
- tabs - the main tabs in the ui
- hotkeys - the browser has the following hotkeys
- navpane - switching between breadcrumbs or navpane
- thumbnails - press
g or 田 to toggle grid-view instead of the file listing
- zip downloads - download folders (or file selections) as
zip or tar files
- uploading - drag files/folders into the web-browser to upload
- file manager - cut/paste, rename, and delete files/folders (if you have permission)
- shares - share a file or folder by creating a temporary link
- batch rename - select some files and press
F2 to bring up the rename UI
- rss feeds - monitor a folder with your RSS reader
- opds feeds - browse and download files from your e-book reader
- recent uploads - list all recent uploads
- media player - plays almost every audio format there is
- textfile viewer - with realtime streaming of logfiles and such (demo)
- markdown viewer - and there are two editors
- other tricks
- searching - search by size, date, path/name, mp3-tags, ...
- server config - using arguments or config files, or a mix of both
- packages - the party might be closer than you think
- browser support - TLDR: yes
- server hall of fame - unexpected things that run copyparty
- client examples - interact with copyparty using non-browser clients
- android app - upload to copyparty with one tap
- iOS shortcuts - there is no iPhone app, but
- performance - defaults are usually fine - expect
8 GiB/s download, 1 GiB/s upload
- security - there is a discord server with announcements
- gotchas - behavior that might be unexpected
- csp nonce - unauthorized javascript is blocked
- cors - cross-site request config
- filekeys - prevent filename bruteforcing
- dirkeys - share specific folders in a volume
- password hashing - you can hash passwords
- https - both HTTP and HTTPS are accepted
- recovering from crashes
- HTTP API - see devnotes
- dependencies - mandatory deps
- sfx - the self-contained "binary" (recommended!)
- install on android
- install on iOS
- reporting bugs - ideas for context to include, and where to submit them
- devnotes - for build instructions etc, see ./docs/devnotes.md
quickstart
just run copyparty-sfx.py -- that's it! 🎉
ℹ️ the sfx is a self-extractor which unpacks an embedded tar.gz into $TEMP -- if this looks too scary, you can use the zipapp which has slightly worse performance
enable thumbnails (images/audio/video), media indexing, and audio transcoding by installing some recommended deps:
- Alpine:
apk add py3-pillow ffmpeg
- Debian:
apt install --no-install-recommends python3-pil ffmpeg
- Fedora: rpmfusion +
dnf install python3-pillow ffmpeg --allowerasing
- FreeBSD:
pkg install py311-sqlite3 py311-pillow ffmpeg
- MacOS:
port install py-Pillow ffmpeg
- MacOS (alternative):
brew install pillow ffmpeg
- Windows:
python -m pip install --user -U Pillow
- install python and ffmpeg manually; do not use
winget or Microsoft Store (it breaks $PATH)
- copyparty.exe comes with
Pillow and only needs ffmpeg for mediatags/videothumbs
- see optional dependencies to enable even more features
running copyparty without arguments (for example doubleclicking it on Windows) will give everyone read/write access to the current folder; you may want accounts and volumes
or see some usage examples for inspiration, or the complete windows example
some recommended options:
-e2dsa enables general file indexing-e2ts enables audio metadata indexing (needs either FFprobe or Mutagen)-v /mnt/music:/music:r:rw,foo -a foo:bar shares /mnt/music as /music, readable by anyone, and read-write for user foo, password bar
mirrors
other places to download copyparty from (non-github links):
DO NOT download from sourceforge
at home
make it accessible over the internet by starting a cloudflare quicktunnel like so:
first download cloudflared and then start the tunnel with cloudflared tunnel --url http://127.0.0.1:3923
as the tunnel starts, it will show a URL which you can share to let anyone browse your stash or upload files to you
but if you have a domain, then you probably want to skip the random autogenerated URL and instead make a permanent cloudflare tunnel
since people will be connecting through cloudflare, run copyparty with --xff-hdr cf-connecting-ip to detect client IPs correctly
on servers
you may also want these, especially on servers:
because the following environment variables are commonly used in service-scripts, they are understood by copyparty:
and remember to open the ports you want; here's a complete example including every feature copyparty has to offer:
firewall-cmd --permanent --add-port={80,443,3921,3922,3923,3945,3990}/tcp # --zone=libvirt
firewall-cmd --permanent --add-port=12000-12099/tcp # --zone=libvirt
firewall-cmd --permanent --add-port={69,1900,3969,5353}/udp # --zone=libvirt
firewall-cmd --reload
(69:tftp, 1900:ssdp, 3921:ftp, 3922:sftp, 3923:http/https, 3945:smb, 3969:tftp, 3990:ftps, 5353:mdns, 12000:passive-ftp)
features
also see comparison to similar software
copyparty 是一个便携的单文件服务器，可以把几乎任何设备变成功能齐全的文件服务器。它支持通过 HTTP(S)、WebDAV、SFTP、FTP(S)、TFTP 和 SMB 进行可断点续传的上传和下载，并内置媒体播放器、缩略图和搜索功能。