[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-961":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":20,"compositeScore":21,"rankGlobal":10,"rankLanguage":10,"license":22,"archived":23,"fork":23,"defaultBranch":24,"hasWiki":23,"hasPages":23,"topics":25,"createdAt":10,"pushedAt":10,"updatedAt":33,"readmeContent":34,"aiSummary":35,"trendingCount":16,"starSnapshotCount":16,"syncStatus":36,"lastSyncTime":37,"discoverSource":38},961,"copyparty","9001\u002Fcopyparty","9001","Portable file server with accelerated resumable uploads, dedup, WebDAV, SFTP, FTP, TFTP, zeroconf, media indexer, thumbnails++ all in one file","",null,"Python",45183,1842,142,229,0,7,73,388,44,113.8,"MIT License",false,"hovudstraum",[5,26,27,28,29,30,31,32],"file-server","file-sharing","file-upload-server","ftp-server","nas-frontend","tftp-server","webdav-server","2026-06-12 04:00:06","\u003Cimg src=\"https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fraw\u002Fhovudstraum\u002Fdocs\u002Flogo.svg\" width=\"250\" align=\"right\"\u002F>\n\n### 💾🎉 copyparty\n\nturn almost any device into a file server with resumable uploads\u002Fdownloads using [*any*](#browser-support) web browser\n\n* server only needs Python (2 or 3), all dependencies optional\n* 🔌 protocols: [http(s)](#the-browser) \u002F\u002F [webdav](#webdav-server) \u002F\u002F [sftp](#sftp-server) \u002F\u002F [ftp(s)](#ftp-server) \u002F\u002F [tftp](#tftp-server) \u002F\u002F [smb\u002Fcifs](#smb-server)\n* 📱 [android app](#android-app) \u002F\u002F [iPhone shortcuts](#ios-shortcuts)\n\n👉 **[Get started](#quickstart)!** or visit the **[read-only demo server](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002F)** 👀 running on a nuc in my basement\n\n📷 **screenshots:** [browser](#the-browser) \u002F\u002F [upload](#uploading) \u002F\u002F [unpost](#unpost) \u002F\u002F [thumbnails](#thumbnails) \u002F\u002F [search](#searching) \u002F\u002F [fsearch](#file-search) \u002F\u002F [zip-DL](#zip-downloads) \u002F\u002F [md-viewer](#markdown-viewer)\n\n🎬 **videos:** [upload](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002Fpics-vids\u002Fup2k.webm) \u002F\u002F [cli-upload](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002Fpics-vids\u002Fu2cli.webm) \u002F\u002F [race-the-beam](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fg\u002Fnerd-stuff\u002Fcpp\u002F2024-0418-race-the-beam.webm) \u002F\u002F 👉 **[feature-showcase](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002Fshowcase-hq.webm)** ([youtube](https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=15_-hgsX2V0))\n\nbuilt in Norway 🇳🇴 with contributions from [not-norway](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fgraphs\u002Fcontributors)\n\n\n## readme toc\n\n* top\n    * [quickstart](#quickstart) - just run **[copyparty-sfx.py](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Freleases\u002Flatest\u002Fdownload\u002Fcopyparty-sfx.py)** -- that's it! 🎉\n        * [mirrors](#mirrors) - other places to download copyparty from\n        * [at home](#at-home) - make it accessible over the internet\n        * [on servers](#on-servers) - you may also want these, especially on servers\n    * [features](#features) - also see [comparison to similar software](.\u002Fdocs\u002Fversus.md)\n    * [testimonials](#testimonials) - small collection of user feedback\n* [motivations](#motivations) - project goals \u002F philosophy\n    * [notes](#notes) - general notes\n* [bugs](#bugs) - roughly sorted by chance of encounter\n    * [not my bugs](#not-my-bugs) - same order here too\n* [breaking changes](#breaking-changes) - upgrade notes\n* [FAQ](#FAQ) - \"frequently\" asked questions\n* [accounts and volumes](#accounts-and-volumes) - per-folder, per-user permissions\n    * [shadowing](#shadowing) - hiding specific subfolders\n    * [dotfiles](#dotfiles) - unix-style hidden files\u002Ffolders\n* [the browser](#the-browser) - accessing a copyparty server using a web-browser\n    * [tabs](#tabs) - the main tabs in the ui\n    * [hotkeys](#hotkeys) - the browser has the following hotkeys\n    * [navpane](#navpane) - switching between breadcrumbs or navpane\n    * [thumbnails](#thumbnails) - press `g` or `田` to toggle grid-view instead of the file listing\n    * [zip downloads](#zip-downloads) - download folders (or file selections) as `zip` or `tar` files\n    * [uploading](#uploading) - drag files\u002Ffolders into the web-browser to upload\n        * [file-search](#file-search) - dropping files into the browser also lets you see if they exist on the server\n        * [unpost](#unpost) - undo\u002Fdelete accidental uploads\n        * [self-destruct](#self-destruct) - uploads can be given a lifetime\n        * [race the beam](#race-the-beam) - download files while they're still uploading ([demo video](http:\u002F\u002Fa.ocv.me\u002Fpub\u002Fg\u002Fnerd-stuff\u002Fcpp\u002F2024-0418-race-the-beam.webm))\n        * [incoming files](#incoming-files) - the control-panel shows the ETA for all incoming files\n    * [file manager](#file-manager) - cut\u002Fpaste, rename, and delete files\u002Ffolders (if you have permission)\n    * [shares](#shares) - share a file or folder by creating a temporary link\n    * [batch rename](#batch-rename) - select some files and press `F2` to bring up the rename UI\n    * [rss feeds](#rss-feeds) - monitor a folder with your RSS reader\n    * [opds feeds](#opds-feeds) - browse and download files from your e-book reader\n    * [recent uploads](#recent-uploads) - list all recent uploads\n    * [media player](#media-player) - plays almost every audio format there is\n        * [playlists](#playlists) - create and play [m3u8](https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FM3U) playlists\n        * [creating a playlist](#creating-a-playlist) - with a standalone mediaplayer or copyparty\n        * [audio equalizer](#audio-equalizer) - and [dynamic range compressor](https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FDynamic_range_compression)\n        * [fix unreliable playback on android](#fix-unreliable-playback-on-android) - due to phone \u002F app settings\n    * [textfile viewer](#textfile-viewer) - with realtime streaming of logfiles and such ([demo](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002Flogtail\u002F))\n    * [markdown viewer](#markdown-viewer) - and there are *two* editors\n        * [markdown vars](#markdown-vars) - dynamic docs with serverside variable expansion\n    * [other tricks](#other-tricks)\n    * [searching](#searching) - search by size, date, path\u002Fname, mp3-tags, ...\n* [server config](#server-config) - using arguments or config files, or a mix of both\n    * [version-checker](#version-checker) - sleep better at night\n    * [logging](#logging) - serverlog is sent to stdout by default\n    * [zeroconf](#zeroconf) - announce enabled services on the LAN ([pic](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F215344737-0eae8d98-9496-4256-9aa8-cd2f6971810d.png))\n        * [mdns](#mdns) - LAN domain-name and feature announcer\n        * [ssdp](#ssdp) - windows-explorer announcer\n    * [qr-code](#qr-code) - print a qr-code [(screenshot)](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F194728533-6f00849b-c6ac-43c6-9359-83e454d11e00.png) for quick access\n    * [ftp server](#ftp-server) - an FTP server can be started using `--ftp 3921`\n    * [sftp server](#sftp-server) - goes roughly 700 MiB\u002Fs (slower than webdav and ftp)\n    * [webdav server](#webdav-server) - with read-write support\n        * [connecting to webdav from windows](#connecting-to-webdav-from-windows) - using the GUI\n    * [tftp server](#tftp-server) - a TFTP server (read\u002Fwrite) can be started using `--tftp 3969`\n    * [smb server](#smb-server) - unsafe, slow, not recommended for wan\n    * [browser ux](#browser-ux) - tweaking the ui\n    * [opengraph](#opengraph) - discord and social-media embeds\n    * [file deduplication](#file-deduplication) - enable symlink-based upload deduplication\n    * [file indexing](#file-indexing) - enable music search, upload-undo, and better dedup\n        * [exclude-patterns](#exclude-patterns) - to save some time\n        * [filesystem guards](#filesystem-guards) - avoid traversing into other filesystems\n        * [periodic rescan](#periodic-rescan) - filesystem monitoring\n    * [upload rules](#upload-rules) - set upload rules using volflags\n    * [compress uploads](#compress-uploads) - files can be autocompressed on upload\n    * [chmod and chown](#chmod-and-chown) - per-volume filesystem-permissions and ownership\n    * [other flags](#other-flags)\n    * [descript.ion](#description) - add a description to each file in a folder\n    * [dothidden](#dothidden) - cosmetically hide specific files in a folder\n    * [thumbnail pregen](#thumbnail-pregen) - if you want to pre-generate everything on startup\n    * [database location](#database-location) - in-volume (`.hist\u002Fup2k.db`, default) or somewhere else\n    * [metadata from audio files](#metadata-from-audio-files) - set `-e2t` to index tags on upload\n        * [metadata from xattrs](#metadata-from-xattrs) - unix extended file attributes\n    * [file parser plugins](#file-parser-plugins) - provide custom parsers to index additional tags\n    * [event hooks](#event-hooks) - trigger a program on uploads, renames etc ([examples](.\u002Fbin\u002Fhooks\u002F))\n        * [zeromq](#zeromq) - event-hooks can send zeromq messages\n        * [upload events](#upload-events) - the older, more powerful approach ([examples](.\u002Fbin\u002Fmtag\u002F))\n    * [handlers](#handlers) - redefine behavior with plugins ([examples](.\u002Fbin\u002Fhandlers\u002F))\n    * [ip auth](#ip-auth) - autologin based on IP range (CIDR)\n        * [restrict to ip](#restrict-to-ip) - limit a user to certain IP ranges (CIDR)\n    * [identity providers](#identity-providers) - replace copyparty passwords with oauth and such\n        * [generic header auth](#generic-header-auth) - other ways to auth by header\n    * [user-changeable passwords](#user-changeable-passwords) - if permitted, users can change their own passwords\n    * [using the cloud as storage](#using-the-cloud-as-storage) - connecting to an aws s3 bucket and similar\n    * [hiding from google](#hiding-from-google) - tell search engines you don't wanna be indexed\n    * [themes](#themes)\n    * [complete examples](#complete-examples)\n    * [listen on port 80 and 443](#listen-on-port-80-and-443) - become a *real* webserver\n    * [reverse-proxy](#reverse-proxy) - running copyparty next to other websites\n        * [real-ip](#real-ip) - teaching copyparty how to see client IPs\n        * [reverse-proxy performance](#reverse-proxy-performance)\n    * [permanent cloudflare tunnel](#permanent-cloudflare-tunnel) - if you have a domain and want to get your copyparty online real quick\n    * [prometheus](#prometheus) - metrics\u002Fstats can be enabled\n    * [other extremely specific features](#other-extremely-specific-features) - you'll never find a use for these\n        * [custom mimetypes](#custom-mimetypes) - change the association of a file extension\n        * [GDPR compliance](#GDPR-compliance) - imagine using copyparty professionally...\n        * [feature chickenbits](#feature-chickenbits) - buggy feature? rip it out\n        * [feature beefybits](#feature-beefybits) - force-enable features with known issues on your OS\u002Fenv\n* [packages](#packages) - the party might be closer than you think\n    * [arch package](#arch-package) - `pacman -S copyparty` (in [arch linux extra](https:\u002F\u002Farchlinux.org\u002Fpackages\u002Fextra\u002Fany\u002Fcopyparty\u002F))\n    * [fedora package](#fedora-package) - does not exist yet\n    * [gentoo ::guru package](#gentoo-guru-package) - `emerge www-servers\u002Fcopyparty::guru` (in [::guru](https:\u002F\u002Fwiki.gentoo.org\u002Fwiki\u002FProject:GURU))\n    * [homebrew formulae](#homebrew-formulae) - `brew install copyparty ffmpeg`\n    * [nix package](#nix-package) - `nix profile install github:9001\u002Fcopyparty`\n    * [nixos module](#nixos-module)\n* [browser support](#browser-support) - TLDR: yes\n* [server hall of fame](#server-hall-of-fame) - unexpected things that run copyparty\n* [client examples](#client-examples) - interact with copyparty using non-browser clients\n    * [folder sync](#folder-sync) - sync folders to\u002Ffrom copyparty\n    * [mount as drive](#mount-as-drive) - a remote copyparty server as a local filesystem\n* [android app](#android-app) - upload to copyparty with one tap\n* [iOS shortcuts](#iOS-shortcuts) - there is no iPhone app, but\n* [performance](#performance) - defaults are usually fine - expect `8 GiB\u002Fs` download, `1 GiB\u002Fs` upload\n    * [client-side](#client-side) - when uploading files\n* [security](#security) - there is a [discord server](https:\u002F\u002Fdiscord.gg\u002F25J8CdTT6G) with announcements\n    * [gotchas](#gotchas) - behavior that might be unexpected\n    * [cors](#cors) - cross-site request config\n    * [filekeys](#filekeys) - prevent filename bruteforcing\n        * [dirkeys](#dirkeys) - share specific folders in a volume\n    * [password hashing](#password-hashing) - you can hash passwords\n    * [https](#https) - both HTTP and HTTPS are accepted\n* [recovering from crashes](#recovering-from-crashes)\n    * [client crashes](#client-crashes)\n        * [firefox wsod](#firefox-wsod) - firefox 87 can crash during uploads\n* [HTTP API](#HTTP-API) - see [devnotes](.\u002Fdocs\u002Fdevnotes.md#http-api)\n* [dependencies](#dependencies) - mandatory deps\n    * [optional dependencies](#optional-dependencies) - enable bonus features\n        * [dependency chickenbits](#dependency-chickenbits) - prevent loading an optional dependency\n        * [dependency unvendoring](#dependency-unvendoring) - force use of system modules\n    * [optional gpl stuff](#optional-gpl-stuff)\n* [sfx](#sfx) - the self-contained \"binary\" (recommended!)\n    * [copyparty.exe](#copypartyexe) - download [copyparty.exe](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Freleases\u002Flatest\u002Fdownload\u002Fcopyparty.exe) (win8+) or [copyparty32.exe](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Freleases\u002Flatest\u002Fdownload\u002Fcopyparty32.exe) (win7+)\n    * [zipapp](#zipapp) - another emergency alternative, [copyparty.pyz](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Freleases\u002Flatest\u002Fdownload\u002Fcopyparty.pyz)\n* [install on android](#install-on-android)\n* [install on iOS](#install-on-iOS)\n* [reporting bugs](#reporting-bugs) - ideas for context to include, and where to submit them\n* [devnotes](#devnotes) - for build instructions etc, see [.\u002Fdocs\u002Fdevnotes.md](.\u002Fdocs\u002Fdevnotes.md)\n\n\n## quickstart\n\njust run **[copyparty-sfx.py](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Freleases\u002Flatest\u002Fdownload\u002Fcopyparty-sfx.py)** -- that's it! 🎉\n\n> ℹ️ the sfx is a [self-extractor](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fissues\u002F270) which unpacks an embedded `tar.gz` into `$TEMP` -- if this looks too scary, you can use the [zipapp](#zipapp) which has slightly worse performance\n\n* or install through [pypi](https:\u002F\u002Fpypi.org\u002Fproject\u002Fcopyparty\u002F): `python3 -m pip install --user -U copyparty`\n* or if you cannot install python, you can use [copyparty.exe](#copypartyexe) instead\n* or install [on arch](#arch-package) \u002F [homebrew](#homebrew-formulae) ╱ [on NixOS](#nixos-module) ╱ [through nix](#nix-package)\n* or if you are on android, [install copyparty in termux](#install-on-android)\n* or maybe an iPhone or iPad? [install in a-Shell on iOS](#install-on-iOS)\n* or maybe you have a [synology nas \u002F dsm](.\u002Fdocs\u002Fsynology-dsm.md)\n* or if you have [uv](https:\u002F\u002Fdocs.astral.sh\u002Fuv\u002F) installed, run `uv tool run copyparty`\n* or if your computer is messed up and nothing else works, [try the pyz](#zipapp)\n* or if your OS is dead, give the [bootable flashdrive \u002F cd-rom](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fstuff\u002Fedcd001\u002Fenterprise-edition\u002F) a spin\n* or if you don't trust copyparty yet and want to isolate it a little, then...\n  * ...maybe [prisonparty](.\u002Fbin\u002Fprisonparty.sh) to create a tiny [chroot](https:\u002F\u002Fwiki.archlinux.org\u002Ftitle\u002FChroot) (very portable),\n  * ...or [bubbleparty](.\u002Fbin\u002Fbubbleparty.sh) to wrap it in [bubblewrap](https:\u002F\u002Fgithub.com\u002Fcontainers\u002Fbubblewrap) (much better)\n* or if you prefer to [use docker](.\u002Fscripts\u002Fdocker\u002F) 🐋 you can do that too\n  * docker has all deps built-in, so skip this step:\n\nenable thumbnails (images\u002Faudio\u002Fvideo), media indexing, and audio transcoding by installing some recommended deps:\n\n* **Alpine:** `apk add py3-pillow ffmpeg`\n* **Debian:** `apt install --no-install-recommends python3-pil ffmpeg`\n* **Fedora:** rpmfusion + `dnf install python3-pillow ffmpeg --allowerasing`\n* **FreeBSD:** `pkg install py311-sqlite3 py311-pillow ffmpeg`\n* **MacOS:** `port install py-Pillow ffmpeg`\n* **MacOS** (alternative): `brew install pillow ffmpeg`\n* **Windows:** `python -m pip install --user -U Pillow`\n  * install [python](https:\u002F\u002Fwww.python.org\u002Fdownloads\u002Fwindows\u002F) and [ffmpeg](#optional-dependencies) manually; do not use `winget` or `Microsoft Store` (it breaks $PATH)\n  * copyparty.exe comes with `Pillow` and only needs [ffmpeg](#optional-dependencies) for mediatags\u002Fvideothumbs\n* see [optional dependencies](#optional-dependencies) to enable even more features\n\nrunning copyparty without arguments (for example doubleclicking it on Windows) will give everyone read\u002Fwrite access to the current folder; you may want [accounts and volumes](#accounts-and-volumes)\n\nor see [some usage examples](#complete-examples) for inspiration, or the [complete windows example](.\u002Fdocs\u002Fexamples\u002Fwindows.md)\n\nsome recommended options:\n* `-e2dsa` enables general [file indexing](#file-indexing)\n* `-e2ts` enables audio metadata indexing (needs either FFprobe or Mutagen)\n* `-v \u002Fmnt\u002Fmusic:\u002Fmusic:r:rw,foo -a foo:bar` shares `\u002Fmnt\u002Fmusic` as `\u002Fmusic`, `r`eadable by anyone, and read-write for user `foo`, password `bar`\n  * replace `:r:rw,foo` with `:r,foo` to only make the folder readable by `foo` and nobody else\n  * see [accounts and volumes](#accounts-and-volumes) (or [`--help-accounts`](https:\u002F\u002Fcopyparty.eu\u002Fcli\u002F#accounts-help-page)) for the syntax and other permissions\n\n\n### mirrors\n\nother places to download copyparty from  (non-github links):\n\n* https:\u002F\u002Fcopyparty.eu\u002F (hetzner, finland, official mirror):\n  * https:\u002F\u002Fcopyparty.eu\u002Fpy = https:\u002F\u002Fcopyparty.eu\u002Fcopyparty-sfx.py = the sfx\n  * https:\u002F\u002Fcopyparty.eu\u002Fen = https:\u002F\u002Fcopyparty.eu\u002Fcopyparty-en.py = the english-only sfx\n  * https:\u002F\u002Fcopyparty.eu\u002Fpyz = https:\u002F\u002Fcopyparty.eu\u002Fcopyparty.pyz = the zipapp\n  * https:\u002F\u002Fcopyparty.eu\u002Fenz = https:\u002F\u002Fcopyparty.eu\u002Fcopyparty-en.pyz = the enterprise pyz\n  * https:\u002F\u002Fcopyparty.eu\u002Fcli = online cli helptext\n\n\n### at home\n\nmake it accessible over the internet  by starting a [cloudflare quicktunnel](https:\u002F\u002Fdevelopers.cloudflare.com\u002Fcloudflare-one\u002Fconnections\u002Fconnect-networks\u002Fdo-more-with-tunnels\u002Ftrycloudflare\u002F) like so:\n\nfirst download [cloudflared](https:\u002F\u002Fdevelopers.cloudflare.com\u002Fcloudflare-one\u002Fconnections\u002Fconnect-networks\u002Fdownloads\u002F) and then start the tunnel with `cloudflared tunnel --url http:\u002F\u002F127.0.0.1:3923`\n\nas the tunnel starts, it will show a URL which you can share to let anyone browse your stash or upload files to you\n\nbut if you have a domain, then you probably want to skip the random autogenerated URL and instead make a [permanent cloudflare tunnel](#permanent-cloudflare-tunnel)\n\nsince people will be connecting through cloudflare, run copyparty with `--xff-hdr cf-connecting-ip` to detect client IPs correctly\n\n\n### on servers\n\nyou may also want these, especially on servers:\n\n* [contrib\u002Fsystemd\u002Fcopyparty.service](contrib\u002Fsystemd\u002Fcopyparty.service) to run copyparty as a systemd service (see guide inside)\n* [contrib\u002Fsystemd\u002Fprisonparty.service](contrib\u002Fsystemd\u002Fprisonparty.service) to run it in a chroot (for extra security)\n* [contrib\u002Fpodman-systemd\u002F](contrib\u002Fpodman-systemd\u002F) to run copyparty in a Podman container as a systemd service (see guide inside)\n* [contrib\u002Fopenrc\u002Fcopyparty](contrib\u002Fopenrc\u002Fcopyparty) to run copyparty on Alpine \u002F Gentoo\n* [contrib\u002Frc\u002Fcopyparty](contrib\u002Frc\u002Fcopyparty) to run copyparty on FreeBSD\n* [nixos module](#nixos-module) to run copyparty on NixOS hosts\n* [contrib\u002Fnginx\u002Fcopyparty.conf](contrib\u002Fnginx\u002Fcopyparty.conf) to [reverse-proxy](#reverse-proxy) behind nginx (for better https)\n\nand remember to open the ports you want; here's a complete example including every feature copyparty has to offer:\n```\nfirewall-cmd --permanent --add-port={80,443,3921,3922,3923,3945,3990}\u002Ftcp  # --zone=libvirt\nfirewall-cmd --permanent --add-port=12000-12099\u002Ftcp  # --zone=libvirt\nfirewall-cmd --permanent --add-port={69,1900,3969,5353}\u002Fudp  # --zone=libvirt\nfirewall-cmd --reload\n```\n(69:tftp, 1900:ssdp, 3921:ftp, 3922:sftp, 3923:http\u002Fhttps, 3945:smb, 3969:tftp, 3990:ftps, 5353:mdns, 12000:passive-ftp)\n\n\n## features\n\nalso see [comparison to similar software](.\u002Fdocs\u002Fversus.md)\n\n* backend stuff\n  * ☑ IPv6 + unix-sockets\n  * ☑ [multiprocessing](#performance) (actual multithreading)\n  * ☑ volumes (mountpoints)\n  * ☑ [accounts](#accounts-and-volumes)\n  * ☑ [ftp server](#ftp-server)\n  * ☑ [tftp server](#tftp-server)\n  * ☑ [webdav server](#webdav-server)\n  * ☑ [smb\u002Fcifs server](#smb-server)\n  * ☑ [qr-code](#qr-code) for quick access\n  * ☑ [upnp \u002F zeroconf \u002F mdns \u002F ssdp](#zeroconf)\n  * ☑ [event hooks](#event-hooks) \u002F script runner\n  * ☑ [reverse-proxy support](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty#reverse-proxy)\n  * ☑ cross-platform (Windows, Linux, Macos, Android, iOS, FreeBSD, arm32\u002Farm64, ppc64le, s390x, risc-v\u002Friscv64, SGI IRIX)\n* upload\n  * ☑ basic: plain multipart, ie6 support\n  * ☑ [up2k](#uploading): js, resumable, multithreaded\n    * **no filesize limit!** even on Cloudflare\n  * ☑ stash: simple PUT filedropper\n  * ☑ filename randomizer\n  * ☑ write-only folders\n  * ☑ [unpost](#unpost): undo\u002Fdelete accidental uploads\n  * ☑ [self-destruct](#self-destruct) (specified server-side or client-side)\n  * ☑ [race the beam](#race-the-beam) (almost like peer-to-peer)\n  * ☑ symlink\u002Fdiscard duplicates (content-matching)\n* download\n  * ☑ single files in browser\n  * ☑ [folders as zip \u002F tar files](#zip-downloads)\n  * ☑ [FUSE client](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Ftree\u002Fhovudstraum\u002Fbin#partyfusepy) (read-only)\n* browser\n  * ☑ [navpane](#navpane) (directory tree sidebar)\n  * ☑ file manager (cut\u002Fpaste, delete, [batch-rename](#batch-rename))\n  * ☑ audio player (with [OS media controls](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F215347492-b4250797-6c90-4e09-9a4c-721edf2fb15c.png) and opus\u002Fmp3 transcoding)\n    * ☑ play video files as audio (converted on server)\n    * ☑ create and play [m3u8 playlists](#playlists)\n  * ☑ image gallery with webm player\n    * ☑ and cbz manga\u002Fcomics reader\n  * ☑ [textfile browser](#textfile-viewer) with syntax highlighting\n    * ☑ realtime streaming of growing files (logfiles and such)\n  * ☑ [thumbnails](#thumbnails)\n    * ☑ ...of images using Pillow, pyvips, or FFmpeg\n    * ☑ ...of RAW images using rawpy\n    * ☑ ...of videos using FFmpeg\n    * ☑ ...of audio (spectrograms) using FFmpeg\n    * ☑ cache eviction (max-age; maybe max-size eventually)\n  * ☑ multilingual UI (english, norwegian, chinese, [add your own](.\u002Fdocs\u002Frice\u002F#translations)))\n  * ☑ SPA (browse while uploading)\n* server indexing\n  * ☑ [locate files by contents](#file-search)\n  * ☑ search by name\u002Fpath\u002Fdate\u002Fsize\n  * ☑ [search by ID3-tags etc.](#searching)\n* client support\n  * ☑ [folder sync](#folder-sync) (one-way only; full sync will never be supported)\n  * ☑ [curl-friendly](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F215322619-ea5fd606-3654-40ad-94ee-2bc058647bb2.png)\n  * ☑ [opengraph](#opengraph) (discord embeds)\n* markdown\n  * ☑ [viewer](#markdown-viewer)\n  * ☑ editor (sure why not)\n  * ☑ [variables](#markdown-vars)\n\nPS: something missing? post any crazy ideas you've got as a [feature request](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fissues\u002Fnew?assignees=9001&labels=enhancement&template=feature_request.md) or [discussion](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fdiscussions\u002Fnew?category=ideas) 🤙\n\n\n## testimonials\n\nsmall collection of user feedback\n\n`good enough`, `surprisingly correct`, `certified good software`, `just works`, `why`, `wow this is better than nextcloud`\n\n* UI просто ужасно. Если буду описывать детально не смогу удержаться в рамках приличий\n\n\n# motivations\n\nproject goals \u002F philosophy\n\n* inverse unix philosophy -- do all the things, and do an *okay* job\n  * quick drop-in service to get a lot of features in a pinch\n  * some of [the alternatives](.\u002Fdocs\u002Fversus.md) might be a better fit for you\n* run anywhere, support everything\n  * as many web-browsers and python versions as possible\n    * every browser should at least be able to browse, download, upload files\n    * be a good emergency solution for transferring stuff between ancient boxes\n  * minimal dependencies\n    * but optional dependencies adding bonus-features are ok\n    * everything being plaintext makes it possible to proofread for malicious code\n  * no preparations \u002F setup necessary, just run the sfx (which is also plaintext)\n* adaptable, malleable, hackable\n  * no build steps; modify the js\u002Fpython without needing node.js or anything like that\n\nbecoming rich is specifically *not* a motivation, but if you wanna donate then see my [github profile](https:\u002F\u002Fgithub.com\u002F9001) regarding donations for my FOSS stuff in general (also THANKS!)\n\n\n## notes\n\ngeneral notes:\n* paper-printing is affected by dark\u002Flight-mode! use lightmode for color, darkmode for grayscale\n  * because no browsers currently implement the media-query to do this properly orz\n\nbrowser-specific:\n* iPhone\u002FiPad: use Firefox to download files\n* Android-Chrome: increase \"parallel uploads\" for higher speed (android bug)\n* Android-Firefox: takes a while to select files (their fix for ☝️)\n* Desktop-Firefox: ~~may use gigabytes of RAM if your files are massive~~ *seems to be OK now*\n* Desktop-Firefox: [may stop you from unplugging USB flashdrives](https:\u002F\u002Fbugzilla.mozilla.org\u002Fshow_bug.cgi?id=1792598) until you visit `about:memory` and click `Minimize memory usage`\n\nserver-os-specific:\n* RHEL8 \u002F Rocky8: you can run copyparty using `\u002Fusr\u002Flibexec\u002Fplatform-python`\n\nserver notes:\n* pypy is supported but regular cpython is faster if you enable the database\n\n\n# bugs\n\nroughly sorted by chance of encounter\n\n* general:\n  * `--th-ff-jpg` may fix video thumbnails on some FFmpeg versions (macos, some linux)\n  * `--th-ff-swr` may fix audio thumbnails on some FFmpeg versions\n  * if the `up2k.db` (filesystem index) is on a samba-share or network disk, you'll get unpredictable behavior if the share is disconnected for a bit\n    * use `--hist` or the `hist` volflag (`-v [...]:c,hist=\u002Ftmp\u002Ffoo`) to place the db and thumbnails on a local disk instead\n    * or, if you only want to move the db (and not the thumbnails), then use `--dbpath` or the `dbpath` volflag\n  * all volumes must exist \u002F be available on startup; up2k (mtp especially) gets funky otherwise\n  * probably more, pls let me know\n\n* python 3.4 and older (including 2.7):\n  * many rare and exciting edge-cases because [python didn't handle EINTR yet](https:\u002F\u002Fpeps.python.org\u002Fpep-0475\u002F)\n    * downloads from copyparty may suddenly fail, but uploads *should* be fine\n\n* python 2.7 on Windows:\n  * cannot index non-ascii filenames with `-e2d`\n  * cannot handle filenames with mojibake\n\nif you have a new exciting bug to share, see [reporting bugs](#reporting-bugs)\n\n\n## not my bugs\n\nsame order here too\n\n* [Chrome issue 1317069](https:\u002F\u002Fbugs.chromium.org\u002Fp\u002Fchromium\u002Fissues\u002Fdetail?id=1317069) -- if you try to upload a folder which contains symlinks by dragging it into the browser, the symlinked files will not get uploaded\n\n* [Chrome issue 1352210](https:\u002F\u002Fbugs.chromium.org\u002Fp\u002Fchromium\u002Fissues\u002Fdetail?id=1352210) -- plaintext http may be faster at filehashing than https (but also extremely CPU-intensive)\n\n* [Chrome issue 383568268](https:\u002F\u002Fissues.chromium.org\u002Fissues\u002F383568268) -- filereaders in webworkers can OOM \u002F crash the browser-tab\n  * copyparty has a workaround which seems to work well enough\n\n* [Firefox issue 1790500](https:\u002F\u002Fbugzilla.mozilla.org\u002Fshow_bug.cgi?id=1790500) -- entire browser can crash after uploading ~4000 small files\n\n* Windows: Uploading from a webbrowser may fail with \"directory iterator got stuck\" due to the [max path length](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fwindows\u002Fwin32\u002Ffileio\u002Fmaximum-file-path-limitation?tabs=registry); try moving the files somewhere shorter before uploading\n\n* Android: music playback randomly stops due to [battery usage settings](#fix-unreliable-playback-on-android)\n\n* iPhones: the volume control doesn't work because [apple doesn't want it to](https:\u002F\u002Fdeveloper.apple.com\u002Flibrary\u002Farchive\u002Fdocumentation\u002FAudioVideo\u002FConceptual\u002FUsing_HTML5_Audio_Video\u002FDevice-SpecificConsiderations\u002FDevice-SpecificConsiderations.html#\u002F\u002Fapple_ref\u002Fdoc\u002Fuid\u002FTP40009523-CH5-SW11)\n  * `AudioContext` will probably never be a viable workaround as apple introduces new issues faster than they fix current ones\n\n* iPhones: music volume goes on a rollercoaster during song changes\n  * nothing I can do about it because `AudioContext` is still broken in safari\n\n* iPhones: the preload feature (in the media-player-options tab) can cause a tiny audio glitch 20sec before the end of each song, but disabling it may cause worse iOS bugs to appear instead\n  * just a hunch, but disabling preloading may cause playback to stop entirely, or possibly mess with bluetooth speakers\n  * tried to add a tooltip regarding this but looks like apple broke my tooltips\n\n* iPhones: preloaded awo files make safari log MEDIA_ERR_NETWORK errors as playback starts, but the song plays just fine so eh whatever\n  * awo, opus-weba, is apple's new take on opus support, replacing opus-caf which was technically limited to cbr opus\n\n* iPhones: preloading another awo file may cause playback to stop\n  * can be somewhat mitigated with `mp.au.play()` in `mp.onpreload` but that can hit a race condition in safari that starts playing the same audio object twice in parallel...\n\n* Windows: folders cannot be accessed if the name ends with `.`\n  * python or windows bug\n\n* Windows: msys2-python 3.8.6 occasionally throws `RuntimeError: release unlocked lock` when leaving a scoped mutex in up2k\n  * this is an msys2 bug, the regular windows edition of python is fine\n\n* VirtualBox: sqlite throws `Disk I\u002FO Error` when running in a VM and the up2k database is in a vboxsf\n  * use `--hist` or the `hist` volflag (`-v [...]:c,hist=\u002Ftmp\u002Ffoo`) to place the db and thumbnails inside the vm instead\n    * or, if you only want to move the db (and not the thumbnails), then use `--dbpath` or the `dbpath` volflag\n  * also happens on mergerfs, so put the db elsewhere\n\n* Ubuntu: dragging files from certain folders into firefox or chrome is impossible\n  * due to snap security policies -- see `snap connections firefox` for the allowlist, `removable-media` permits all of `\u002Fmnt` and `\u002Fmedia` apparently\n\n\n# breaking changes\n\nupgrade notes\n\n* `1.9.16` (2023-11-04):\n  * `--stats`\u002Fprometheus: `cpp_bans` renamed to `cpp_active_bans`, and that + `cpp_uptime` are gauges\n* `1.6.0` (2023-01-29):\n  * http-api: delete\u002Fmove is now `POST` instead of `GET`\n  * everything other than `GET` and `HEAD` must pass [cors validation](#cors)\n* `1.5.0` (2022-12-03): [new chunksize formula](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fcommit\u002F54e1c8d261df) for files larger than 128 GiB\n  * **users:** upgrade to the latest [cli uploader](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fblob\u002Fhovudstraum\u002Fbin\u002Fu2c.py) if you use that\n  * **devs:** update third-party up2k clients (if those even exist)\n\n\n# FAQ\n\n\"frequently\" asked questions\n\n* CopyParty?\n  * nope! the name is either copyparty (all-lowercase) or Copyparty -- it's [one word](https:\u002F\u002Fen.wiktionary.org\u002Fwiki\u002Fcopyparty) after all :>\n\n* what is a volflag?\n  * per-volume configuration; many (not all) global-options can be set as volflags, and most (not all) volflags can be set as global-options; [complete list of volflags](https:\u002F\u002Fcopyparty.eu\u002Fcli\u002F#flags-help-page)\n\n* what is a volume?\n  * a mapping from a URL (`\u002Fmusic\u002F`) to a folder on your server's local filesystem (`C:\\Users\\ed\\Music`) which can then be accessed through copyparty, depending on the permissions and options you set on it -- see [accounts and volumes](#accounts-and-volumes)\n\n* can I change the 🌲 spinning pine-tree loading animation?\n  * [yeah...](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Ftree\u002Fhovudstraum\u002Fdocs\u002Frice#boring-loader-spinner) :-(\n\n* is it possible to block read-access to folders unless you know the exact URL for a particular file inside?\n  * yes, using the [`g` permission](#accounts-and-volumes), see the examples there\n  * you can also do this with linux filesystem permissions; `chmod 111 music` will make it possible to access files and folders inside the `music` folder but not list the immediate contents -- also works with other software, not just copyparty\n\n* can I link someone to a password-protected volume\u002Ffile by including the password in the URL?\n  * yes, by adding `?pw=hunter2` to the end; replace `?` with `&` if there are parameters in the URL already, meaning it contains a `?` near the end\n    * if you have enabled `--usernames` then do `?pw=username:password` instead\n    * `?pw` can be disabled with `--pw-urlp=A` but this breaks support for many clients\n\n* how do I stop `.hist` folders from appearing everywhere on my HDD?\n  * by default, a `.hist` folder is created inside each volume for the filesystem index, thumbnails, audio transcodes, and markdown document history. Use the `--hist` global-option or the `hist` volflag to move it somewhere else; see [database location](#database-location)\n\n* can I make copyparty download a file to my server if I give it a URL?\n  * yes, using [hooks](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fblob\u002Fhovudstraum\u002Fbin\u002Fhooks\u002Fwget.py)\n\n* firefox refuses to connect over https, saying \"Secure Connection Failed\" or \"SEC_ERROR_BAD_SIGNATURE\", but the usual button to \"Accept the Risk and Continue\" is not shown\n  * firefox has corrupted its certstore; fix this by exiting firefox, then find and delete the file named `cert9.db` somewhere in your firefox profile folder\n\n* the server keeps saying `thank you for playing` when I try to access the website\n  * you've gotten banned for malicious traffic! if this happens by mistake, and you're running a reverse-proxy and\u002For something like cloudflare, see [real-ip](#real-ip) on how to fix this\n\n* copyparty seems to think I am using http, even though the URL is https\n  * your reverse-proxy is not sending the `X-Forwarded-Proto: https` header; this could be because your reverse-proxy itself is confused. Ensure that none of the intermediates (such as cloudflare) are terminating https before the traffic hits your entrypoint\n\n* thumbnails are broken (you get a colorful square which says the filetype instead)\n  * you need to install `FFmpeg` or `Pillow`; see [thumbnails](#thumbnails)\n\n* thumbnails are broken, specifically for photos and videos taken by iphones\n  * the [docker image](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fblob\u002Fhovudstraum\u002Fscripts\u002Fdocker) and [bootable flashdrive](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fstuff\u002Fedcd001\u002Fenterprise-edition\u002F) are not able to read heif\u002Fheic images and h265\u002FHEVC video due to [legal reasons](docs\u002Fbad-codecs.md)\n\n* thumbnails are broken (some images appear, but other files just get a blank box, and\u002For the broken-image placeholder)\n  * probably due to a reverse-proxy messing with the request URLs and stripping the query parameters (`?th=w`), so check your URL rewrite rules\n  * could also be due to incorrect caching settings in reverse-proxies and\u002For CDNs, so make sure that nothing is set to ignore the query string\n  * could also be due to misbehaving privacy-related browser extensions, so try to disable those\n\n* i want to learn python and\u002For programming and am considering looking at the copyparty source code in that occasion\n  * ```bash\n     _|  _      __   _  _|_\n    (_| (_)     | | (_)  |_\n    ```\n\n\n# accounts and volumes\n\nper-folder, per-user permissions  - if your setup is getting complex, consider making a [config file](.\u002Fdocs\u002Fexample.conf) instead of using arguments\n* much easier to manage, and you can modify the config at runtime with `systemctl reload copyparty` or more conveniently using the `[reload cfg]` button in the control-panel (if the user has `a`\u002Fadmin in any volume)\n  * changes to the `[global]` config section requires a restart to take effect\n\na quick summary can be seen using [`--help-accounts`](https:\u002F\u002Fcopyparty.eu\u002Fcli\u002F#accounts-help-page)\n\nconfiguring accounts\u002Fvolumes with arguments:\n* `-a usr:pwd` adds account `usr` with password `pwd`\n* `-v .::r` adds current-folder `.` as the webroot, `r`eadable by anyone\n  * the syntax is `-v src:dst:perm:perm:...` so local-path, url-path, and one or more permissions to set\n  * granting the same permissions to multiple accounts:  \n    `-v .::r,usr1,usr2:rw,usr3,usr4` = usr1\u002F2 read-only, 3\u002F4 read-write\n\npermissions:\n* `r` (read): browse folder contents, download files, download as zip\u002Ftar, see filekeys\u002Fdirkeys\n* `w` (write): upload files, move\u002Fcopy files *into* this folder\n* `m` (move): move files\u002Ffolders *from* this folder\n* `d` (delete): delete files\u002Ffolders\n* `.` (dots): user can ask to show dotfiles in directory listings\n* `g` (get): only download files, cannot see folder contents or zip\u002Ftar\n* `G` (upget): same as `g` except uploaders get to see their own [filekeys](#filekeys) (see `fk` in examples below)\n* `h` (html): same as `g` except folders return their index.html, and filekeys are not necessary for index.html\n* `a` (admin): can see upload time, uploader IPs, config-reload\n* `A` (\"all\"): same as `rwmda.` (read\u002Fwrite\u002Fmove\u002Fdelete\u002Fadmin\u002Fdotfiles)\n\nexamples:\n* add accounts named u1, u2, u3 with passwords p1, p2, p3: `-a u1:p1 -a u2:p2 -a u3:p3`\n* make folder `\u002Fsrv` the root of the filesystem, read-only by anyone: `-v \u002Fsrv::r`\n* make folder `\u002Fmnt\u002Fmusic` available at `\u002Fmusic`, read-only for u1 and u2, read-write for u3: `-v \u002Fmnt\u002Fmusic:music:r,u1,u2:rw,u3`\n  * unauthorized users accessing the webroot can see that the `music` folder exists, but cannot open it\n* make folder `\u002Fmnt\u002Fincoming` available at `\u002Finc`, write-only for u1, read-move for u2: `-v \u002Fmnt\u002Fincoming:inc:w,u1:rm,u2`\n  * unauthorized users accessing the webroot can see that the `inc` folder exists, but cannot open it\n  * `u1` can open the `inc` folder, but cannot see the contents, only upload new files to it\n  * `u2` can browse it and move files *from* `\u002Finc` into any folder where `u2` has write-access\n* make folder `\u002Fmnt\u002Fss` available at `\u002Fi`, read-write for u1, get-only for everyone else, and enable filekeys: `-v \u002Fmnt\u002Fss:i:rw,u1:g:c,fk=4`\n  * `c,fk=4` sets the `fk` ([filekey](#filekeys)) volflag to 4, meaning each file gets a 4-character accesskey\n  * `u1` can upload files, browse the folder, and see the generated filekeys\n  * other users cannot browse the folder, but can access the files if they have the full file URL with the filekey\n  * replacing the `g` permission with `wg` would let anonymous users upload files, but not see the required filekey to access it\n  * replacing the `g` permission with `wG` would let anonymous users upload files, receiving a working direct link in return\n\nif you want to grant access to all users who are logged in, the group `acct` will always contain all known users, so for example `-v \u002Fmnt\u002Fmusic:music:r,@acct`\n\n* to do the opposite, granting access to everyone who is NOT logged in. `*,-@acct` does the trick, for example `-v \u002Fsrv\u002Fwelcome:welcome:r,*,-@acct`\n* single users can also be subtracted from a group: `@admins,-james`\n\nanyone trying to bruteforce a password gets banned according to `--ban-pw`; default is 24h ban for 9 failed attempts in 1 hour\n\nand if you want to use config files instead of commandline args (good!) then here's the same examples as a configfile; save it as `foobar.conf` and use it like this: `python copyparty-sfx.py -c foobar.conf`\n\n* you can also `PRTY_CONFIG=foobar.conf python copyparty-sfx.py` (convenient in docker etc)\n\n```yaml\n[accounts]\n  u1: p1  # create account \"u1\" with password \"p1\"\n  u2: p2  #  (note that comments must have\n  u3: p3  #   two spaces before the # sign)\n\n[groups]\n  g1: u1, u2  # create a group\n\n[\u002F]     # this URL will be mapped to...\n  \u002Fsrv  # ...this folder on the server filesystem\n  accs:\n    r: *  # read-only for everyone, no account necessary\n\n[\u002Fmusic]       # create another volume at this URL,\n  \u002Fmnt\u002Fmusic   # which is mapped to this folder\n  accs:\n    r: u1, u2  # only these accounts can read,\n    r: @g1     # (exactly the same, just with a group instead)\n    r: @acct   # (alternatively, ALL users who are logged in)\n    rw: u3     # and only u3 can read-write\n\n[\u002Finc]\n  \u002Fmnt\u002Fincoming\n  accs:\n    w: u1   # u1 can upload but not see\u002Fdownload any files,\n    rm: u2  # u2 can browse + move files out of this volume\n\n[\u002Fi]\n  \u002Fmnt\u002Fss\n  accs:\n    rw: u1  # u1 can read-write,\n    g: *    # everyone can access files if they know the URL\n  flags:\n    fk: 4   # each file URL will have a 4-character password\n```\n\n\n## shadowing\n\nhiding specific subfolders  by mounting another volume on top of them\n\nfor example `-v \u002Fmnt::r -v \u002Fvar\u002Fempty:web\u002Fcerts:` (note: no permissions) mounts the server folder `\u002Fmnt` as the webroot, but another volume is mounted at `\u002Fweb\u002Fcerts` -- so visitors can only see the contents of `\u002Fmnt` and `\u002Fmnt\u002Fweb` (at URLs `\u002F` and `\u002Fweb`), but not `\u002Fmnt\u002Fweb\u002Fcerts` because URL `\u002Fweb\u002Fcerts` is mapped to `\u002Fvar\u002Fempty`\n\nthe example config file right above this section may explain this better; the first volume `\u002F` is mapped to `\u002Fsrv` which means http:\u002F\u002F127.0.0.1:3923\u002Fmusic would try to read `\u002Fsrv\u002Fmusic` on the server filesystem, but since there's another volume at `\u002Fmusic` mapped to `\u002Fmnt\u002Fmusic` then it'll go to `\u002Fmnt\u002Fmusic` instead\n\nso, to shadow a file\u002Ffolder, define a volume but leave out the `accs:` section\n\n> ℹ️ this also works for single files, because files can also be volumes\n\n\n## dotfiles\n\nunix-style hidden files\u002Ffolders  by starting the name with a dot\n\nanyone can access these if they know the name, but they normally don't appear in directory listings\n\na client can request to see dotfiles in directory listings if global option `-ed` is specified, or the volume has volflag `dots`, or the user has permission `.`\n\n> for [shares](#shares), the `dots` volflag is ignored\n\ndotfiles do not appear in search results unless one of the above is true, **and** the global option \u002F volflag `dotsrch` is set\n\n> even if user has permission to see dotfiles, they are default-hidden unless `--see-dots` is set, and\u002For user has enabled the `dotfiles` option in the settings tab\n\nconfig file example, where the same permission to see dotfiles is given in two different ways just for reference:\n\n```yaml\n[\u002Ffoo]\n  \u002Fsrv\u002Ffoo\n  accs:\n    r.: ed   # user \"ed\" has read-access + dot-access in this volume;\n             # dotfiles are visible in listings, but not in searches\n  flags:\n    dotsrch  # dotfiles will now appear in search results too\n    dots     # another way to let everyone see dotfiles in this vol\n```\n\n\n# the browser\n\naccessing a copyparty server using a web-browser\n\n![copyparty-browser-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F192042695-522b3ec7-6845-494a-abdb-d1c0d0e23801.png)\n\n\n## tabs\n\nthe main tabs in the ui\n* `[🔎]` [search](#searching) by size, date, path\u002Fname, mp3-tags ...\n* `[🧯]` [unpost](#unpost): undo\u002Fdelete accidental uploads\n* `[🚀]` and `[🎈]` are the [uploaders](#uploading)\n* `[📂]` mkdir: create directories\n* `[📝]` new-file: create a new textfile\n* `[📟]` send-msg: either to server-log or into textfiles if `--urlform save`\n* `[🎺]` audio-player config options\n* `[⚙️]` general client config options\n\n\n## hotkeys\n\nthe browser has the following hotkeys  (always qwerty)\n* `?` show hotkeys help\n* `B` toggle breadcrumbs \u002F [navpane](#navpane)\n* `I\u002FK` prev\u002Fnext folder\n* `M` parent folder (or unexpand current)\n* `V` toggle folders \u002F textfiles in the navpane\n* `G` toggle list \u002F [grid view](#thumbnails) -- same as `田` bottom-right\n* `T` toggle thumbnails \u002F icons\n* `ESC` close various things\n* `ctrl-K` delete selected files\u002Ffolders\n* `ctrl-X` cut selected files\u002Ffolders\n* `ctrl-C` copy selected files\u002Ffolders to clipboard\n* `ctrl-V` paste (move\u002Fcopy)\n* `Y` download selected files\n* `F2` [rename](#batch-rename) selected file\u002Ffolder\n* when a file\u002Ffolder is selected (in not-grid-view):\n  * `Up\u002FDown` move cursor\n  * shift+`Up\u002FDown` select and move cursor\n  * ctrl+`Up\u002FDown` move cursor and scroll viewport\n  * `Space` toggle file selection\n  * `Ctrl-A` toggle select all\n* when a textfile is open:\n  * `I\u002FK` prev\u002Fnext textfile\n  * `S` toggle selection of open file\n  * `M` close textfile\n* when playing audio:\n  * `J\u002FL` prev\u002Fnext song\n  * `U\u002FO` skip 10sec back\u002Fforward\n  * `0..9` jump to 0%..90%\n  * `P` play\u002Fpause (also starts playing the folder)\n  * `Y` download file\n* when viewing images \u002F playing videos:\n  * `J\u002FL, Left\u002FRight` prev\u002Fnext file\n  * `Home\u002FEnd` first\u002Flast file\n  * `F` toggle fullscreen\n  * `S` toggle selection\n  * `R` rotate clockwise (shift=ccw)\n  * `Y` download file\n  * `Esc` close viewer\n  * videos:\n    * `U\u002FO` skip 10sec back\u002Fforward\n    * `0..9` jump to 0%..90%\n    * `P\u002FK\u002FSpace` play\u002Fpause\n    * `M` mute\n    * `C` continue playing next video\n    * `V` loop entire file\n    * `[` loop range (start)\n    * `]` loop range (end)\n* when the navpane is open:\n  * `A\u002FD` adjust tree width\n* in the [grid view](#thumbnails):\n  * `S` toggle multiselect\n  * shift+`A\u002FD` zoom\n* in the markdown editor:\n  * `^s` save\n  * `^h` header\n  * `^k` autoformat table\n  * `^u` jump to next unicode character\n  * `^e` toggle editor \u002F preview\n  * `^up, ^down` jump paragraphs\n\n\n## navpane\n\nswitching between breadcrumbs or navpane\n\nclick the `🌲` or pressing the `B` hotkey to toggle between breadcrumbs path (default), or a navpane (tree-browser sidebar thing)\n\n* `[+]` and `[-]` (or hotkeys `A`\u002F`D`) adjust the size\n* `[🎯]` jumps to the currently open folder\n* `[📃]` toggles between showing folders and textfiles\n* `[📌]` shows the name of all parent folders in a docked panel\n* `[a]` toggles automatic widening as you go deeper\n* `[↵]` toggles wordwrap\n* `[👀]` show full name on hover (if wordwrap is off)\n\n\n## thumbnails\n\npress `g` or `田` to toggle grid-view instead of the file listing  and `t` toggles icons \u002F thumbnails\n* can be made default globally with `--grid` or per-volume with volflag `grid`\n* enable by adding `?imgs` to a link, or disable with `?imgs=0`\n\n![copyparty-thumbs-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F129636211-abd20fa2-a953-4366-9423-1c88ebb96ba9.png)\n\nit does static images with Pillow \u002F pyvips \u002F FFmpeg, and uses FFmpeg for video files, so you may want to `--no-thumb` or maybe just `--no-vthumb` depending on how dangerous your users are\n* pyvips is 3x faster than Pillow, Pillow is 3x faster than FFmpeg\n* disable thumbnails for specific volumes with volflag `dthumb` for all, or `dvthumb` \u002F `dathumb` \u002F `dithumb` for video\u002Faudio\u002Fimages only\n* for installing FFmpeg on windows, see [optional dependencies](#optional-dependencies)\n\naudio files are converted into spectrograms using FFmpeg unless you `--no-athumb` (and some FFmpeg builds may need `--th-ff-swr`)\n\nimages with the following names (see `--th-covers`) become the thumbnail of the folder they're in: `folder.png`, `folder.jpg`, `cover.png`, `cover.jpg`\n* the order is significant, so if both `cover.png` and `folder.jpg` exist in a folder, it will pick the first matching `--th-covers` entry (`folder.jpg`)\n* and, if you enable [file indexing](#file-indexing), it will also try those names as dotfiles (`.folder.jpg` and so), and then fallback on the first picture in the folder (if it has any pictures at all)\n\nenabling `multiselect` lets you click files to select them, and then shift-click another file for range-select\n* `multiselect` is mostly intended for phones\u002Ftablets, but the `sel` option in the `[⚙️] settings` tab is better suited for desktop use, allowing selection by CTRL-clicking and range-selection with SHIFT-click, all without affecting regular clicking\n  * the `sel` option can be made default globally with `--gsel` or per-volume with volflag `gsel`\n\nto show `\u002Ficons\u002Fexe.png` and `\u002Ficons\u002Felf.gif` as the thumbnail for all `.exe` and `.elf` files respectively, do this: `--ext-th=exe=\u002Ficons\u002Fexe.png --ext-th=elf=\u002Ficons\u002Felf.gif`\n* optionally as separate volflags for each mapping; see config file example below\n* the supported image formats are [jpg, png, gif, webp, ico](https:\u002F\u002Fdeveloper.mozilla.org\u002Fen-US\u002Fdocs\u002FWeb\u002FMedia\u002FGuides\u002FFormats\u002FImage_types)\n  * be careful with svg; chrome will crash if you have too many unique svg files showing on the same page (the limit is 250 or so) -- showing the same handful of svg files thousands of times is ok however\n\nnote:\n* heif\u002Fheifs\u002Fheic\u002Fheics images usually require the `libvips` [optional dependency](#optional-dependencies) but this is not possible with the docker-images due to [legal reasons](docs\u002Fbad-codecs.md)\n* if you do not want thumbnails to be generated on-the-fly, and instead wish to generate all of them on server startup, then see [thumbnail pregen](#thumbnail-pregen)\n\nconfig file example:\n\n```yaml\n[global]\n  no-thumb   # disable ALL thumbnails and audio transcoding\n  no-vthumb  # only disable video thumbnails\n\n[\u002Fmusic]\n  \u002Fmnt\u002Fnas\u002Fmusic\n  accs:\n    r: *     # everyone can read\n  flags:\n    dthumb   # disable ALL thumbnails and audio transcoding\n    dvthumb  # only disable video thumbnails\n    ext-th:  exe=\u002Fico\u002Fexe.png  # \u002Fico\u002Fexe.png is the thumbnail of *.exe\n    ext-th:  elf=\u002Fico\u002Felf.gif  # ...and \u002Fico\u002Felf.gif is used for *.elf\n    th-covers:  folder.png,folder.jpg,cover.png,cover.jpg  # the default\n```\n\n\n## zip downloads\n\ndownload folders (or file selections) as `zip` or `tar` files\n\nselect which type of archive you want in the `[⚙️] config` tab:\n\n| name | url-suffix | description |\n|--|--|--|\n| `tar` | `?tar` | plain gnutar, works great with `curl \\| tar -xv` |\n| `pax` | `?tar=pax` | pax-format tar, futureproof, not as fast |\n| `tgz` | `?tar=gz` | gzip compressed gnu-tar (slow), for `curl \\| tar -xvz` |\n| `txz` | `?tar=xz` | gnu-tar with xz \u002F lzma compression (v.slow) |\n| `zip` | `?zip` | works everywhere, glitchy filenames on win7 and older |\n| `zip_dos` | `?zip=dos` | traditional cp437 (no unicode) to fix glitchy filenames |\n| `zip_crc` | `?zip=crc` | cp437 with crc32 computed early for truly ancient software |\n\n* gzip default level is `3` (0=fast, 9=best), change with `?tar=gz:9`\n* xz default level is `1` (0=fast, 9=best), change with `?tar=xz:9`\n* bz2 default level is `2` (1=fast, 9=best), change with `?tar=bz2:9`\n* hidden files ([dotfiles](#dotfiles)) are excluded unless account is allowed to list them\n  * `up2k.db` and `dir.txt` is always excluded\n* bsdtar supports streaming unzipping: `curl foo?zip | bsdtar -xv`\n  * good, because copyparty's zip is faster than tar on small files\n    * but `?tar` is better for large files, especially if the total exceeds 4 GiB\n* `zip_crc` will take longer to download since the server has to read each file twice\n  * this is only to support MS-DOS PKZIP v2.04g (october 1993) and older\n    * how are you accessing copyparty actually\n\nyou can also zip a selection of files or folders by clicking them in the browser, that brings up a selection editor and zip button in the bottom right\n\n![copyparty-zipsel-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F129635374-e5136e01-470a-49b1-a762-848e8a4c9cdc.png)\n\ncool trick: download a folder by appending url-params `?tar&opus` or `?tar&mp3` to transcode all audio files (except aac|m4a|mp3|ogg|opus|wma) to opus\u002Fmp3 before they're added to the archive\n* super useful if you're 5 minutes away from takeoff and realize you don't have any music on your phone but your server only has flac files and downloading those will burn through all your data + there wouldn't be enough time anyways\n* and url-param `&nodot` skips dotfiles\u002Fdotfolders; they are included by default if your account has permission to see them\n* and url-params `&j` \u002F `&w` produce jpeg\u002Fwebm thumbnails\u002Fspectrograms instead of the original audio\u002Fvideo\u002Fimages (`&p` for audio waveforms)\n  * can also be used to pregenerate thumbnails; combine with `--th-maxage=9999999` or `--th-clean=0`\n    * but now there is also a real [thumbnail pregen](#thumbnail-pregen) so just use that\n\n\n## uploading\n\ndrag files\u002Ffolders into the web-browser to upload\n\ndragdrop is the recommended way, but you may also:\n\n* select some files (not folders) in your file explorer and press CTRL-V inside the browser window\n* use the [command-line uploader](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Ftree\u002Fhovudstraum\u002Fbin#u2cpy)\n* upload using [curl, sharex, ishare, ...](#client-examples)\n\nwhen uploading files through dragdrop or CTRL-V, this initiates an upload using `up2k`; there are two browser-based uploaders available:\n* `[🎈] bup`, the basic uploader, supports almost every browser since netscape 4.0\n* `[🚀] up2k`, the good \u002F fancy one\n\nNB: you can undo\u002Fdelete your own uploads with `[🧯]` [unpost](#unpost) (and this is also where you abort unfinished uploads, but you have to refresh the page first)\n\nup2k has several advantages:\n* you can drop folders into the browser (files are added recursively)\n* files are processed in chunks, and each chunk is checksummed\n  * uploads autoresume if they are interrupted by network issues\n  * uploads resume if you reboot your browser or pc, just upload the same files again\n  * server detects any corruption; the client reuploads affected chunks\n  * the client doesn't upload anything that already exists on the server\n  * no filesize limit, even when a proxy limits the request size (for example Cloudflare)\n* much higher speeds than ftp\u002Fscp\u002Ftarpipe on some internet connections (mainly american ones) thanks to parallel connections\n* the last-modified timestamp of the file is preserved\n\n> it is perfectly safe to restart \u002F upgrade copyparty while someone is uploading to it!  \n> all known up2k clients will resume just fine 💪\n\nsee [up2k](.\u002Fdocs\u002Fdevnotes.md#up2k) for details on how it works, or watch a [demo video](https:\u002F\u002Fa.ocv.me\u002Fpub\u002Fdemo\u002Fpics-vids\u002F#gf-0f6f5c0d)\n\n![copyparty-upload-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F129635371-48fc54ca-fa91-48e3-9b1d-ba413e4b68cb.png)\n\n**protip:** you can avoid scaring away users with [contrib\u002Fplugins\u002Fminimal-up2k.js](contrib\u002Fplugins\u002Fminimal-up2k.js) which makes it look [much simpler](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F118311195-dd6ca380-b4ef-11eb-86f3-75a3ff2e1332.png)\n\n**protip:** if you enable `favicon` in the `[⚙️] settings` tab (by typing something into the textbox), the icon in the browser tab will indicate upload progress -- also, the `[🔔]` and\u002For `[🔊]` switches enable visible and\u002For audible notifications on upload completion\n\nthe up2k UI is the epitome of polished intuitive experiences:\n* \"parallel uploads\" specifies how many chunks to upload at the same time\n* `[🏃]` analysis of other files should continue while one is uploading\n* `[🥔]` shows a simpler UI for faster uploads from slow devices\n* `[🛡️]` decides when to overwrite existing files on the server\n  * `🛡️` = never (generate a new filename instead)\n  * `🕒` = overwrite if the server-file is older\n  * `♻️` = always overwrite if the files are different\n* `[🎲]` generate random filenames during upload\n* `[🔎]` switch between upload and [file-search](#file-search) mode\n  * ignore `[🔎]` if you add files by dragging them into the browser\n\nand then there's the tabs below it,\n* `[ok]` is the files which completed successfully\n* `[ng]` is the ones that failed \u002F got rejected (already exists, ...)\n* `[done]` shows a combined list of `[ok]` and `[ng]`, chronological order\n* `[busy]` files which are currently hashing, pending-upload, or uploading\n  * plus up to 3 entries each from `[done]` and `[que]` for context\n* `[que]` is all the files that are still queued\n\nnote that since up2k has to read each file twice, `[🎈] bup` can *theoretically* be up to 2x faster in some extreme cases (files bigger than your ram, combined with an internet connection faster than the read-speed of your HDD, or if you're uploading from a cuo2duo)\n\nif you are resuming a massive upload and want to skip hashing the files which already finished, you can enable `turbo` in the `[⚙️] config` tab, but please read the tooltip on that button\n\nif the server is behind a proxy which imposes a request-size limit, you can configure up2k to sneak below the limit with server-option `--u2sz` (the default is 96 MiB to support Cloudflare)\n\nif you want to replace existing files on the server with new uploads by default, run with `--u2ow 2` (only works if users have the delete-permission, and can still be disabled with `🛡️` in the UI)\n\n\n### file-search\n\ndropping files into the browser also lets you see if they exist on the server\n\n![copyparty-fsearch-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F129635361-c79286f0-b8f1-440e-aaf4-6e929428fac9.png)\n\nwhen you drag\u002Fdrop files into the browser, you will see two dropzones: `Upload` and `Search`\n\n> on a phone? toggle the `[🔎]` switch green before tapping the big yellow Search button to select your files\n\nthe files will be hashed on the client-side, and each hash is sent to the server, which checks if that file exists somewhere\n\nfiles go into `[ok]` if they exist (and you get a link to where it is), otherwise they land in `[ng]`\n* the main reason filesearch is combined with the uploader is cause the code was too spaghetti to separate it out somewhere else, this is no longer the case but now i've warmed up to the idea too much\n\nif you have a \"wark\" (file-identifier\u002Fchecksum) then you can also search for that in the [🔎] tab by putting `w = kFpDiztbZc8Z1Lzi` in the `raw` field\n\n\n### unpost\n\nundo\u002Fdelete accidental uploads  using the `[🧯]` tab in the UI\n\n![copyparty-unpost-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F129635368-3afa6634-c20f-418c-90dc-ec411f3b3897.png)\n\nyou can unpost even if you don't have regular move\u002Fdelete access, however only for files uploaded within the past `--unpost` seconds (default 12 hours) and the server must be running with `-e2d`\n\nconfig file example:\n\n```yaml\n[global]\n  e2d            # enable up2k database (remember uploads)\n  unpost: 43200  # 12 hours (default)\n```\n\n\n### self-destruct\n\nuploads can be given a lifetime,  after which they expire \u002F self-destruct\n\nthe feature must be enabled per-volume with the `lifetime` [upload rule](#upload-rules) which sets the upper limit for how long a file gets to stay on the server\n\nclients can specify a shorter expiration time using the [up2k ui](#uploading) -- the relevant options become visible upon navigating into a folder with `lifetimes` enabled -- or by using the `life` [upload modifier](.\u002Fdocs\u002Fdevnotes.md#write)\n\nspecifying a custom expiration time client-side will affect the timespan in which unposts are permitted, so keep an eye on the estimates in the up2k ui\n\n\n### race the beam\n\ndownload files while they're still uploading ([demo video](http:\u002F\u002Fa.ocv.me\u002Fpub\u002Fg\u002Fnerd-stuff\u002Fcpp\u002F2024-0418-race-the-beam.webm))  -- it's almost like peer-to-peer\n\nrequires the file to be uploaded using up2k (which is the default drag-and-drop uploader), alternatively the command-line program\n\n\n### incoming files\n\nthe control-panel shows the ETA for all incoming files  , but only for files being uploaded into volumes where you have read-access\n\n![copyparty-cpanel-upload-eta-or8](https:\u002F\u002Fgithub.com\u002Fuser-attachments\u002Fassets\u002Ffd275ffa-698c-4fca-a307-4d2181269a6a)\n\n\n## file manager\n\ncut\u002Fpaste, rename, and delete files\u002Ffolders (if you have permission)\n\nfile selection: click somewhere on the line (not the link itself), then:\n* `space` to toggle\n* `up\u002Fdown` to move\n* `shift-up\u002Fdown` to move-and-select\n* `ctrl-shift-up\u002Fdown` to also scroll\n* shift-click another line for range-select\n\n* cut: select some files and `ctrl-x`\n* copy: select some files and `ctrl-c`\n* paste: `ctrl-v` in another folder\n* rename: `F2`\n\nyou can copy\u002Fmove files across browser tabs (cut\u002Fcopy in one tab, paste in another)\n\n\n## shares\n\nshare a file or folder by creating a temporary link\n\nwhen enabled in the server settings (`--shr`), click the bottom-right `share` button to share the folder you're currently in, or alternatively:\n* select a folder first to share that folder instead\n* select one or more files to share only those files\n\nthis feature was made with [identity providers](#identity-providers) in mind -- configure your reverseproxy to skip the IdP's access-control for a given URL prefix and use that to safely share specific files\u002Ffolders sans the usual auth checks\n\nwhen creating a share, the creator can choose any of the following options:\n\n* password-protection\n* expire after a certain time; `0` or blank means infinite\n* allow visitors to upload (if the user who creates the share has write-access)\n\nsemi-intentional limitations:\n\n* cleanup of expired shares only works when global option `e2d` is set, and\u002For at least one volume on the server has volflag `e2d`\n* only folders from the same volume are shared; if you are sharing a folder which contains other volumes, then the contents of those volumes will not be available\n* if you change [password hashing](#password-hashing) settings after creating a password-protected share, then that share will stop working\n* related to [IdP volumes being forgotten on shutdown](https:\u002F\u002Fgithub.com\u002F9001\u002Fcopyparty\u002Fblob\u002Fhovudstraum\u002Fdocs\u002Fidp.md#idp-volumes-are-forgotten-on-shutdown), any shares pointing into a user's IdP volume will be unavailable until that user makes their first request after a restart\n* no option to \"delete after first access\" because tricky\n  * when linking something to discord (for example) it'll get accessed by their scraper and that would count as a hit\n  * browsers wouldn't be able to resume a broken download unless the requester's IP gets allowlisted for X minutes (ref. tricky)\n\nspecify `--shr \u002Ffoobar` to enable this feature; a toplevel virtual folder named `foobar` is then created, and that's where all the shares will be served from\n\n* you can name it whatever, `foobar` is just an example\n* if you're using config files, put `shr: \u002Ffoobar` inside the `[global]` section instead\n\nusers can delete their own shares in the controlpanel, and a list of privileged users (`--shr-adm`) are allowed to see and\u002For delet any share on the server\n\nthe volflag `--shr-who` lets you control who can create a share from that volume, either `no` (nobody), `a` (people with admin permission), or `auth` (people who are logged in) \n\nafter a share has expired, it remains visible in the controlpanel for `--shr-rt` minutes (default is 1 day), and the owner can revive it by extending the expiration time there\n\n**security note:** using this feature does not mean that you can skip the [accounts and volumes](#accounts-and-volumes) section -- you still need to restrict access to volumes that you do not intend to share with unauthenticated users! it is not sufficient to use rules in the reverseproxy to restrict access to just the `\u002Fshare` folder.\n\n\n## batch rename\n\nselect some files and press `F2` to bring up the rename UI\n\n![batch-rename-fs8](https:\u002F\u002Fuser-images.githubusercontent.com\u002F241032\u002F128434204-eb136680-3c07-4ec7-92e0-ae86af20c241.png)\n\nquick explanation of the buttons,  \n* `[✅ apply rename]` confirms and begins renaming\n* `[❌ cancel]` aborts and closes the rename window\n* `[↺ reset]` reverts any filename changes back to the original name\n* `[decode]` does a URL-decode on the filename, fixing stuff like `&` and `%20`\n* `[advanced]` toggles advanced mode\n\nadvanced mode: rename files based on rules to decide the new names, based on the original name (regex), or based on the tags collected from the file (artist\u002Ftitle\u002F...), or a mix of both\n\nin advanced mode,  \n* `[case]` toggles case-sensitive regex\n* `regex` is the regex pattern to apply to the original filename; any files which don't match will be skipped\n* `format` is the new filename, taking values from regex capturing groups and\u002For from file tags\n  * very loosely based on foobar2000 syntax\n* `presets` lets you save rename rules for later\n\navailable functions:\n* `$lpad(text, length, pad_char)`\n* `$rpad(text, length, pad_char)`\n\ntwo counters are available; `.n.s` is the nth file in the selection, and `.n.d` the nth file in the folder, for example rename-output `file(.n.d).(ext)` gives `file5.bin`, and `beach-$lpad((.n.s),3,0).(ext)` is `beach-017.jpg` and the initial value of each counter can be set in the textboxes underneath the preset dropdown\n\nso,\n\nsay you have a file named [`meganeko - Eclipse - 07 Sirius A.mp3`](https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=-dtb0vDPruI) (absolutely fantastic album btw) and the tags are: `Album:Eclipse`, `Artist:meganeko`, `Title:Sirius A`, `tn:7`\n\nyou could use just regex to rename it:\n* `regex` = `(.*) - (.*) - ([0-9]{2}) (.*)`\n* `format` = `(3). (1) - (4)`\n* `output` = `07. meganeko - Sirius A.mp3`\n\nor you could use just tags:\n* `format` = `$lpad((tn),2,0). (artist) - (title).(ext)`\n* `output` = `7. meganeko - Sirius A.mp3`\n\nor a mix of both:\n* `regex` = ` - ([0-9]{2}) `\n* `format` = `(1). (artist) - (title).(ext)`\n* `output` = `07. meganeko - Sirius A.mp3`\n\nthe metadata keys you can use in the format field are the ones in the file-browser table header (whatever is collected with `-mte` and `-mtp`)\n\n\n## rss feeds\n\nmonitor a folder with your RSS reader  , optionally recursive\n\nmust be enabled per-volume with volflag `rss` or globally with `--rss`\n\nthe feed includes itunes metadata for use with podcast readers such as [AntennaPod](https:\u002F\u002Fantennapod.org\u002F)\n\na feed example: https:\u002F\u002Fcd.ocv.me\u002Fa\u002Fd2\u002Fd22\u002F?rss&fext=mp3\n\nurl parameters:\n\n* `pw=hunter2` for password auth\n  * if you enabled `--usernames` then do `pw=username:password` instead\n* `nopw` disables embedding the password (if provided) into item-URLs in the feed\n* `nopw=a` disables mentioning the password anywhere at all in the feed; may break some readers\n* `recursive` to also include subfolders\n* `title=foo` changes the feed title (default: folder name)\n* `fext=mp3,opus` only include mp3 and opus files (default: all)\n* `nf=30` only show the first 30 results (default: 250)\n* `sort=m` sort by mtime (file last-modified), newest first (default)\n  * `u` = upload-time; NOTE: non-uploaded files have upload-time `0`\n  * `n` = filename\n  * `a` = filesize\n  * uppercase = reverse-sort; `M` = oldest file first\n\n\n## opds feeds\n\nbrowse and download files from your e-book reader\n\nenabled with the `opds` volflag or `--opds` global option\n\nadd `?opds` to the end of the url you would like to browse, then input that in your opds client.\nfor example: `https:\u002F\u002Fcopyparty.example\u002Fbooks\u002F?opds`.\n\nto log in with a password, enter it into either of the username or password fields in your client.\n\n- if you've enabled `--usernames`, then you need to enter both username and password .\n\nnote: some clients (e.g. Moon+ Reader) will not send the password when downloading cover images, which will\ncause your ip to be banned by copyparty. to work around this, you can grant the [`g` permission](#accounts-and-volumes)\nto unauthenticated requests and enable [filekeys](#filekeys) to prevent guessing filenames. for example:\n`-vbooks:books:r,ed:g:c,fk,opds`\n\nby default, not all file types will be listed in op","copyparty是一个便携的文件服务器，支持加速断点续传、去重、WebDAV、SFTP、FTP、TFTP等多种协议。项目核心功能包括通过任何现代浏览器实现文件上传下载的断点续传，以及零配置网络服务发现，并且内置媒体索引器和缩略图生成等功能。它只需要Python环境即可运行，所有依赖项均为可选项。该项目非常适合需要快速搭建文件共享服务的场景，如个人NAS前端、临时文件交换等。其简洁的设计和强大的功能使其成为轻量级文件服务器的理想选择。",2,"2026-06-11 02:40:31","top_all"]