copyparty v1.20.20 "sftp is fine too" (2026-08-03)
CPython v3.14.6 on Linux64 [GCC 16.1.1 20260430]
sqlite 3.53.4*1 | jinja 3.1.6 | pyftpd 2.2.0 | tftp 0.4.0 | miko (None)
http file sharing hub v1.20.20 (2026-08-03)
options:
-h, --help show this help message and exit
general options:
-c PATH REPEATABLE: add config file (default: [])
-nc NUM max num clients (default: 1024)
-a ACCT REPEATABLE: add account, USER:PASS; example [ed:wark] (default: None)
-v VOL REPEATABLE: add volume, SRC:DST:FLAG; examples [.::r], [/mnt/nas/music:/music:r:aed], see --help-accounts
(default: None)
--grp G:N,N REPEATABLE: add group, NAME:USER1,USER2,...; example [admins:ed,foo,bar] (default: None)
--usernames require username and password for login; default is just password (default: False)
--chdir PATH change working-directory to PATH before mapping volumes (default: None)
-ed enable the ?dots url parameter / client option which allows clients to see dotfiles / hidden files (volflag=dots)
(default: False)
--urlform MODE how to handle url-form POSTs; see --help-urlform (default: print,xm)
--wintitle TXT server terminal title, for example [$ip-10.1.2.] or [$ip-] (default: cpp @ $pub)
--name TXT server name (displayed topleft in browser and in mDNS) (default: hostname)
--name-url TXT URL for server name hyperlink (displayed topleft in browser) (default: None)
--site URL public URL to assume when creating links; example: [https://example.com/] (default: )
--env-expand N expand environment-variables in config-files? [0]=no, [1]=$VAR (old scary syntax), [2]=${VAR} (new recommended
syntax); default is new-syntax with panic if old-syntax is seen (default: -1)
--mime EXT=MIME REPEATABLE: map file EXTension to MIMEtype, for example [jpg=image/jpeg] (default: None)
--mimes list default mimetype mapping and exit (default: False)
--rmagic do expensive analysis to improve accuracy of returned mimetypes; will make file-downloads, rss, and webdav slower
(volflag=rmagic) (default: False)
-j CORES num cpu-cores for uploads/downloads (0=all); keeping the default is almost always best (default: 1)
--reload-sig S reload server config when unix-signal S is received; examples: [SIGUSR1], [USR1], [10] (default: USR1)
--vc-url URL URL to check for vulnerable versions (default-disabled) (default: )
--vc-age HOURS how many hours to wait between vulnerability checks (default: 3)
--vc-sev LEVEL minimum severity to care about; one of these: low medium high critical (default: low)
--vc-exit panic and exit if current version is vulnerable (default: False)
--license show licenses and exit (default: False)
--version show versions and exit (default: False)
--versionb show version and exit (default: False)
network options:
-i IP IPs and/or unix-sockets to listen on (comma-separated list; see --help-bind). Default: all IPv4 and IPv6
(default: ::)
-p PORT ports to listen on (comma/range); ignored for unix-sockets (default: 3923)
--ll include link-local IPv4/IPv6 in mDNS replies, even if the NIC has routable IPs (breaks some mDNS clients)
(default: False)
--rproxy DEPTH which ip to associate clients with; [0]=tcp, [1]=origin (first x-fwd, unsafe), [-1]=closest-proxy,
[-2]=second-hop, [-3]=third-hop (default: 9999999)
--xff-hdr NAME if reverse-proxied, which http header to read the client's real ip from (default: x-forwarded-for)
--xf-host NAME if reverse-proxied, which http header to read the correct Host value from; this header must contain the server's
external domain name (default: x-forwarded-host)
--xf-proto NAME if reverse-proxied, which http header to read the correct protocol value from; this header must contain either
'http' or 'https' (default: x-forwarded-proto)
--xf-proto-fb T protocol to assume if the X-Forwarded-Proto header (--xf-proto) is not provided by the reverseproxy; either
'http' or 'https' (default: )
--xff-src CIDR list of trusted reverse-proxy CIDRs (comma-separated); only accept the real-ip header (--xff-hdr) and IdP headers
if the incoming connection is from an IP within either of these subnets. Specify [lan] to allow all LAN /
private / non-internet IPs. Can be disabled with [any] if you are behind cloudflare (or similar) and are using
--xff-hdr=cf-connecting-ip (or similar) (default: 127.0.0.0/8, ::1/128)
--ipa CIDR only accept connections from IP-addresses inside CIDR (comma-separated); examples: [lan] or [10.89.0.0/16,
192.168.33.0/24]
└─for performance and security, this only looks at the TCP/Network-level IP, and will NOT work behind a
reverseproxy (default: )
--ipar CIDR only accept connections from IP-addresses inside CIDR (comma-separated).
└─this is reverseproxy-compatible; reads client-IP from 'X-Forwarded-For' if possible, with TCP/Network IP as
fallback (default: )
--rp-loc PATH if reverse-proxying on a location instead of a dedicated domain/subdomain, provide the base location here;
example: [/foo/bar] (default: )
--cachectl TXT default-value of the 'Cache-Control' response-header (controls caching in webbrowsers). Default prevents repeated
downloading of the same file unless necessary (browser will ask copyparty if the file has changed). Examples:
[max-age=604869] will cache for 7 days, [no-store, max-age=0] will always redownload. (volflag=cachectl)
(default: no-cache)
--http-vary TXT value of the 'Vary' response-header; a hint for caching proxies (default: Origin, PW, Cookie)
--http-no-tcp do not listen on TCP/IP for http/https; only listen on unix-domain-sockets (default: False)
--reuseaddr set reuseaddr on listening sockets (windows-only); allows rapid restart of copyparty at the expense of being able
to accidentally start multiple instances (default: False)
--freebind allow listening on IPs which do not yet exist, for example if the network interfaces haven't finished going up.
Only makes sense for IPs other than '0.0.0.0', '127.0.0.1', '::', and '::1'. May require running as root (unless
net.ipv6.ip_nonlocal_bind) (default: False)
--wr-h-eps PATH write list of listening-on ip:port to textfile at PATH when http-servers have started (default: )
--wr-h-aon PATH write list of accessible-on ip:port to textfile at PATH when http-servers have started (default: )
--s-thead SEC socket timeout (read request header) (default: 120)
--s-tbody SEC socket timeout (read/write request/response bodies). Use 60 on fast servers (default is extremely safe). Disable
with 0 if reverse-proxied for a 2% speed boost (default: 128.0)
--s-rd-sz B socket read size in bytes (indirectly affects filesystem writes; recommendation: keep equal-to or lower-than
--iobuf) (default: 262144)
--s-wr-sz B socket write size in bytes (default: 262144)
--s-wr-slp SEC debug: socket write delay in seconds (default: 0.0)
--rsp-slp SEC debug: response delay in seconds (default: 0.0)
--rsp-jtr SEC debug: response delay, random duration 0..SEC (default: 0.0)
--list-nics debug: list detected network adapters (default: False)
--list-ips debug: list detected LAN IPs (default: False)
SSL/TLS options:
--http-only disable ssl/tls -- force plaintext (default: False)
--https-only disable plaintext -- force tls (default: False)
--cert PATH path to file containing a concatenation of TLS key and certificate chain (if --certkey is not set), or just the
certificate chain (if --certkey is set) (default: ~/.config/copyparty/cert.pem)
--certkey PATH path to file containing just the certificate key; if this is set, then --cert should only contain the certificate
chain (default: )
--ssl-ver LIST set allowed ssl/tls versions; [help] shows available versions; default is what your python version considers safe
(default: )
--ciphers LIST set allowed ssl/tls ciphers; [help] shows available ciphers (default: )
--ssl-dbg dump some tls info (default: False)
--ssl-log PATH log master secrets for later decryption in wireshark (default: )
TLS certificate generator options:
--no-crt disable automatic certificate creation (default: False)
--crt-ns N,N comma-separated list of FQDNs (domains) to add into the certificate (default: )
--crt-exact do not add wildcard entries for each --crt-ns (default: False)
--crt-noip do not add autodetected IP addresses into cert (default: False)
--crt-nolo do not add 127.0.0.1 / localhost into cert (default: False)
--crt-nohn do not add mDNS names / hostname into cert (default: False)
--crt-dir PATH where to save the CA cert (default: ~/.config/copyparty)
--crt-cdays D ca-certificate expiration time in days (default: 3650.0)
--crt-sdays D server-cert expiration time in days (default: 365.0)
--crt-cn TXT CA/server-cert common-name (default: partyco)
--crt-cnc TXT override CA name (default: --crt-cn)
--crt-cns TXT override server-cert name (default: --crt-cn cpp)
--crt-back HRS backdate in hours (default: 72.0)
--crt-alg S-N algorithm and keysize; one of these: ecdsa-256 rsa-4096 rsa-2048 (default: ecdsa-256)
IdP / identity provider / user authentication options:
--idp-h-usr HN REPEATABLE: bypass the copyparty authentication checks if the request-header HN contains a username to associate
the request with (for use with authentik/oauth/...)
WARNING: if you enable this, make sure clients are unable to specify this header themselves; must be washed away
and replaced by a reverse-proxy (default: None)
--idp-hm-usr T REPEATABLE: bypass the copyparty authentication checks if the request-header T is provided, and its value exists
in a mapping defined by this option; see --help-idp (default: None)
--idp-h-grp HN assume the request-header HN contains the groupname of the requesting user; can be referenced in config files for
group-based access control (default: )
--idp-h-key HN optional but recommended safeguard; your reverse-proxy will insert a secret header named HN into all requests,
and the other IdP headers will be ignored if this header is not present (default: )
--idp-gsep RE if there are multiple groups in --idp-h-grp, they are separated by one of the characters in RE (default: |:;+,)
--idp-chsub TXT characters to replace in usernames/groupnames; a list of pairs of characters separated by | so for example | _|
will replace spaces with _ to make configuration easier, or |%_|^_|@_| will replace %/^/@ with _ (default: )
--idp-db PATH where to store the known IdP users/groups (if you run multiple copyparty instances, make sure they use different
DBs) (default: ~/.config/copyparty/idp.db)
--idp-store N how to use --idp-db; [0] = entirely disable, [1] = write-only (effectively disabled), [2] = remember users, [3] =
remember users and groups.
NOTE: Will remember and restore the IdP-volumes of all users for all eternity if set to 2 or 3, even when user is
deleted from your IdP (default: 1)
--idp-adm U,U comma-separated list of users allowed to use /?idp (the cache management UI) (default: )
--idp-cookie S generate a session-token for IdP users which is written to cookie cppws (or cppwd if plaintext), to reduce the
load on the IdP server, lifetime S seconds.
└─note: The expiration time is a client hint only; the actual lifetime of the session-token is infinite (until
next restart with --ses-db wiped) (default: 0)
--idp-login L replace all login-buttons with a link to URL L (unless pw is in --auth-ord then both will be shown); [{dst}]
expands to url of current page (default: )
--idp-login-t T the label/text for the idp-login button (default: Login with SSO)
--idp-logout L replace all logout-buttons with a link to URL L (default: )
--auth-ord TXT controls auth precedence; examples: [pw,idp,ipu], [ipu,pw,idp], see --help-auth-ord (default: idp,ipu)
--pw-hdr NAME lowercase name of password-header (NAME: foo); WARNING: Changing this will break support for many clients
(default: pw)
--pw-urlp NAME lowercase name of password url-param (?NAME=foo); WARNING: Changing this will break support for many clients
(default: pw)
--no-bauth disable basic-authentication support; do not accept passwords from the 'Authenticate' header at all. NOTE: This
breaks support for the android app (default: False)
--bauth-last keeps basic-authentication enabled, but only as a last-resort; if a cookie is also provided then the cookie wins
(default: False)
--ses-db PATH where to store the sessions database (if you run multiple copyparty instances, make sure they use different DBs)
(default: ~/.config/copyparty/sessions.db)
--ses-len CHARS session key length; default is 144 bits ((24//4)*4*6) (default: 24)
--no-ses disable sessions; use plaintext passwords in cookies (default: False)
--grp-all NAME the name of the auto-generated group which contains every username which is known (default: acct)
--ipu CIDR=USR REPEATABLE: users with IP matching CIDR are auto-authenticated as username USR; example: [172.16.24.0/24=dave]
(default: None)
--ipr CIDR=USR REPEATABLE: username USR can only connect from an IP matching one or more CIDR (comma-sep.); example:
[192.168.123.0/24,172.16.0.0/16=dave] (default: None)
user-changeable passwords options:
--chpw allow users to change their own passwords (default: False)
--chpw-no U,U,U REPEATABLE: do not allow password-changes for this comma-separated list of usernames (default: None)
--chpw-db PATH where to store the passwords database (if you run multiple copyparty instances, make sure they use different DBs)
(default: ~/.config/copyparty/chpw.json)
--chpw-len N minimum password length (default: 8)
--chpw-v LVL verbosity of summary on config load [0] = nothing at all, [1] = number of users, [2] = list users with default-pw,
[3] = list all users (default: 2)
qr options:
--qr show QR-code on startup (default: False)
--qrs change the QR-code URL to https:// (default: False)
--qrl PATH location to include in the url, for example [priv/?pw=hunter2] (default: )
--qri PREFIX select IP which starts with PREFIX; [.] to force default IP when mDNS URL would have been used instead (default: )
--qr-fg COLOR foreground; try [0] or [-1] if the qr-code is unreadable (default: 16)
--qr-bg COLOR background (white=255) (default: 229)
--qrp CELLS padding (spec says 4 or more, but 1 is usually fine) (default: 4)
--qrz N [1]=1x, [2]=2x, [0]=auto (try [2] on broken fonts) (default: 0)
--qr-pin N sticky/pin the qr-code to always stay on-screen; [0]=disabled, [1]=with-url, [2]=just-qr (default: 0)
--qr-wait SEC wait SEC before printing the qr-code to the log (default: 0)
--qr-every SEC print the qr-code every SEC (try this with/without --qr-pin in case of issues) (default: 0)
--qr-winch SEC when --qr-pin is enabled, check for terminal size change every SEC (default: 0)
--qr-file TXT REPEATABLE: write qr-code to file.
└─To create txt or svg, TXT is Filepath:Zoom:Pad, for example [qr.txt:1:2]
└─To create png or gif, TXT is Filepath:Zoom:Pad:Foreground:Background, for example [qr.png:8:2:333333:ffcc55],
or [qr.png:8:2::ffcc55] for transparent (default: None)
--qr-stdout always display the QR-code on STDOUT in the terminal, even if -q (default: False)
--qr-stderr always display the QR-code on STDERR in the terminal, even if -q (default: False)
Zeroconf options:
-z enable all zeroconf backends (mdns, ssdp) (default: False)
--z-on NETS enable zeroconf ONLY on the comma-separated list of subnets and/or interface names/indexes
└─example: eth0, wlo1, virhost0, 192.168.123.0/24, fd00:fda::/96 (default: )
--z-off NETS disable zeroconf on the comma-separated list of subnets and/or interface names/indexes (default: )
--z-chk SEC check for network changes every SEC seconds (0=disable) (default: 10)
-zv verbose all zeroconf backends (default: False)
--mc-hop SEC rejoin multicast groups every SEC seconds (workaround for some switches/routers which cause mDNS to suddenly stop
working after some time); try [300] or [180]
└─note: can be due to firewalls; make sure UDP port 5353 is open in both directions (on clients too) (default: 0)
Zeroconf-mDNS options; also see --help-zm:
--zm announce the enabled protocols over mDNS (multicast DNS-SD) -- compatible with KDE, gnome, macOS, ... (default:
False)
--zm-on NETS enable mDNS ONLY on the comma-separated list of subnets and/or interface names/indexes (default: )
--zm-off NETS disable mDNS on the comma-separated list of subnets and/or interface names/indexes (default: )
--zm4 IPv4 only -- try this if some clients can't connect (default: False)
--zm6 IPv6 only (default: False)
--zmv verbose mdns (default: False)
--zmvv verboser mdns (default: False)
--zm-http PORT port to announce for http/webdav; [-1] = auto, [0] = disabled, [4649] = port 4649 (default: -1)
--zm-https PORT port to announce for https/webdavs; [-1] = auto, [0] = disabled, [4649] = port 4649 (default: -1)
--zm-no-pe mute parser errors (invalid incoming MDNS packets) (default: False)
--zm-nwa-1 disable workaround for avahi-bug #379 (corruption in Avahi's mDNS reflection feature) (default: False)
--zms dhf list of services to announce -- d=webdav h=http f=ftp s=smb -- lowercase=plaintext uppercase=TLS -- default: all
enabled services except http/https (Ddfs if --ftp and --smb is set, Dd otherwise) (default: )
--zm-ld PATH link a specific folder for webdav shares (default: )
--zm-lh PATH link a specific folder for http shares (default: )
--zm-lf PATH link a specific folder for ftp shares (default: )
--zm-ls PATH link a specific folder for smb shares (default: )
--zm-fqdn FQDN the domain to announce; NOTE: using anything other than .local is nonstandard and could cause problems (default:
--name.local)
--zm-mnic merge NICs which share subnets; assume that same subnet means same network (default: False)
--zm-msub merge subnets on each NIC -- always enabled for ipv6 -- reduces network load, but gnome-gvfs clients may stop
working, and clients cannot be in subnets that the server is not (default: False)
--zm-noneg disable NSEC replies -- try this if some clients don't see copyparty (default: False)
--zm-spam SEC send unsolicited announce every SEC; useful if clients have IPs in a subnet which doesn't overlap with the server,
or to avoid some firewall issues (default: 0.0)
Zeroconf-SSDP options:
--zs announce the enabled protocols over SSDP -- compatible with Windows (default: False)
--zs-on NETS enable SSDP ONLY on the comma-separated list of subnets and/or interface names/indexes (default: )
--zs-off NETS disable SSDP on the comma-separated list of subnets and/or interface names/indexes (default: )
--zsv verbose SSDP (default: False)
--zsl PATH location to include in the url (or a complete external URL), for example [priv/?pw=hunter2] (goes directly to
/priv/ with password hunter2) or [?hc=priv&pw=hunter2] (shows mounting options for /priv/ with password)
(default: /?hc)
--zsid UUID USN (device identifier) to announce (default: autogenerated)
filesystem options:
--casechk N detect and prevent CI (case-insensitive) behavior if the underlying filesystem is CI? [y] = detect and prevent,
[n] = ignore and allow, [auto] = y if CI fs detected. NOTE: y is very slow but necessary for correct WebDAV
behavior on Windows/Macos (volflag=casechk) (default: auto)
--fsnt OS which characters to allow in file/folder names; [win] = windows (not <>:|?*"\/), [mac] = macos (not :), [lin] =
linux (anything goes) (volflag=fsnt) (default: auto)
--rm-retry T/R if a file cannot be deleted because it is busy, continue trying for T seconds, retry every R seconds; disable
with 0/0 (volflag=rm_retry) (default: 0/0)
--mv-retry T/R if a file cannot be renamed because it is busy, continue trying for T seconds, retry every R seconds; disable
with 0/0 (volflag=mv_retry) (default: 0/0)
--iobuf BYTES file I/O buffer-size; if your volumes are on a network drive, try increasing to 524288 or even 4194304 (and let
me know if that improves your performance) (default: 262144)
--mtab-age SEC rebuild mountpoint cache every SEC to keep track of sparse-files support; keep low on servers with removable
media (default: 60)
share-url options:
--shr DIR toplevel virtual folder for shared files/folders, for example [/share] (default: )
--shr-db FILE database to store shares in (default: ~/.config/copyparty/shares.db)
--shr-who TXT who can create a share? [no]=nobody, [a]=admin-permission, [auth]=authenticated (volflag=shr_who) (default: auth)
--shr-adm U,U comma-separated list of users allowed to view/delete any share (default: )
--shr-rt MIN shares can be revived by their owner if they expired less than MIN minutes ago; [60]=hour, [1440]=day,
[10080]=week (default: 1440)
--shr-site URL public URL to assume when creating share-links; example: [https://example.com/] (default: --site)
--shr-v debug (default: False)
upload options:
--dotpart dotfile incomplete uploads, hiding them from clients unless -ed (default: False)
--plain-ip when avoiding filename collisions by appending the uploader's ip to the filename: append the plaintext ip instead
of salting and hashing the ip (default: False)
--up-site URL public URL to assume when creating links to uploaded files; example: [https://example.com/] (default: --site)
--put-name TXT filename for nameless uploads (when uploader doesn't provide a name); default is [put-UNIXTIME-IP.bin] (the .6f
means six decimal places) (volflag=put_name) (default: put-{now.6f}-{cip}.bin)
--put-ck ALG default checksum-hasher for PUT/WebDAV uploads: no / md5 / sha1 / sha256 / sha512 / b2 / blake2 / b2s / blake2s
(volflag=put_ck) (default: sha512)
--bup-ck ALG default checksum-hasher for bup/basic-uploader: no / md5 / sha1 / sha256 / sha512 / b2 / blake2 / b2s / blake2s
(volflag=bup_ck) (default: sha512)
--unpost SEC grace period where uploads can be deleted by the uploader, even without delete permissions; 0=disabled,
default=12h (default: 43200)
--unp-who NUM clients can undo recent uploads by using the unpost tab (requires -e2d). [0] = never allowed (disable feature),
[1] = allow if client has the same IP as the upload AND is using the same account, [2] = just check the IP, [3]
= just check account-name (volflag=unp_who) (default: 1)
--apnd-who NUM who can append to existing files? [no]=nobody, [aw]=admin+write, [dw]=delete+write, [w]=write (volflag=apnd_who)
(default: dw)
--u2abort NUM clients can abort incomplete uploads by using the unpost tab (requires -e2d). [0] = never allowed (disable
feature), [1] = allow if client has the same IP as the upload AND is using the same account, [2] = just check
the IP, [3] = just check account-name (volflag=u2abort) (default: 1)
--blank-wt SEC file write grace period (any client can write to a blank file last-modified more recently than SEC seconds ago)
(default: 300)
--reg-cap N max number of uploads to keep in memory when running without -e2d; roughly 1 MiB RAM per 600 (default: 38400)
--no-fpool disable file-handle pooling -- instead, repeatedly close and reopen files during upload (bad idea to enable this
on windows and/or cow filesystems) (default: False)
--use-fpool force file-handle pooling, even when it might be dangerous (multiprocessing, filesystems lacking sparse-files
support, ...) (default: False)
--chmod-f UGO unix file permissions to use when creating files; default is probably 644 (OS-decided), see --help-chmod.
Examples: [644] = owner-RW + all-R, [755] = owner-RWX + all-RX, [777] = full-yolo (volflag=chmod_f) (default: )
--chmod-d UGO unix file permissions to use when creating directories; see --help-chmod. Examples: [755] = owner-RW + all-R,
[2750] = setgid + owner-RW + group-R, [777] = full-yolo (volflag=chmod_d) (default: 755)
--uid N unix user-id to chown new files/folders to; default = -1 = do-not-change (volflag=uid) (default: -1)
--gid N unix group-id to chown new files/folders to; default = -1 = do-not-change (volflag=gid) (default: -1)
--wram allow uploading even if a volume is inside a ramdisk, meaning that all data will be lost on the next server
reboot (volflag=wram) (default: False)
--dedup enable symlink-based upload deduplication (volflag=dedup) (default: False)
--safe-dedup N how careful to be when deduplicating files; [1] = just verify the filesize, [50] = verify file contents have not
been altered (volflag=safededup) (default: 50)
--hardlink enable hardlink-based dedup; will fallback on symlinks when that is impossible (across filesystems)
(volflag=hardlink) (default: False)
--hardlink-only do not fallback to symlinks when a hardlink cannot be made (volflag=hardlinkonly) (default: False)
--reflink enable reflink-based dedup; will fallback on full copies when that is impossible (non-CoW filesystem)
(volflag=reflink) (default: False)
--no-dupe reject duplicate files during upload; only matches within the same volume (volflag=nodupe) (default: False)
--no-dupe-m also reject dupes when moving a file into another volume (volflag=nodupem) (default: False)
--no-clone do not use existing data on disk to satisfy dupe uploads; reduces server HDD reads in exchange for much more
network load (volflag=noclone) (default: False)
--no-snap disable snapshots -- forget unfinished uploads on shutdown; don't create .hist/up2k.snap files --
abandoned/interrupted uploads must be cleaned up manually (default: False)
--snap-wri SEC write upload state to ./hist/up2k.snap every SEC seconds; allows resuming incomplete uploads after a server crash
(default: 300)
--snap-drop MIN forget unfinished uploads after MIN minutes; impossible to resume them after that (360=6h, 1440=24h) (default:
1440.0)
--rm-partial delete the .PARTIAL file when an unfinished upload expires after --snap-drop (volflag=rm_partial) (default: False)
--u2ts TXT how to timestamp uploaded files; [c]=client-last-modified, [u]=upload-time, [fc]=force-c, [fu]=force-u
(volflag=u2ts) (default: c)
--rotf-tz TXT default timezone for the rotf upload rule; examples: [Europe/Oslo], [America/Toronto], [Antarctica/South_Pole]
(volflag=rotf_tz) (default: UTC)
--rand force randomized filenames, --nrand chars long (volflag=rand) (default: False)
--nrand NUM randomized filenames length (volflag=nrand) (default: 9)
--magic enable filetype detection on nameless uploads (volflag=magic) (default: False)
--df GiB ensure GiB free disk space by rejecting upload requests; assumes gigabytes unless a unit suffix is given: [256m],
[4], [2T] (volflag=df) (default: 0)
--sparse MiB windows-only: minimum size of incoming uploads through up2k before they are made into sparse files (default: 1)
--turbo LVL configure turbo-mode in up2k client; [-1] = forbidden/always-off, [0] = default-off and warn if enabled, [1] =
default-off, [2] = on, [3] = on and disable datecheck (default: 0)
--nosubtle N when to use a wasm-hasher instead of the browser's builtin; faster on chrome, but buggy in older chrome versions.
[0] = only when necessary (non-https), [1] = always (all browsers), [2] = always on chrome/firefox, [3] = always
on chrome, [N] = chrome-version N and newer (recommendation: 137) (default: 0)
--u2j JOBS web-client: number of file chunks to upload in parallel; 1 or 2 is good when latency is low (same-country), 2~4
for android-clients, 2~6 for cross-atlantic. Max is 6 in most browsers. Big values increase network-speed but
may reduce HDD-speed (default: 2)
--u2sz N,N,N web-client: default upload chunksize (MiB); sets min,default,max in the settings gui. Each HTTP POST will aim for
default, and never exceed max. Cloudflare max is 96. Big values are good for cross-atlantic but may increase HDD
fragmentation on some FS. Disable this optimization with [1,1,1] (default: 1,64,96)
--u2ow NUM web-client: default setting for when to replace/overwrite existing files; [0]=never, [1]=if-client-newer,
[2]=always (volflag=u2ow) (default: 0)
--u2sort TXT upload order; [s]=smallest-first, [n]=alphabetical, [fs]=force-s, [fn]=force-n -- alphabetical is a bit slower on
fiber/LAN but makes it easier to eyeball if everything went fine (default: s)
--write-uplog write POST reports to textfiles in working-directory (default: False)
general db options:
-e2d enable up2k database; this enables file search, upload-undo, improves deduplication (default: False)
-e2ds scan writable folders for new files on startup; sets -e2d (default: False)
-e2dsa scans all folders on startup; sets -e2ds (default: False)
-e2v verify file integrity; rehash all files and compare with db (default: False)
-e2vu on hash mismatch: update the database with the new hash (default: False)
-e2vp on hash mismatch: panic and quit copyparty (default: False)
--hist PATH where to store volume data (db, thumbs); default is a folder named ".hist" inside each volume (volflag=hist)
(default: )
--dbpath PATH override where the volume databases are to be placed; default is the same as --hist (volflag=dbpath) (default: )
--fika TXT list of user-actions to allow while filesystem-indexer is still busy; set blank to never interrupt indexing (old
default). [u]=uploads, [c]=filecopy, [m]=move/rename, [d]=delete. NOTE: [m] is untested/scary, and blank is
recommended if dedup enabled (default: ucd)
--no-hash PTN regex: disable hashing of matching absolute-filesystem-paths during e2ds folder scans (must be specified as one
big regex, not multiple times) (volflag=nohash) (default: )
--no-idx PTN regex: disable indexing of matching absolute-filesystem-paths during e2ds folder scan (must be specified as one
big regex, not multiple times) (volflag=noidx) (default: )
--no-dirsz do not show total recursive size of folders in listings, show inode size instead; slightly faster
(volflag=nodirsz) (default: False)
--re-dirsz if the directory-sizes in the UI are bonkers, use this along with -e2dsa to rebuild the index from scratch
(default: False)
--no-dhash disable rescan acceleration; do full database integrity check -- makes the db ~5% smaller and bootup/rescans
3~10x slower (default: False)
--re-dhash force a cache rebuild on startup; enable this once if it gets out of sync (should never be necessary) (default:
False)
--no-forget never forget indexed files, even when deleted from disk -- makes it impossible to ever upload the same file twice
-- only useful for offloading uploads to a cloud service or something (volflag=noforget) (default: False)
--forget-ip MIN remove uploader-IP from database (and make unpost impossible) MIN minutes after upload, for GDPR reasons. Default
[0] is never-forget. [1440]=day, [10080]=week, [43200]=month. (volflag=forget_ip) (default: 0)
--dbd PROFILE database durability profile; sets the tradeoff between robustness and speed, see --help-dbd (volflag=dbd)
(default: wal)
--xlink on upload: check all volumes for dupes, not just the target volume (probably buggy, not recommended)
(volflag=xlink) (default: False)
--hash-mt CORES num cpu cores to use for file hashing; set 0 or 1 for single-core hashing (default: numCores if 5 or less)
--re-maxage SEC rescan filesystem for changes every SEC seconds; 0=off (volflag=scan) (default: 0)
--db-act SEC defer any scheduled volume reindexing until SEC seconds after last db write (uploads, renames, ...) (default:
10.0)
--srch-icase case-insensitive search for all unicode characters (the default is icase for just ascii). NOTE: will make
searches much slower (around 3x), and NOTE: only applies to filenames/paths, not tags (default: False)
--srch-nfkc case-insensitive and unicode-normalization-insensitive search (NFC/NFD) for filenames/paths; slightly slower than
--srch-icase (about 15% slower / 87% as fast) (default: False)
--srch-time SEC search deadline -- terminate searches running for more than SEC seconds (default: 45)
--srch-hits N max search results to allow clients to fetch; 125 results will be shown initially (default: 7999)
--srch-excl PTN regex: exclude files from search results if the file-URL matches PTN (case-sensitive). Example:
[password|logs/[0-9]] any URL containing 'password' or 'logs/DIGIT' (volflag=srch_excl) (default: )
--dotsrch show dotfiles in search results (volflags: dotsrch | nodotsrch) (default: False)
metadata db options:
-e2t enable metadata indexing; makes it possible to search for artist/title/codec/resolution/... (default: False)
-e2ts scan newly discovered files for metadata on startup; sets -e2t (default: False)
-e2tsr delete all metadata from DB and do a full rescan; sets -e2ts (default: False)
--no-mutagen use FFprobe for tags instead; will detect more tags (default: False)
--no-mtag-ff never use FFprobe as tag reader; is probably safer (default: False)
--mtag-to SEC timeout for FFprobe tag-scan (default: 60)
--mtag-mt CORES num cpu cores to use for tag scanning (default: numCores)
--mtag-v verbose tag scanning; print errors from mtp subprocesses and such (default: False)
--mtag-vv debug mtp settings and mutagen/FFprobe parsers (default: False)
--db-xattr t,t read file xattrs as metadata tags; [a,b] reads keys a and b as tags a and b, [a=foo,b=bar] reads keys a and b as
tags foo and bar, [~~a,b] does everything except a and b, [~~] does everything. NOTE: Each tag must also be
enabled with -mte (volflag=db_xattr) (default: )
-mtm M=t,t,t REPEATABLE: add/replace metadata mapping (default: None)
-mte M,M,M tags to index/display (comma-sep.); either an entire replacement list, or add/remove stuff on the default-list
with +foo or /bar (default: .files,circle,album,.tn,artist,title,tdate,.bpm,key,.dur,.q,.vq,.aq,vc,ac,fmt,res,
.fps,ahash,vhash)
-mth M,M,M tags to hide by default (comma-sep.); assign/add/remove same as -mte (default: tdate,.vq,.aq,vc,ac,fmt,res,.fps)
-mtp M=[f,]BIN REPEATABLE: read tag M using program BIN to parse the file (default: None)
thumbnail options:
--no-thumb disable all thumbnails (volflag=dthumb) (default: False)
--no-vthumb disable video thumbnails (volflag=dvthumb) (default: False)
--no-athumb disable audio thumbnails (spectrograms) (volflag=dathumb) (default: False)
--th-size WxH thumbnail res (volflag=thsize) (default: 320x256)
--th-mt CORES num cpu cores to use for generating thumbnails (default: numCores)
--th-convt SEC convert-to-image timeout in seconds (volflag=convt) (default: 60.0)
--ac-convt SEC convert-to-audio timeout in seconds (volflag=aconvt) (default: 150.0)
--th-ram-max GB max memory usage (GiB) permitted by thumbnailer; not very accurate (default: depends-on-available-ram)
--th-crop TXT crop thumbnails to 4:3 or keep dynamic height; client can override in UI unless force. [y]=crop, [n]=nocrop,
[fy]=force-y, [fn]=force-n (volflag=crop) (default: y)
--th-x3 TXT show thumbs at 3x resolution; client can override in UI unless force. [y]=yes, [n]=no, [fy]=force-yes,
[fn]=force-no (volflag=th3x) (default: n)
--th-qv N webp/jpg thumbnail quality (10~90); higher is larger filesize and better quality (volflag=th_qv) (default: 40)
--th-qvx N jxl thumbnail quality (10~90); higher is larger filesize and better quality (volflag=th_qvx) (default: 64)
--th-dec LIBS image decoders, in order of preference (default: raw,pil,ff,vips)
--th-no-jpg disable jpg output (default: False)
--th-no-webp disable webp output (default: False)
--th-no-jxl disable jpeg-xl output (default: False)
--th-ff-jpg force jpg output for video thumbs (avoids issues on some FFmpeg builds) (default: False)
--th-ff-swr use swresample instead of soxr for audio thumbs (faster, lower accuracy, avoids issues on some FFmpeg builds)
(default: False)
--th-vips-jxl N when to allow generating jxl thumbnails with libvips; 0=never, 1=musl-mallocng, 2=always (default: 1)
--th-poke SEC activity labeling cooldown -- avoids doing keepalive pokes (updating the mtime) on thumbnail folders more often
than SEC seconds; 0=no-keepalive (default: 300)
--th-clean SEC cleanup interval; 0=disabled (default: 43200)
--th-maxage SEC max folder age -- folders which haven't been poked for longer than --th-poke seconds will get deleted every
--th-clean seconds (default: 604800)
--th-pregen F,F pregenerate thumbnails on startup; F,F is comma-separated list of formats; example: [j,jf,w,w3,wf,wf3,x,xf] NOTE:
remember to set --th-maxage 123456789 (volflag=th_pregen) (default: )
--th-pre-rl SEC while pregen is running, ratelimit the thumbnailer logger to one message every SEC seconds (only works with -j1);
set 0 to disable ratelimit (default: 30)
--th-covers N,N folder thumbnails to stat/look for; enabling -e2d will make these case-insensitive, and try them as dotfiles
(.folder.jpg), and also automatically select thumbnails for all folders that contain pics, even if none match
this pattern (volflag=th_covers) (default: folder.png,folder.jpg,cover.png,cover.jpg)
--th-spec-p N for music, do spectrograms or embedded coverart? [0]=only-art, [1]=prefer-art, [2]=only-spec (default: 1)
--th-spec-fl generate spectrograms with logarithmic frequency scale instead of linear (default: False)
--th-r-pil T,T image formats to decode using pillow (default: avif,avifs,blp,bmp,cbz,dcx,dds,dib,emf,eps,epub,fits,flc,fli,fpx,
gif,heic,heics,heif,heifs,icns,ico,im,j2p,j2k,jp2,jpeg,jpg,jpx,jxl,kra,ora,pbm,pcx,pgm,png,pnm,ppm,psd,qoi,sgi,
spi,tga,tif,tiff,webp,wmf,xbm,xpm)
--th-r-vips T,T image formats to decode using pyvips (default: 3fr,arw,avif,cr2,cr3,crw,dcr,dng,erf,exr,fit,fits,fts,gif,hdr,heic,
heics,heif,heifs,jp2,jpeg,jpg,jpx,jxl,k25,kdc,mdc,mef,mrw,nef,nii,nrw,orf,pfm,pgm,png,ppm,raf,raw,rw2,sr2,srf,
srw,svg,tif,tiff,webp,x3f)
--th-r-raw T,T image formats to decode using rawpy (if available) or libraw's dcraw_emu (default: 3fr,arw,cr2,cr3,crw,dcr,dng,
erf,k25,kdc,mdc,mef,mos,mrw,nef,nrw,orf,pef,raf,raw,rw2,sr2,srf,srw,x3f)
--th-r-ffi T,T image formats to decode using ffmpeg (default: apng,avif,avifs,bmp,cbz,dds,dib,epub,fit,fits,fts,gif,hdr,heic,
heics,heif,heifs,icns,ico,jp2,jpeg,jpg,jpx,jxl,kra,ora,pbm,pcx,pfm,pgm,png,pnm,ppm,psd,qoi,sgi,tga,tif,tiff,webp,
xbm,xpm)
--th-r-ffv T,T video formats to decode using ffmpeg (default: 3gp,asf,av1,avc,avi,flv,h264,h265,hevc,m4v,mjpeg,mjpg,mkv,mov,mp4,
mpeg,mpeg2,mpegts,mpg,mpg2,mts,nut,ogm,ogv,rm,ts,vob,webm,wmv)
--th-r-ffa T,T audio formats to decode using ffmpeg (default: aac,ac3,aif,aiff,alac,alaw,amr,apac,ape,au,bcstm,bfstm,brstm,bonk,
dfpwm,dts,flac,gsm,ilbc,it,itgz,itxz,itz,m4a,m4b,m4r,mdgz,mdxz,mdz,mka,mo3,mod,mp2,mp3,mpc,mptm,mt2,mulaw,oga,
ogg,okt,opus,ra,s3m,s3gz,s3xz,s3z,tak,tta,ulaw,wav,wma,wv,xm,xmgz,xmxz,xmz,xpk)
--th-spec-cnv T audio formats which provoke https://trac.ffmpeg.org/ticket/10797 (huge ram usage for s3xmodit spectrograms)
(default: it,itgz,itxz,itz,mdgz,mdxz,mdz,mo3,mod,s3m,s3gz,s3xz,s3z,xm,xmgz,xmxz,xmz,xpk)
--au-unpk E=F.C audio/image formats to decompress before passing to ffmpeg (default: mdz=mod.zip, mdgz=mod.gz, mdxz=mod.xz,
s3z=s3m.zip, s3gz=s3m.gz, s3xz=s3m.xz, xmz=xm.zip, xmgz=xm.gz, xmxz=xm.xz, itz=it.zip, itgz=it.gz, itxz=it.xz,
cbz=jpg.cbz, epub=jpg.epub, kra=png.kra, ora=png.ora)
transcoding options:
--q-opus KBPS target bitrate for transcoding to opus; set 0 to disable (default: 128)
--q-mp3 QUALITY target quality for transcoding to mp3, for example [192k] (CBR) or [q0] (CQ/CRF, q0=maxquality, q9=smallest); set
0 to disable (default: q2)
--allow-wav allow transcoding to wav (lossless, uncompressed) (default: False)
--allow-flac allow transcoding to flac (lossless, compressed) (default: False)
--no-caf disable transcoding to caf-opus (affects iOS v12~v17), will use mp3 instead (default: False)
--no-owa disable transcoding to webm-opus (iOS v18 and later), will use mp3 instead (default: False)
--no-acode disable audio transcoding (default: False)
--no-bacode disable batch audio transcoding by folder download (zip/tar) (default: False)
--ac-maxage SEC delete cached transcode output after SEC seconds (default: 86400)
RSS options:
enable RSS output (experimental) (volflag=rss) (default: False)
HITS default number of files to return (url-param 'nf') (default: 250)
E,E default list of file extensions to include (url-param 'fext'); blank=all (default: )
ORD default sort order (url-param 'sort'); [m]=last-modified [u]=upload-time [n]=filename [s]=filesize;
Uppercase=oldest-first. Note that upload-time is 0 for non-uploaded files (volflag=rss_sort) (default: m)
TXT title format (url-param 'rss_fmt_t') (volflag=rss_fmt_t) (default: {fname})
TXT description format (url-param 'rss_fmt_d') (volflag=rss_fmt_d) (default: {artist} - {title})
SFTP options:
--sftp PORT enable SFTP server on PORT, for example 3922 (default: 0)
--sftpv verbose (default: False)
--sftpvv verboser (default: False)
--sftp-i IP IPs to listen on (comma-separated list). Set this to override -i for this protocol (default: -i)
--sftp4 only listen on IPv4 (default: False)
--sftp-key U K REPEATABLE: add ssh-key K for user U (username, space, key-type, space, base64); if user has multiple keys, then
repeat this option for each key
└─commandline example: --sftp-key 'david ssh-ed25519 AAAAC3NzaC...'
└─config-file example: sftp-key: david ssh-ed25519 AAAAC3NzaC... (default: None)
--sftp-pw allow password-authentication with sftp (not just ssh-keys) (default: False)
--sftp-anon TXT allow anonymous/unauthenticated connections with TXT as username (default: )
--sftp-hostk FP path to folder with hostkeys, for example 'ssh_host_rsa_key'; missing keys will be generated (default:
~/.config/copyparty)
--sftp-banner T bannertext to send when someone connects; can be @filepath (default: )
--sftp-ipa CIDR only accept connections from IP-addresses inside CIDR (comma-separated); specify [any] to disable inheriting
--ipa / --ipar. Examples: [lan] or [10.89.0.0/16, 192.168.33.0/24] (default: )
--sftp-hs-t SEC connection handshake timeout in seconds (default: 15)
--sftp-hs-n NUM max num ongoing/incomplete handshakes (default: 4)
FTP options (TCP only):
--ftp PORT enable FTP server on PORT, for example 3921 (default: 0)
--ftps PORT enable FTPS server on PORT, for example 3990 (default: 0)
--ftpv verbose (default: False)
--ftp-i IP IPs to listen on (comma-separated list). Set this to override -i for this protocol (default: -i)
--ftp4 only listen on IPv4 (default: False)
--ftp-ipa CIDR only accept connections from IP-addresses inside CIDR (comma-separated); specify [any] to disable inheriting
--ipa / --ipar. Examples: [lan] or [10.89.0.0/16, 192.168.33.0/24] (default: )
--ftp-no-ow if target file exists, reject upload instead of overwrite (default: False)
--ftp-wt SEC grace period for resuming interrupted uploads (any client can write to any file last-modified more recently than
SEC seconds ago) (default: 7)
--ftp-nat ADDR the NAT address to use for passive connections (default: )
--ftp-pr P-P the range of TCP ports to use for passive connections, for example 12000-13000 (default: )
--ftp-banner T bannertext to send when someone connects; \n is newline, can be @filepath (loaded into memory on startup); if it
has a newline then banner must be longer than 75 chars (default: welcome to the party)
WebDAV options:
--daw enable full write support, even if client may not be webdav. Some webdav clients need this option for editing
existing files; not necessary for clients that send the 'x-oc-mtime' header. Regardless, the delete-permission
must always be given. WARNING: This has side-effects -- PUT-operations will now OVERWRITE existing files, rather
than inventing new filenames to avoid loss of data. You might want to instead set this as a volflag where
needed. By not setting this flag, uploaded files can get written to a filename which the client does not expect
(which might be okay, depending on client) (default: False)
--dav-inf allow depth:infinite requests (recursive file listing); extremely server-heavy but required for spec compliance
-- luckily few clients rely on this (default: False)
--dav-mac disable apple-garbage filter -- allow macos to create junk files (._* and .DS_Store, .Spotlight-*, .fseventsd,
.Trashes, .AppleDouble, __MACOS) (default: False)
--dav-rt show symlink-destination's lastmodified instead of the link itself; always enabled for recursive listings
(volflag=davrt) (default: False)
--dav-auth force auth for all folders (required by davfs2 when only some folders are world-readable) (volflag=davauth)
(default: False)
--dav-ua1 PTN regex of user-agents which ARE webdav-clients, and expect 401 from GET requests; disable with [no] or blank
(default: kioworker/)
--dav-port P additional port to listen on for misbehaving webdav clients which pretend they are graphical browsers; an
alternative/supplement to dav-ua1 (default: 0)
--ua-nodav PTN regex of user-agents which are NOT webdav-clients (default: ^(Mozilla/|NetworkingExtension/|com\.apple\.WebKit))
--p-nodav P,P server-ports (comma-sep.) which are NOT webdav-clients; an alternative/supplement to ua-nodav (default: )
TFTP options (UDP only):
--tftp PORT enable TFTP server on PORT, for example 69 or 3969 (default: 0)
--tftp-i IP IPs to listen on (comma-separated list). Set this to override -i for this protocol (default: -i)
--tftp4 only listen on IPv4 (default: False)
--tftpv verbose (default: False)
--tftpvv verboser (default: False)
--tftp-no-fast debug: disable optimizations (default: False)
--tftp-lsf PTN return a directory listing if a file with this name is requested and it does not exist; defaults matches .ls, dir,
.dir.txt, ls.txt, ... (default: \.?(dir|ls)(\.txt)?)
--tftp-nols if someone tries to download a directory, return an error instead of showing its directory listing (default:
False)
--tftp-ipa CIDR only accept connections from IP-addresses inside CIDR (comma-separated); specify [any] to disable inheriting
--ipa / --ipar. Examples: [lan] or [10.89.0.0/16, 192.168.33.0/24] (default: )
--tftp-pr P-P the range of UDP ports to use for data transfer, for example 12000-13000 (default: )
SMB/CIFS options:
--smb enable smb (read-only) -- this requires running copyparty as root on linux and macos unless --smb-port is set
above 1024 and your OS does port-forwarding from 445 to that.
WARNING: this protocol is DANGEROUS and buggy! Never expose to the internet! (default: False)
--smb-i IP IPs to listen on (comma-separated list). Set this to override -i for this protocol (default: -i)
--smbw enable write support (please dont) (default: False)
--smb1 disable SMBv2, only enable SMBv1 (CIFS) (default: False)
--smb-port PORT port to listen on -- if you change this value, you must NAT from TCP:445 to this port using iptables or similar
(default: 445)
--smb-nwa-1 truncate directory listings to 64kB (~400 files); avoids impacket-0.11 bug, fixes impacket-0.12 performance
(default: False)
--smb-nwa-2 disable impacket workaround for filecopy globs (default: False)
--smba small performance boost: disable per-account permissions, enables account coalescing instead (if one user has
write/delete-access, then everyone does) (default: False)
--smb6 enable IPv6 (default: False)
--smbv verbose (default: False)
--smbvv verboser (default: False)
--smbvvv verbosest (default: False)
OPDS options:
--opds enable opds -- allows e-book readers to browse and download files (volflag=opds) (default: False)
--opds-exts T,T file formats to list in OPDS feeds; leave empty to show everything (volflag=opds_exts) (default: epub,cbz,pdf)
WOPI options:
--wopi enable integration with office suites using WOPI (default: False)
--wopi-api URL URL that the WOPI-client should use to communicate with copyparty; default is same as user's webbrowser. Example:
[https://party.example.com/] (default: )
--wopi-url URL URL to your WOPI client; the host of e.g. Collabora Online. Example: [https://code.example.com/] (default: )
--wopi-urls HOST=URL REPEATABLE: maps http HOST copyparty being accessed by to specific WOPI client instance URL; falls back to
--wopi-url; examples: [party.public.com=https://office.public.com/],
[party.internal.net:8443=https://office.internal.net:8443/] (default: None)
--wopi-crt TXT if --wopi-url is selfsigned: path to ca.pem or cert.pem to expect/verify (can be [no] for full-yolo) (default: )
--wopi-crt-icn if --wopi-url is selfsigned: ignore the CN (server ip/name) in cert (default: False)
--wopi-ttl SEC session lifetime; allow editing for this many seconds (default is 30 min) (default: 1800)
--wopi-wdel require permissions read+write+delete for writing to file; default is just read+write (default: False)
safety options:
-s increase safety: Disable thumbnails / potentially dangerous software (ffmpeg/pillow/vips), hide partial uploads,
avoid crawlers.
└─Alias of --dotpart --no-thumb --no-mtag-ff --no-robots --force-js (default: 0)
-ss further increase safety: Prevent js-injection, accidental move/delete, broken symlinks, webdav requires login,
404 on 403, ban on excessive 404s.
└─Alias of -s --no-html --no-readme --no-logues --unpost=0 --no-del --no-mv --reflink --dav-auth --vague-403
-nih (default: False)
-sss further increase safety: Enable logging to disk, scan for dangerous symlinks.
└─Alias of -ss --no-dav --no-logues --no-readme -lo=cpp-%Y-%m%d-%H%M%S.txt.xz --ls=**,*,ln,p,r (default: False)
--ls U[,V[,F]] do a sanity/safety check of all volumes on startup; arguments USER,VOL,FLAGS (see --help-ls); example [**,*,ln,p,
r] (default: )
--xvol never follow symlinks leaving the volume root, unless the link is into another volume where the user also has
access (keeps permissions from the outer/initial volume) (volflag=xvol) (default: False)
--xdev stay within the filesystem of the volume root; do not descend into other devices (symlink or bind-mount to
another HDD, ...) (volflag=xdev) (default: False)
--vol-nospawn if a volume's folder does not exist on the HDD, then do not create it (continue with warning) (volflag=nospawn)
(default: False)
--vol-or-crash if a volume's folder does not exist on the HDD, then burst into flames (volflag=assert_root) (default: False)
--no-dot-mv disallow moving dotfiles; makes it impossible to move folders containing dotfiles (default: False)
--no-dot-ren disallow renaming dotfiles; makes it impossible to turn something into a dotfile (default: False)
--no-logues disable rendering .prologue/.epilogue.html into directory listings (volflag=no_logues) (default: False)
--no-readme disable rendering readme/preadme.md into directory listings (volflag=no_readme) (default: False)
--csp-ui TXT content-security-policy to apply for the web-UI; default helps prevent XSS by blocking <script> / onclick / ...
(volflag=csp_ui) (default: script-src 'unsafe-eval' 'nonce-{{ js_nonce }}'; worker-src 'self')
--csp-dl TXT content-security-policy to apply for static files (volflag=csp_dl) (default: )
--no-script disables javascript in html files; helps prevent XSS but kills interactive websites; this will override --csp-dl
with [script-src 'none'] (volflag=noscript) (default: False)
--no-html show html-files as plain text; helps prevent XSS but kills websites/blogs, also enables --no-script
(volflag=nohtml) (default: False)
--vague-403 send 404 instead of 403 (security through ambiguity, very enterprise). WARNING: Not compatible with WebDAV
(default: False)
--force-js don't send folder listings as HTML, force clients to use the embedded json instead -- slight protection against
misbehaving search engines which ignore --no-robots (default: False)
--no-robots adds http and html headers asking search engines to not index anything (volflag=norobots) (default: False)
--logout H logout clients after H hours of inactivity; [0.0028]=10sec, [0.1]=6min, [24]=day, [168]=week, [720]=month,
[8760]=year) (default: 8086.0)
--dont-ban TXT anyone at this accesslevel or above will not get banned: [av]=admin-in-volume, [aa]=has-admin-anywhere,
[rw]=read-write, [auth]=authenticated, [any]=disable-all-bans, [no]=anyone-can-get-banned (default: no)
--banmsg TXT the response to send to banned users; can be @ban.html to send the contents of ban.html (default: thank you for
playing (see fileserver log and readme))
--ban-pw N,W,B more than N wrong passwords in W minutes = ban for B minutes; disable with [no] (default: 9,60,1440)
--ban-pwc N,W,B more than N password-changes in W minutes = ban for B minutes; disable with [no] (default: 5,60,1440)
--ban-404 N,W,B hitting more than N 404's in W minutes = ban for B minutes; only affects users who cannot see directory listings
because their access is either g/G/h (default: 50,60,1440)
--ban-403 N,W,B hitting more than N 403's in W minutes = ban for B minutes; [1440]=day, [10080]=week, [43200]=month (default: 9,2,
1440)
--ban-422 N,W,B hitting more than N 422's in W minutes = ban for B minutes (invalid requests, attempted exploits ++) (default: 9,
2,1440)
--ban-url N,W,B hitting more than N sus URL's in W minutes = ban for B minutes; applies only to permissions g/G/h (decent
replacement for --ban-404 if that can't be used) (default: 9,2,1440)
--sus-urls R URLs which are considered sus / eligible for banning; disable with blank or [no] (default:
\.php$|(^|/)wp-(admin|content|includes)/)
--nonsus-urls R harmless URLs ignored from 403/404-bans; disable with blank or [no] (default:
^(favicon\..{3}|robots\.txt)$|^apple-touch-icon|^\.well-known)
--early-ban if a client is banned, reject its connection as soon as possible; not a good idea to enable when proxied behind
cloudflare since it could ban your reverse-proxy (default: False)
--cookie-nmax N reject HTTP-request from client if they send more than N cookies (default: 50)
--cookie-cmax N reject HTTP-request from client if more than N characters in Cookie header (default: 8192)
--aclose MIN if a client maxes out the server connection limit, downgrade it from connection:keep-alive to connection:close
for MIN minutes (and also kill its active connections) -- disable with 0 (default: 10)
--loris B if a client maxes out the server connection limit without sending headers, ban it for B minutes; disable with [0]
(default: 60)
--acao V[,V] Access-Control-Allow-Origin; list of origins (domains/IPs without port) to accept requests from;
[https://1.2.3.4]. Default [*] allows requests from all sites but removes cookies and http-auth; only
?pw=hunter2 survives (default: *)
--acam V[,V] Access-Control-Allow-Methods; list of methods to accept from offsite ('*' behaves like --acao's description)
(default: GET,HEAD)
--unsafe-tools windows-only: allow running programs (ffmpeg, dcraw_emu, ...) when their location is inside a folder that can be
uploaded to (dangerous due to DLL-hijacking) (default: False)
--th-bwrap CMD optional bwrap sandbox command for FFmpeg and dcraw (Linux-only) (default: depends-on-system-env)
--use-bwrap TXT a/n/f; [a]=auto (yes if the program 'bwrap' exists (assumes it works)), [n]=no (assumes bwrap is broken),
[f]=force (disables FFmpeg if bwrap unavailable) (default: n)
salting options:
--ah-alg ALG account-pw hashing algorithm; one of these, best to worst: argon2 scrypt sha2 none (each optionally followed by
alg-specific comma-sep. config) (default: none)
--ah-salt SALT account-pw salt; ignored if --ah-alg is none (default) (default: 24-character-autogenerated)
--ah-gen PW generate hashed password for PW, or read passwords from STDIN if PW is [-] (default: )
--ah-cli launch an interactive shell which hashes passwords without ever storing or displaying the original passwords
(default: False)
--fk-salt SALT per-file accesskey salt; used to generate unpredictable URLs for hidden files (default: 24-character-autogenerated)
--dk-salt SALT per-directory accesskey salt; used to generate unpredictable URLs to share folders with users who only have the
'get' permission (default: 40-character-autogenerated)
--warksalt SALT up2k file-hash salt; serves no purpose, no reason to change this (but delete all databases if you do) (default:
hunter2)
--show-ah-salt on startup, print the effective value of --ah-salt (the autogenerated value in $XDG_CONFIG_HOME unless otherwise
specified) (default: False)
--show-fk-salt on startup, print the effective value of --fk-salt (the autogenerated value in $XDG_CONFIG_HOME unless otherwise
specified) (default: False)
--show-dk-salt on startup, print the effective value of --dk-salt (the autogenerated value in $XDG_CONFIG_HOME unless otherwise
specified) (default: False)
opt-outs:
-nw never write anything to disk (debug/benchmark) (default: False)
--keep-qem do not disable quick-edit-mode on windows (it is disabled to avoid accidental text selection in the terminal
window, as this would pause execution) (default: False)
--no-dav disable webdav support (default: False)
--no-del disable delete operations (default: False)
--no-mv disable move/rename operations (default: False)
--no-cp disable copy operations (default: False)
--no-fs-abrt disable ability to abort ongoing copy/move (default: False)
-nih no info hostname -- removes it from the UI corner, but the value of --bname still shows in the browsertab title
(default: False)
-nid no info disk-usage -- don't show in UI. This is the same as --du-who no (default: False)
-nb no powered-by-copyparty branding in UI (default: False)
--smsg T,T HTTP-methods to allow ?smsg for; will execute xm hooks like urlform / message-to-serverlog; dangerous example:
[GET,POST]. WARNING: The default (POST) is safe, but GET is dangerous; security/CSRF hazard (default: POST)
--zipmaxn N reject download-as-zip if more than N files in total; optionally takes a unit suffix: [256], [9K], [4G]
(volflag=zipmaxn) (default: 0)
--zipmaxs SZ reject download-as-zip if total download size exceeds SZ bytes; optionally takes a unit suffix: [256M], [4G],
[2T] (volflag=zipmaxs) (default: 0)
--zipmaxt TXT custom errormessage when download size exceeds max (volflag=zipmaxt) (default: )
--zipmaxu authenticated users bypass the zip size limit (volflag=zipmaxu) (default: False)
--zip-who LVL who can download as zip/tar? [0]=nobody, [1]=admins, [2]=authenticated-with-read-access,
[3]=everyone-with-read-access (volflag=zip_who)
WARNING: if a nested volume has a more restrictive value than a parent volume, then this will be ignored if the
download is initiated from the parent, more lenient volume (default: 3)
--ua-nozip PTN regex of user-agents to reject from download-as-zip/tar; disable with [no] or blank (default:
Barkrowler|bingbot|BLEXBot|Googlebot|GoogleOther|GPTBot|PetalBot|SeekportBot|SemrushBot|YandexBot)
--no-zip disable download as zip/tar; same as --zip-who=0 (default: False)
--no-tarcmp disable download as compressed tar (?tar=gz, ?tar=bz2, ?tar=xz, ?tar=gz:9, ...) (default: False)
--no-lifetime do not allow clients (or server config) to schedule an upload to be deleted after a given time (default: False)
--no-pipe disable race-the-beam (lockstep download of files which are currently being uploaded) (volflag=nopipe) (default:
False)
--no-tail disable streaming a growing files with ?tail (volflag=notail) (default: False)
--no-db-ip do not write uploader-IP into the database; will also disable unpost, you may want --forget-ip instead
(volflag=no_db_ip) (default: False)
--no-zls disable browsing the contents of zip/cbz files, does not affect thumbnails (default: False)
shutdown options:
--ign-ebind continue running even if it's impossible to listen on some of the requested endpoints (default: False)
--ign-ebind-all continue running even if it's impossible to receive connections at all (default: False)
--exit WHEN shutdown after WHEN has finished; [cfg] config parsing, [idx] volscan + multimedia indexing, [thgen]
thumbnail-pregen (default: )
yolo options:
--allow-csrf disable csrf protections; let other domains/sites impersonate you through cross-site requests; DANGEROUS /
LAN-only (default: False)
--cookie-lax allow cookies from other domains (if you follow a link from another website into your server, you will arrive
logged-in); this reduces protection against CSRF (default: False)
--no-fnugg disable the smoketest for caching-related issues in the web-UI (default: False)
--getmod permit ?move=[...] and ?delete as GET -- DANGEROUS, removes csrf protection (default: False)
--wo-up-readme allow users with write-only access to upload logues and readmes without adding the _wo_ filename prefix
(volflag=wo_up_readme) (default: False)
--unsafe-state when one of the emergency fallback locations are used for runtime state ($TMPDIR, /tmp), certain features will be
force-disabled for security reasons by default. This option overrides that safeguard and allows unsafe storage
of secrets (default: False)
handlers (see --help-handlers):
--on404 PY REPEATABLE: handle 404s by executing PY file (default: None)
--on403 PY REPEATABLE: handle 403s by executing PY file (default: None)
--hot-handlers recompile handlers on each request -- expensive but convenient when hacking on stuff (default: False)
event hooks (see --help-hooks):
--xbu CMD REPEATABLE: execute CMD before a file upload starts (default: None)
--xau CMD REPEATABLE: execute CMD after a file upload finishes (default: None)
--xiu CMD REPEATABLE: execute CMD after all uploads finish and volume is idle (default: None)
--xbc CMD REPEATABLE: execute CMD before a file copy (default: None)
--xac CMD REPEATABLE: execute CMD after a file copy (default: None)
--xbr CMD REPEATABLE: execute CMD before a file move/rename (default: None)
--xar CMD REPEATABLE: execute CMD after a file move/rename (default: None)
--xbd CMD REPEATABLE: execute CMD before a file delete (default: None)
--xad CMD REPEATABLE: execute CMD after a file delete (default: None)
--xm CMD REPEATABLE: execute CMD on message (default: None)
--xban CMD REPEATABLE: execute CMD if someone gets banned (pw/404/403/url) (default: None)
--hook-v verbose hooks (default: False)
grafana/prometheus metrics endpoint:
--stats enable openmetrics at /.cpr/metrics for admin accounts (default: False)
--stats-u U,U comma-separated list of users allowed to access /.cpr/metrics even if they aren't admin (default: )
--nos-hdd disable disk-space metrics (used/free space) (default: False)
--nos-vol disable volume size metrics (num files, total bytes, vmaxb/vmaxn) (default: False)
--nos-vst disable volume state metrics (indexing, analyzing, activity) (default: False)
--nos-dup disable dupe-files metrics (good idea; very slow) (default: False)
--nos-unf disable unfinished-uploads metrics (default: False)
textfile options:
--rw-edit T,T comma-sep. list of file-extensions to allow editing with permissions read+write; all others require
read+write+delete (volflag=rw_edit) (default: md)
--md-no-br markdown: disable newline-is-newline; will only render a newline into the html given two trailing spaces or a
double-newline (volflag=md_no_br) (default: False)
--md-hist TXT where to store old version of textfiles; [s]=subfolder, [v]=volume-histpath, [n]=nope/disabled (volflag=md_hist)
(default: s)
--md-nhist TXT how many old versions of textfiles to keep; 0=infinite (volflag=md_nhist) (default: 99)
--show-hist allow browsing the .hist folder; enable to view old markdown files (volflag=show_hist) (default: False)
--txt-eol TYPE enable EOL conversion when writing documents; supported: CRLF, LF (volflag=txt_eol) (default: )
-mcr SEC the textfile editor will check for serverside changes every SEC seconds (default: 60)
-emp enable markdown plugins -- neat but dangerous, big XSS risk (default: False)
--exp enable textfile expansion -- replace {{self.ip}} and such; see --help-exp (volflag=exp) (default: False)
--exp-md V,V,V comma/space-separated list of placeholders to expand in markdown files; add/remove stuff on the default list with
+hdr_foo or /vf.scan (volflag=exp_md) (default: self.ip self.ua self.uname self.host cfg.name cfg.logout vf.scan
vf.thsize hdr.cf-ipcountry srv.itime srv.htime)
--exp-lg V,V,V comma/space-separated list of placeholders to expand in prologue/epilogue files (volflag=exp_lg) (default:
self.ip self.ua self.uname self.host cfg.name cfg.logout vf.scan vf.thsize hdr.cf-ipcountry srv.itime srv.htime)
--ua-nodoc PTN regex of user-agents to reject from viewing documents through ?doc=[...]; disable with [no] or blank (default:
Barkrowler|bingbot|BLEXBot|Googlebot|GoogleOther|GPTBot|PetalBot|SeekportBot|SemrushBot|YandexBot)
tailing options (realtime streaming of a growing file):
--tail-who LVL who can tail? [0]=nobody, [1]=admins, [2]=authenticated-with-read-access, [3]=everyone-with-read-access
(volflag=tail_who) (default: 2)
--tail-cmax N do not allow starting a new tail if more than N active downloads (default: 64)
--tail-tmax SEC terminate connection after SEC seconds; [0]=never (volflag=tail_tmax) (default: 0)
--tail-rate SEC check for new data every SEC seconds (volflag=tail_rate) (default: 0.2)
--tail-ka SEC send a zerobyte if connection is idle for SEC seconds to prevent disconnect (default: 3.0)
--tail-fd SEC check if file was replaced (new fd) if idle for SEC seconds (volflag=tail_fd) (default: 1.0)
og / open graph / discord-embed options:
--og disable hotlinking and return an html document instead; this is required by open-graph, but can also be useful on
its own (volflag=og) (default: False)
--og-ua RE only disable hotlinking / engage OG behavior if the useragent matches regex RE (volflag=og_ua) (default: )
--og-tpl PATH do not return the regular copyparty html, but instead load the jinja2 template at PATH (if path contains 'EXT'
then EXT will be replaced with the requested file's extension) (volflag=og_tpl) (default: )
--og-no-head do not automatically add OG entries into <head> (useful if you're doing this yourself in a template or such)
(volflag=og_no_head) (default: False)
--og-th FMT thumbnail format; j=jpeg, jf=jpeg-uncropped, jf3=jpeg-uncropped-large, w=webm, ... (volflag=og_th) (default: jf3)
--og-title TXT fallback title if there is nothing in the -e2t database (volflag=og_title) (default: )
--og-title-a T audio title format; takes any metadata key (volflag=og_title_a) (default: 🎵 {{ artist }} - {{ title }})
--og-title-v T video title format; takes any metadata key (volflag=og_title_v) (default: {{ title }})
--og-title-i T image title format; takes any metadata key (volflag=og_title_i) (default: {{ title }})
--og-s-title force default title; do not read from tags (volflag=og_s_title) (default: False)
--og-desc TXT description text; same for all files, disable with [-] (volflag=og_desc) (default: )
--og-site TXT sitename; defaults to --name, disable with [-] (volflag=og_site) (default: )
--tcolor RGB accent color (3 or 6 hex digits); may also affect safari and/or android-chrome (volflag=tcolor) (default: 333)
--uqe query-string parceling; translate a request for /foo/.uqe/BASE64 into /foo?TEXT, or /foo/?TEXT if the first
character in TEXT is a slash. Automatically enabled for --og (default: False)
ui options:
--grid show grid/thumbnails by default (volflag=grid) (default: False)
--gsel select files in grid by ctrl-click (volflag=gsel) (default: False)
--localtime default to local timezone instead of UTC (default: False)
--ui-filesz FMT default filesize format; one of these: 0, 1, 2, 2c, 3, 3c, 4, 4c, 5, 5c, 6, 6c, 7, 7c, fuzzy (see UI) (default: 1)
--gauto PERCENT switch to gridview if more than PERCENT of files are pics/vids; 0=disabled (default: 0)
--rcm TXT rightclick-menu; two yes/no options: 1st y/n is enable-custom-menu, 2nd y/n is enable-double (default: yy)
--lang LANG language, for example eng / nor / ... (default: eng)
--glang guess the browser's default language, otherwise fall back to --lang (default: False)
--theme NUM default theme to use (0..9) (default: 0)
--themes NUM number of themes installed (default: 10)
--au-vol 0-100 default audio/video volume percent (default: 50)
--sort C,C,C default sort order, comma-separated column IDs (see header tooltips), prefix with '-' for descending. Examples:
href -href ext sz ts tags/Album tags/.tn (volflag=sort) (default: href)
--nsort default-enable natural sort of filenames with leading numbers (volflag=nsort) (default: False)
--hsortn N number of sorting rules to include in media URLs by default (volflag=hsortn) (default: 2)
--see-dots default-enable seeing dotfiles; only takes effect if user has the necessary permissions (default: False)
--qdel LVL number of confirmations to show when deleting files (2/1/0) (default: 2)
--dlni force download (don't show inline) when files are clicked (volflag:dlni) (default: False)
--unlist REGEX don't show files/folders matching REGEX in file list. WARNING: Purely cosmetic! Does not affect API calls, just
the browser. Example: [\.(js|css)$] (volflag=unlist) (default: )
--dothidden hide specific files in a folder by listing them in a file named .hidden -- WARNING: Mostly cosmetic!
Download-as-zip/tar will still download them. Do not rely on this for security (volflag=dothidden) (default:
False)
--favico TXT favicon-text [ foreground [ background ] ], set blank to disable (default: 🎉 000 none)
--ufavico TXT URL to .ico/png/gif/svg file; --favico takes precedence unless disabled (volflag=ufavico) (default: )
--ext-th E=VP REPEATABLE: use thumbnail-image VP for file-extension E, example: [exe=/.res/exe.png] (volflag=ext_th) (default:
None)
--notooltips tooltips disabled as default (default: False)
--spinner TXT emoji or emoji,css Example: [🥖,padding:0] (default: 🌲)
--css-browser L URL to additional CSS to include in the filebrowser html (default: )
--js-browser L URL to additional JS to include in the filebrowser html (default: )
--js-other L URL to additional JS to include in all other pages (default: )
--html-head TXT text to append to the <head> of all HTML pages (except for basic-browser); can be @PATH to send the contents of a
file at PATH, and/or begin with % to render as jinja2 template; <script> will not work, use <script nonce="{{
js_nonce }}"> (volflag=html_head) (default: )
--html-head-s T text to append to the <head> of all HTML pages (except for basic-browser); similar to (and can be combined with)
--html-head but only accepts static text (volflag=html_head_s) (default: )
--ih if a folder contains index.html, show that instead of the directory listing by default (can be changed in the
client settings UI, or add ?v to URL for override) (default: False)
--textfiles CSV file extensions to present as plaintext (default: txt,nfo,diz,cue,readme)
--txt-max KiB max size of embedded textfiles on ?doc= (anything bigger will be lazy-loaded by JS) (default: 64)
--prologues T,T comma-sep. list of filenames to scan for and use as prologues (embed above/before directory listing)
(volflag=prologues) (default: .prologue.html)
--epilogues T,T comma-sep. list of filenames to scan for and use as epilogues (embed below/after directory listing)
(volflag=epilogues) (default: .epilogue.html)
--preadmes T,T comma-sep. list of filenames to scan for and use as preadmes (embed above/before directory listing)
(volflag=preadmes) (default: preadme.md,PREADME.md)
--readmes T,T comma-sep. list of filenames to scan for and use as readmes (embed below/after directory listing)
(volflag=readmes) (default: readme.md,README.md)
--doctitle TXT title / service-name to show in html documents (default: copyparty @ --name)
--bname TXT server name (displayed in filebrowser document title) (default: --name)
--pb-url URL powered-by link; disable with -nb (default: https://github.com/9001/copyparty)
--ver show version on the control panel (incompatible with -nb). This is the same as --ver-who all (default: False)
--ver-who TXT only show version for: [a]=admin-permission-anywhere, [auth]=authenticated, [all]=anyone (default: no)
--du-who TXT only show disk usage for: [no]=nobody, [a]=admin-permission, [rw]=read-write, [w]=write, [auth]=authenticated,
[all]=anyone (volflag=du_who) (default: all)
--k304 NUM configure the option to enable/disable k304 on the controlpanel (workaround for buggy reverse-proxies); [0] =
hidden and default-off, [1] = visible and default-off, [2] = visible and default-on (default: 0)
--no304 NUM configure the option to enable/disable no304 on the controlpanel (workaround for buggy caching in browsers); [0]
= hidden and default-off, [1] = visible and default-off, [2] = visible and default-on (default: 0)
--ctl-re SEC the controlpanel Refresh-button will autorefresh every SEC; [0] = just once (default: 1)
--md-sbf FLAGS list of capabilities to allow in the iframe 'sandbox' attribute for README.md docs (volflag=md_sbf); see
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#sandbox (default: downloads forms popups
scripts top-navigation-by-user-activation)
--lg-sbf FLAGS list of capabilities to allow in the iframe 'sandbox' attribute for prologue/epilogue docs (volflag=lg_sbf)
(default: downloads forms popups scripts top-navigation-by-user-activation)
--md-sba TXT the value of the iframe 'allow' attribute for README.md docs, for example [fullscreen] (volflag=md_sba) (default:
)
--lg-sba TXT the value of the iframe 'allow' attribute for prologue/epilogue docs (volflag=lg_sba); see
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy#iframes (default: )
--no-sb-md don't sandbox README/PREADME.md documents (volflags: no_sb_md | sb_md) (default: False)
--no-sb-lg don't sandbox prologue/epilogue docs (volflags: no_sb_lg | sb_lg); enables non-js support (default: False)
--ui-nombar hide top-menu in the UI (volflag=ui_nombar) (default: False)
--ui-noacci hide account-info in the UI (volflag=ui_noacci) (default: False)
--ui-nosrvi hide server-info in the UI (volflag=ui_nosrvi) (default: False)
--ui-nonav hide navpane+breadcrumbs (volflag=ui_nonav) (default: False)
--ui-notree hide navpane in the UI (volflag=ui_notree) (default: False)
--ui-nocpla hide cpanel-link in the UI (volflag=ui_nocpla) (default: False)
--ui-nolbar hide link-bar in the UI (volflag=ui_nolbar) (default: False)
--ui-noctxb hide context-buttons in the UI (volflag=ui_noctxb) (default: False)
--ui-norepl hide repl-button in the UI (volflag=ui_norepl) (default: False)
admin panel options:
--no-reload disable ?reload=cfg (reload users/volumes/volflags from config file) (default: False)
--no-rescan disable ?scan (volume reindexing) (default: False)
--no-stack disable ?stack (list all stacks); same as --stack-who=no (default: False)
--no-ups-page disable ?ru (list of recent uploads) (default: False)
--no-up-list don't show list of incoming files in controlpanel (default: False)
--dl-list LVL who can see active downloads in the controlpanel? [0]=nobody, [1]=admins, [2]=everyone (default: 2)
--ups-who LVL who can see recent uploads on the ?ru page? [0]=nobody, [1]=admins, [2]=everyone (volflag=ups_who) (default: 2)
--ups-when let everyone see upload timestamps on the ?ru page, not just admins (default: False)
--stack-who LVL who can see the ?stack page (list of threads)? [no]=nobody, [a]=admins, [rw]=read+write, [all]=everyone (default:
a)
--stack-v verbose ?stack (default: False)
logging options:
-q quiet; disable most STDOUT messages (default: False)
-lo PATH logfile; use .txt for plaintext or .xz for compressed. Example: cpp-%Y-%m%d-%H%M%S.txt.xz (NB: some errors may
appear on STDOUT only) (default: )
--flo N log format for -lo; [1]=classic/colors, [2]=no-color (default: 1)
--rlo TXT logrotate counter format; see --help-rlo (default: no)
--logrot-sig S immediately logrotate when unix-signal S is received; examples: [SIGHUP], [HUP], [1] (default: )
--no-ansi disable colors; same as environment-variable NO_COLOR (default: False)
--ansi force colors; overrides environment-variable NO_COLOR (default: False)
--no-logflush don't flush the logfile after each write; tiny bit faster (default: False)
--no-voldump do not list volumes and permissions on startup (default: False)
--log-utc do not use local timezone; assume the TZ env-var is UTC (tiny bit faster) (default: False)
--log-tdec N timestamp resolution / number of timestamp decimals (default: 3)
--log-date TXT date-format, for example [%Y-%m-%d] (default is disabled; no date, just HH:MM:SS) (default: )
--log-badpwd N log failed login attempt passwords: 0=terse, 1=plaintext, 2=hashed (default: 2)
--log-badxml log any invalid XML received from a client (default: False)
--log-conn debug: print tcp-server msgs (default: False)
--log-htp debug: print http-server threadpool scaling (default: False)
--ihead HEADER print request HEADER; [*]=all (default: None)
--ohead HEADER print response HEADER; [*]=all (default: None)
--lf-url RE dont log URLs matching regex RE (default: ^/\.cpr/|[?&]th=[xwjp]|/\.(_|ql_|DS_Store$|localized$))
--scan-st-r SEC fs-indexing: wait SEC between each status-message (default: 0.1)
--scan-pr-r SEC fs-indexing: wait SEC between each 'progress:' message (default: 10)
--scan-pr-s MiB fs-indexing: say 'file: <name>' when a file larger than MiB is about to be hashed (default: 1)
debug options:
--vc verbose config file parser (explain config) (default: False)
--cgen generate config file from current config (best-effort; probably buggy) (default: False)
--deps list information about detected optional dependencies (default: False)
--no-poll kernel-bug workaround: disable poll; use select instead (limits max num clients to ~700) (default: False)
--no-sendfile kernel-bug workaround: disable sendfile; do a safe and slow read-send-loop instead (default: False)
--no-scandir kernel-bug workaround: disable scandir; do a listdir + stat on each file instead (default: False)
--no-fastboot wait for initial filesystem indexing before accepting client requests (default: False)
--no-htp disable httpserver threadpool, create threads as-needed instead (default: False)
--sig-thr start separate thread for OS-signals (try this if CTRL-C is busted) (default: False)
--rm-sck when listening on unix-sockets, do a basic delete+bind instead of the default atomic bind (default: False)
--srch-dbg explain search processing, and do some extra expensive sanity checks (default: False)
--rclone-mdns use mdns-domain instead of server-ip on /?hc (default: False)
--stackmon P,S write stacktrace to Path every S second, for example --stackmon=./st/%Y-%m/%d/%H%M.xz,60 (default: )
--stack-sig S show stacktrace when unix-signal S is received; examples: [SIGUSR2], [USR2], [12] (default: )
--log-thrs SEC list active threads every SEC (default: 0.0)
--log-fk REGEX log filekey params for files where path matches REGEX; [.] (a single dot) = all files (default: )
--bak-flips [up2k] if a client uploads a bitflipped/corrupted chunk, store a copy according to --bf-nc and --bf-dir (default:
False)
--bf-nc NUM bak-flips: stop if there's more than NUM files at --kf-dir already; default: 6.3 GiB max (200*32M) (default: 200)
--bf-dir PATH bak-flips: store corrupted chunks at PATH; default: folder named 'bf' wherever copyparty was started (default: bf)
--bf-log PATH bak-flips: log corruption info to a textfile at PATH (default: )
help sections:
--help-bind configure listening (default: False)
--help-accounts accounts and volumes (default: False)
--help-auth how to login from a client (default: False)
--help-auth-ord authentication precedence (default: False)
--help-flags list of volflags (default: False)
--help-handlers use plugins to handle certain events (default: False)
--help-hooks execute commands before/after various events (default: False)
--help-idp replacing the login system with fancy middleware (default: False)
--help-urlform how to handle url-form POSTs (default: False)
--help-exp text expansion (default: False)
--help-rlo logrotate format (default: False)
--help-ls volume inspection (default: False)
--help-dbd database durability profiles (default: False)
--help-chmod file/folder permissions (default: False)
--help-pwhash password hashing (default: False)
--help-zm mDNS debugging (default: False)
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
-i takes a comma-separated list of interfaces to listen on;
IP-addresses, unix-sockets, and/or open file descriptors
the default (-i ::) means all IPv4 and IPv6 addresses
-i 0.0.0.0 listens on all IPv4 NICs/subnets
-i 127.0.0.1 listens on IPv4 localhost only
-i 127.1 listens on IPv4 localhost only
-i 127.1,192.168.123.1 = IPv4 localhost and 192.168.123.1
-p takes a comma-separated list of tcp ports to listen on;
the default is -p 3923 but as root you can -p 80,443,3923
when running behind a reverse-proxy, it's recommended to
use unix-sockets for improved performance and security;
-i unix:770:www:/dev/shm/party.sock listens on
/dev/shm/party.sock with permissions 0770;
only accessible to members of the www group.
This is the best approach. Alternatively,
-i unix:777:/dev/shm/party.sock sets perms 0777 so anyone
can access it; bad unless it's inside a restricted folder
-i unix:/dev/shm/party.sock keeps umask-defined permission
(usually 0600) and the same user/group as copyparty
-i fd:3 uses the socket passed to copyparty on file descriptor 3
-p (tcp ports) is ignored for unix-sockets and FDs
--list-nics shows all network adapters (also offline ones);
--list-ips shows all LAN IPs
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
-a takes username:password,
-v takes src:dst:perm1:perm2:permN:volflag1:volflag2:volflagN:...
* "perm" is "permissions,username1,username2,..."
* "volflag" is config flags to set on this volume
--grp takes groupname:username1,username2,...
and groupnames can be used instead of usernames in -v
by prefixing the groupname with @
list of permissions:
"r" (read): list folder contents, download files
"w" (write): upload files; need "r" to see the uploads
"m" (move): move files and folders; need "w" at destination
"d" (delete): permanently delete files and folders
"g" (get): download files, but cannot see folder contents
"G" (upget): "get", but can see filekeys of their own uploads
"h" (html): "get", but folders return their index.html
"." (dots): user can ask to show dotfiles in listings
"a" (admin): can see uploader IPs, config-reload
"A" ("all"): same as "rwmda." (read/write/move/delete/admin/dotfiles)
too many volflags to list here, see --help-flags
example:
-a ed:hunter2 -v .::r:rw,ed -v ../inc:dump:w:rw,ed:c,nodupe
mount current directory at "/" with
* r (read-only) for everyone
* rw (read+write) for ed
mount ../inc at "/dump" with
* w (write-only) for everyone
* rw (read+write) for ed
* reject duplicate files
if no accounts or volumes are configured,
current folder will be read/write for everyone
the group @acct will always have every user with an account
(the name of that group can be changed with --grp-all)
to hide a volume from authenticated users, specify *,-@acct
to subtract @acct from * (can subtract users from groups too)
consider the config file for more flexible account/volume management,
including dynamic reload at runtime (and being more readable w)
see --help-auth for ways to provide the password in requests;
see --help-idp for replacing it with SSO and auth-middlewares
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
# auth help page (how to login from a client)
different ways to provide the password so you become authenticated:
login with the ui:
go to http://127.0.0.1:3923/?h and login there
send the password in the 'PW' http-header:
PW: hunter2
or if you have --usernames enabled,
PW: ed:hunter2
send the password in the URL itself:
http://127.0.0.1:3923/?pw=hunter2
or if you have --usernames enabled,
http://127.0.0.1:3923/?pw=ed:hunter2
use basic-authentication:
http://ed:hunter2@127.0.0.1:3923/
which should be the same as this header:
Authorization: Basic ZWQ6aHVudGVyMg==
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
--auth-ord is a comma-separated list of auth options
(one or more of the [options] below); first one wins
[pw] is conventional login, for example the "PW" header,
or the ?pw=[...] URL-suffix, or a valid session cookie
(see --help-auth)
[idp] is a username provided in the http-request-header
defined by --idp-h-usr and/or --idp-hm-usr, which is
provided by an authentication middleware such as
authentik, authelia, tailscale, ... (see --help-idp)
[idp-h] is specifically an --idp-h-usr header,
[idp-hm] is specifically an --idp-hm-usr header;
[idp] is the same as [idp-hm,idp-h]
[ipu] is a mapping from an IP-address to a username,
auto-authing that client-IP to that account
(see the description of --ipu in --help)
NOTE: even if an option (pw/ipu/...) is not in the list,
it may still be enabled and can still take effect if
none of the other alternatives identify the user
NOTE: if [ipu] is in the list, it must be FIRST or LAST
NOTE: if [pw] is not in the list, the logout-button
will be hidden when any idp feature is enabled
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
volflags are appended to volume definitions, for example,
to create a write-only volume with the nodupe and nosub flags:
-v /mnt/inc:/inc:w:c,nodupe:c,nosub
if global config defines a volflag for all volumes,
you can unset it for a specific volume with -flag
uploads, general
dedup enable symlink-based file deduplication
hardlink enable hardlink-based file deduplication,
with fallback on symlinks when that is impossible
hardlinkonly dedup with hardlink only, never symlink;
make a full copy if hardlink is impossible
reflink enable reflink-based file deduplication,
with fallback on full copy when that is impossible
safededup verify on-disk data before using it for dedup
noclone take dupe data from clients, even if available on HDD
nodupe rejects existing files (instead of linking/cloning them)
nodupem rejects existing files during moves as well
casechk=auto actively prevent case-insensitive filesystem? y/n
chmod_d=755 unix-permission for new dirs/folders
chmod_f=644 unix-permission for new files
uid=573 change owner of new files/folders to unix-user 573
gid=999 change owner of new files/folders to unix-group 999
fsnt=auto filesystem filename traits (lin/win/mac/auto)
wram allow uploading into ramdisks
sparse force use of sparse files, mainly for s3-backed storage
nosparse deny use of sparse files, mainly for slow storage
rm_partial delete unfinished uploads from HDD when they timeout
daw enable full WebDAV write support (dangerous);
PUT-operations will now OVERWRITE existing files
nosub forces all uploads into the top folder of the vfs
magic enables filetype detection for nameless uploads
put_name fallback filename for nameless uploads
put_ck default checksum-hasher for PUT/WebDAV uploads
bup_ck default checksum-hasher for bup/basic uploads
gz allows server-side gzip compression of uploads with ?gz
xz allows server-side lzma compression of uploads with ?xz
pk forces server-side compression, optional arg: xz,9
upload rules
apnd_who=dw who can append? (aw/dw/w/no)
maxn=250,600 max 250 uploads over 15min
maxb=1g,300 max 1 GiB over 5min (suffixes: b, k, m, g, t)
vmaxb=1g total volume size max 1 GiB (suffixes: b, k, m, g, t)
vmaxn=4k max 4096 files in volume (suffixes: b, k, m, g, t)
medialinks return medialinks for non-up2k uploads (not hotlinks)
wo_up_readme write-only users can upload logues without getting renamed
rand force randomized filenames, 9 chars long by default
nrand=N randomized filenames are N chars long
u2ow=N overwrite existing files? 0=no 1=if-older 2=always
u2ts=fc [f]orce [c]lient-last-modified or [u]pload-time
u2abort=1 allow aborting unfinished uploads? 0=no 1=strict 2=ip-chk 3=acct-chk
sz=1k-3m allow filesizes between 1 KiB and 3MiB
df=1g ensure 1 GiB free disk space
upload rotation
(moves all uploads into the specified folder structure)
rotn=100,3 3 levels of subfolders with 100 entries in each
rotf=%Y-%m/%d-%H date-formatted organizing
rotf_tz=Europe/Oslo timezone (default=UTC)
lifetime=3600 uploads are deleted after 1 hour
database, general
e2d enable database; makes files searchable + enables upload-undo
e2ds scan writable folders for new files on startup; also sets -e2d
e2dsa scans all folders for new files on startup; also sets -e2d
e2t enable multimedia indexing; makes it possible to search for tags
e2ts scan existing files for tags on startup; also sets -e2t
e2tsr delete all metadata from DB (full rescan); also sets -e2ts
d2ts disables metadata collection for existing files
e2v verify integrity on startup by hashing files and comparing to db
e2vu when e2v fails, update the db (assume on-disk files are good)
e2vp when e2v fails, panic and quit copyparty
d2ds disables onboot indexing, overrides -e2ds*
d2t disables metadata collection, overrides -e2t*
d2v disables file verification, overrides -e2v*
d2d disables all database stuff, overrides -e2*
hist=/tmp/cdb puts thumbnails and indexes at that location
dbpath=/tmp/cdb puts indexes at that location
landmark=foo disable db if file foo doesn't exist
scan=60 scan for new files every 60sec, same as --re-maxage
nohash=\.iso$ skips hashing file contents if path matches *.iso
noidx=\.iso$ fully ignores the contents at paths matching *.iso
noforget don't forget files when deleted from disk
forget_ip=43200 forget uploader-IP after 30 days (GDPR)
no_db_ip never store uploader-IP in the db; disables unpost
fat32 avoid excessive reindexing on android sdcardfs
dbd=[acid|swal|wal|yolo] database speed-durability tradeoff
xlink cross-volume dupe detection / linking (dangerous)
xdev do not descend into other filesystems
xvol do not follow symlinks leaving the volume root
dotsrch show dotfiles in search results
nodotsrch hide dotfiles in search results (default)
srch_excl exclude search results with URL matching this regex
db_xattr=user.foo,user.bar index file xattrs as media-tags
database, audio tags
"mte", "mth", "mtp", "mtm" all work the same as -mte, -mth, ...
mte=artist,title media-tags to index/display
mth=fmt,res,ac media-tags to hide by default
mtp=.bpm=f,audio-bpm.py uses the "audio-bpm.py" program to
generate ".bpm" tags from uploads (f = overwrite tags)
mtp=ahash,vhash=media-hash.py collects two tags at once
thumbnails
dthumb disables all thumbnails
dvthumb disables video thumbnails
dathumb disables audio thumbnails (spectrograms)
dithumb disables image thumbnails
pngquant compress audio waveforms 33% better
thsize thumbnail res; WxH
crop center-cropping (y/n/fy/fn)
th3x 3x resolution (y/n/fy/fn)
th_qv=40 webp/jpg thumbnail quality (10~90)
th_qvx=40 jxl thumbnail quality (10~90)
th_covers=a.jpg,a.png filenames to prefer as folder-thumbs
convt convert-to-image timeout in seconds
aconvt convert-to-audio timeout in seconds
th_spec_p=1 make spectrograms? 0=never 1=fallback 2=always
ext_th=s=/b.png use /b.png as thumbnail for file-extension s
th_pregen=w,wf pregenerate thumbs for these formats
handlers
(better explained in --help-handlers)
on404=PY handle 404s by executing PY file
on403=PY handle 403s by executing PY file
event hooks
(better explained in --help-hooks)
xbu=CMD execute CMD before a file upload starts
xau=CMD execute CMD after a file upload finishes
xiu=CMD execute CMD after all uploads finish and volume is idle
xbc=CMD execute CMD before a file copy
xac=CMD execute CMD after a file copy
xbr=CMD execute CMD before a file rename/move
xar=CMD execute CMD after a file rename/move
xbd=CMD execute CMD before a file delete
xad=CMD execute CMD after a file delete
xm=CMD execute CMD on message
xban=CMD execute CMD if someone gets banned
client and ux
grid show grid/thumbnails by default
gsel select files in grid by ctrl-click
sort default sort order
nsort natural-sort of leading digits in filenames
hsortn number of sort-rules to add to media URLs
ufavico=URL per-volume favicon (.ico/png/gif/svg)
unlist dont list files matching REGEX
dothidden enable support for .hidden files
dlni force-download (no-inline) files on click
html_head=TXT includes TXT in the <head>, or @PATH for file at PATH
html_head_s=TXT additional static text in the html <head>
tcolor=#fc0 theme color (a hint for webbrowsers, discord, etc.)
nodirsz don't show total folder size
du_who=all show disk-usage info to everyone
robots allows indexing by search engines (default)
norobots kindly asks search engines to leave
unlistcr don't list read-access in controlpanel
unlistcw don't list write-access in controlpanel
prologues=.prologue.html files to embed above/before files
epilogues=.epilogue.html files to embed below/after files
readmes=readme.md,README.md files to embed as readmes
preadmes=preadme.md,PREADME.md files to embed as preadmes
plainreadme embed readme/preadme as monospace plaintext
plainlogues embed prologue/epilogue as sans-serif plaintext
no_readme disable embedding readme/preadme
no_logues disable embedding prologue/epilogue
no_sb_md disable js sandbox for markdown files
no_sb_lg disable js sandbox for prologue/epilogue
sb_md enable js sandbox for markdown files (default)
sb_lg enable js sandbox for prologue/epilogue (default)
md_sbf list of markdown-sandbox safeguards to disable
lg_sbf list of *logue-sandbox safeguards to disable
md_sba value of iframe allow-prop for markdown-sandbox
lg_sba value of iframe allow-prop for *logue-sandbox
csp_ui content-security-policy for the web-UI
csp_dl content-security-policy for static files
nohtml return html and markdown as text/html
noscript disable most javascript by use of CSP
ui_noacci hide account-info in the UI
ui_nocpla hide cpanel-link in the UI
ui_nolbar hide link-bar in the UI
ui_nombar hide top-menu in the UI
ui_nonav hide navpane+breadcrumbs in the UI
ui_notree hide navpane in the UI
ui_norepl hide repl-button in the UI
ui_nosrvi hide server-info in the UI
ui_noctxb hide context-buttons in the UI
opengraph (discord embeds)
og enable OG (disables hotlinking)
og_site sitename; defaults to --name, disable with '-'
og_desc description text for all files; disable with '-'
og_th=jf thumbnail format; j / jf / jf3 / w / w3 / ...
og_title_a audio title format; default: {{ artist }} - {{ title }}
og_title_v video title format; default: {{ title }}
og_title_i image title format; default: {{ title }}
og_title=foo fallback title if there's nothing in the db
og_s_title force default title; do not read from tags
og_tpl custom html; see --og-tpl in --help
og_no_head you want to add tags manually with og_tpl
og_ua if defined: only send OG html if useragent matches this regex
opds
opds enable OPDS
opds_exts file formats to list in OPDS feeds; leave empty to show everything
textfiles
rw_edit=md,txt only require read+write to edit .md and .txt
md_no_br newline only on double-newline or two tailing spaces
md_hist where to put text-editor backups; s=subfolder, v=volHist, n=nope
md_nhist=99 how many text-editor backups to keep
show_hist allow browsing the .hist folder (old textfiles)
exp enable textfile expansion; see --help-exp
exp_md placeholders to expand in markdown files; see --help
exp_lg placeholders to expand in prologue/epilogue; see --help
txt_eol=lf enable EOL conversion when writing docs (LF or CRLF)
tailing
notail disable ?tail (download a growing file continuously)
tail_fd=1 check if file was replaced (new fd) every 1 sec
tail_rate=0.2 check for new data every 0.2 sec
tail_tmax=30 kill connection after 30 sec
tail_who=2 restrict ?tail access (1=admins,2=authed,3=everyone)
rss
rss allow '?rss' URL suffix (experimental)
rss_sort=m default sort-order (m/u/n/s)
rss_fmt_t={fname} default title-format
rss_fmt_d={album},{.tn} default description-format
others
dots allow all users with read-access to
enable the option to show dotfiles in listings
fk=8 generates per-file accesskeys,
which are then required at the "g" permission;
keys are invalidated if filesize or inode changes
fka=8 generates slightly weaker per-file accesskeys,
which are then required at the "g" permission;
not affected by filesize or inode numbers
dk=8 generates per-directory accesskeys,
which are then required at the "g" permission;
keys are invalidated if filesize or inode changes
dks per-directory accesskeys allow browsing into subdirs
dky allow seeing files (not folders) inside a specific folder
with "g" perm, and does not require a valid dirkey to do so
rmagic expensive analysis for mimetype accuracy
shr_who=auth who can create shares? no/auth/a
unp_who=2 unpost only if same... 1=ip+name, 2=ip, 3=name
ups_who=2 restrict viewing the list of recent uploads
zip_who=2 restrict access to download-as-zip/tar
zipmaxn=9k reject download-as-zip if more than 9000 files
zipmaxs=2g reject download-as-zip if size over 2 GiB
zipmaxt=no reply with 'no' if download-as-zip exceeds max
zipmaxu zip-size-limit does not apply to authenticated users
nopipe disable race-the-beam (download unfinished uploads)
cachectl=no-cache controls caching in webbrowsers
mv_retry ms-windows: timeout for renaming busy files
rm_retry ms-windows: timeout for deleting busy files
nospawn don't create volume's folder if not exist
assert_root crash on startup if volume's folder not exist
davauth ask webdav clients to login for all folders
davrt show lastmod time of symlink destination, not the link itself
(note: this option is always enabled for recursive listings)
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
# handlers help page (use plugins to handle certain events)
usually copyparty returns a 404 if a file does not exist, and
403 if a user tries to access a file they don't have access to
you can load a plugin which will be invoked right before this
happens, and the plugin can choose to override this behavior
load the plugin using --args or volflags; for example
--on404 ~/partyhandlers/not404.py
-v .::r:c,on404=~/partyhandlers/not404.py
the file must define the function main(cli,vn,rem):
cli: the copyparty HttpCli instance
vn: the VFS which overlaps with the requested URL
rem: the remainder of the URL below the VFS mountpoint
`main` must return a string; one of the following:
> "true": the plugin has responded to the request,
and the TCP connection should be kept open
> "false": the plugin has responded to the request,
and the TCP connection should be terminated
> "retry": the plugin has done something to resolve the 404
situation, and copyparty should reattempt reading the file.
if it still fails, a regular 404 will be returned
> "allow": should ignore the insufficient permissions
and let the client continue anyways
> "": the plugin has not handled the request;
try the next plugin or return the usual 404 or 403
PS! the folder that contains the python file should ideally
not contain many other python files, and especially nothing
with filenames that overlap with modules used by copyparty
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
# hooks help page (execute commands before/after various events)
execute a command (a program or script) before or after various events;
xbu executes CMD before a file upload starts
xau executes CMD after a file upload finishes
xiu executes CMD after all uploads finish and volume is idle
xbc executes CMD before a file copy
xac executes CMD after a file copy
xbr executes CMD before a file rename/move
xar executes CMD after a file rename/move
xbd executes CMD before a file delete
xad executes CMD after a file delete
xm executes CMD on message
xban executes CMD if someone gets banned
can be defined as --args or volflags; for example
--xau foo.py
-v .::r:c,xau=bar.py
hooks specified as commandline --args are appended to volflags;
each commandline --arg and volflag can be specified multiple times,
each hook will execute in order unless one returns non-zero, or
"100" which means "stop daisychaining and return 0 (success/OK)"
optionally prefix the command with comma-sep. flags similar to -mtp:
f forks the process, doesn't wait for completion
c checks return code, blocks the action if non-zero
j provides json with info as 1st arg instead of filepath
s provides input data on stdin (instead of 1st arg)
wN waits N sec after command has been started before continuing
tN sets an N sec timeout before the command is abandoned
iN xiu only: volume must be idle for N sec (default = 5)
I import and run as module, not as subprocess
ar only run hook if user has read-access
arw only run hook if user has read-write-access
arwmd ...and so on... (doesn't work for xiu or xban)
kt kills the entire process tree on timeout (default),
km kills just the main process
kn lets it continue running until copyparty is terminated
c0 show all process output (default)
c1 show only stderr
c2 show only stdout
c3 mute all process output
examples:
--xm some.py runs some.py msgtxt on each 📟 message;
msgtxt is the message that was written into the web-ui
--xm j,some.py runs some.py jsontext on each 📟 message;
jsontext is the message info (ip, user, ..., msg-text)
--xm aw,j,some.py requires user to have write-access
--xm aw,,notify-send,hey,-- shows an OS alert on linux;
the ,, stops copyparty from reading the rest as flags and
the -- stops notify-send from reading the message as args
and the alert will be "hey" followed by the messagetext
--xm s,,tee,-a,log.txt appends each msg to log.txt;
--xm s,j,,tee,-a,log.txt writes it as json instead
--xau zmq:pub:tcp://*:5556 announces uploads on zeromq;
--xau t3,zmq:push:tcp://*:5557 also works, and you can
--xau t3,j,zmq:req:tcp://localhost:5555 too for example
each hook is executed once for each event, except for xiu
which builds up a backlog of uploads, running the hook just once
as soon as the volume has been idle for iN seconds (5 by default)
xiu is also unique in that it will pass the metadata to the
executed program on STDIN instead of as argv arguments (so
just like the s option does for the other hook types), and
it also includes the wark (file-id/hash) as a json property
xban can be used to overrule / cancel a user ban event;
if the program returns 0 (true/OK) then the ban will NOT happen
effects can be used to redirect uploads into other
locations, and to delete or index other files based
on new uploads, but with certain limitations. See
bin/hooks/reloc* and docs/devnotes.md#hook-effects
the I option will override most other options, because
it entirely hands over control to the hook, which is
then able to tamper with copyparty's internal memory
and wreck havoc if it wants to -- but this is worh it
because it makes the hook 140x faster
except for xm, only one hook / one action can run at a time,
so it's recommended to use the f flag unless you really need
to wait for the hook to finish before continuing (without f
the upload speed can easily drop to 10% for small files)
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
# idp help page (replacing the login system with fancy middleware)
if you already have a centralized service which handles
user-authentication for other services already, you can
integrate copyparty with that for automatic login
if the middleware is providing the username in an http-header
named 'theUsername' then do this: --idp-h-usr theUsername
if the middleware is providing a list of groups in the header
named 'theGroups' then do this: --idp-h-grp theGroup
if the list of groups is separated by '%' then --idp-gsep %
if the middleware is providing a header named 'Account'
and the value is 'alice@forest.net' but the username is
actually 'marisa' then do this for each user:
--idp-hm-usr ^Account^alice@forest.net^marisa
(the separator '^' can be any character)
make ABSOLUTELY SURE that the header can only be set by your
middleware and not by clients! and, as an extra precaution,
send a header named 'finalmasterspark' (a secret keyword)
and then --idp-h-key finalmasterspark to require that
the login/logout links/buttons can be replaced with links
going to your IdP's UI; --idp-login /login/?redir={dst}
will expand {dst} to the URL of the current page, so
the IdP can redirect the user back to where they were
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
values for --urlform:
stash dumps the data to file and returns length + checksum
save,get dumps to file and returns the page like a GET
get ignores the message and returns the page like a GET
print prints the data to log and returns an error
print,xm prints the data to log and returns --xm output
print,get prints the data to log and returns GET
note that the --xm hook will only run if --urlform is
either print or print,get or the default print,xm
if an --xm hook returns text, then
the response code will be HTTP 202;
http/get responses will be HTTP 200
if there are multiple --xm hooks defined, then
the first hook that produced output is returned
if there are no --xm hooks defined, then the default
print,xm behaves like print,get (returning html)
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
specify --exp or the "exp" volflag to enable placeholder expansions
in README.md / PREADME.md / .prologue.html / .epilogue.html
--exp-md (volflag exp_md) holds the list of placeholders which can be
expanded in READMEs, and --exp-lg (volflag exp_lg) likewise for logues;
any placeholder not given in those lists will be ignored and shown as-is
the default list will expand the following placeholders:
{{self.ip}} client ip
{{self.ua}} client user-agent
{{self.uname}} client username
{{self.host}} the "Host" header, or the server's external IP otherwise
{{cfg.name}} the --name global-config
{{cfg.logout}} the --logout global-config
{{vf.scan}} the "scan" volflag
{{vf.thsize}} thumbnail size
{{srv.itime}} server time in seconds
{{srv.htime}} server time as YY-mm-dd, HH:MM:SS (UTC)
{{hdr.cf-ipcountry}} the "CF-IPCountry" client header (probably blank)
so the following types of placeholders can be added to the lists:
* any client header can be accessed through {{hdr.*}}
* any variable in httpcli.py can be accessed through {{self.*}}
* any global server setting can be accessed through {{cfg.*}}
* any volflag can be accessed through {{vf.*}}
remove vf.scan from default list using --exp-md /vf.scan
add "accept" header to def. list using --exp-md +hdr.accept
for performance reasons, expansion only happens while embedding
documents into directory listings, and when accessing a ?doc=...
link, but never otherwise, so if you click a -txt- link you'll
have to refresh the page to apply expansion
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
a logrotate-counter is added if the logfile filename is taken;
by default at the end, unless %R is somewhere in the -lo pattern,
for example: -lo /var/log/cpp/%Y-%m-%d%R.txt
--rlo configures the logrotate format; examples:
.1 = when necessary, append a dot followed by a single digit
.1! = counter is always added, even when not necessary
-3 = a hyphen followed by three-digit counter
no = disable counter; append to existing file
del = delete existing logfile and create new
over = overwrite existing logfile
append is not possible for .xz-compressed logfiles;
if logfile is *.xz and rlo is no then rlo will be .1
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
--ls USR,VOL,FLAGS
USR is a user to browse as; * is anonymous, ** is all users
VOL is a single volume to scan, default is * (all vols)
FLAG is flags;
v in addition to realpaths, print usernames and vpaths
ln only prints symlinks leaving the volume mountpoint
p exits 1 if any such symlinks are found
r resumes startup after the listing
examples:
--ls '**' # list all files which are possible to read
--ls '**,*,ln' # check for dangerous symlinks
--ls '**,*,ln,p,r' # check, then start normally if safe
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
# dbd help page (database durability profiles)
mainly affects uploads of many small files on slow HDDs; speeds measured uploading 520 files on a WD20SPZX (SMR 2.5" 5400rpm 4kb)
acid = extremely safe but slow; the old default. Should never lose any data no matter what
swal = 2.4x faster uploads yet 99.9% as safe -- theoretical chance of losing metadata for the ~200 most recently uploaded files if there's a power-loss or your OS crashes
wal = another 21x faster on HDDs yet 90% as safe; same pitfall as swal except more likely
yolo = another 1.5x faster, and removes the occasional sudden upload-pause while the disk syncs, but now you're at risk of losing the entire database in a powerloss / OS-crash
profiles can be set globally (--dbd=yolo), or per-volume with volflags: -v ~/Music:music:r:c,dbd=acid
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
global-option --chmod-f and volflag chmod_f specifies the unix-permission to use when creating a new file
similarly, --chmod-d and chmod_d sets the directory/folder perm
the value is a three- or four-digit octal number such as 755, 0644, 2750, etc.
if 3 digits: User, Group, Other
if 4 digits: Special, User, Group, Other
"Special" digit (sum of the following):
1 = sticky (files: n/a; dirs: files in directory can be deleted only by their owners)
2 = setgid (files: run executable as file group; dirs: files inherit group from directory)
4 = setuid (files: run executable as file owner; dirs: n/a)
"User", "Group", "Other" digits for files:
0 = --- = no access
1 = --x = can execute the file as a program
2 = -w- = can write
3 = -wx = can write and execute
4 = r-- = can read
5 = r-x = can read and execute
6 = rw- = can read and write
7 = rwx = can read, write, execute
"User", "Group", "Other" digits for directories/folders:
0 = --- = no access
1 = --x = can read files in folder but not list contents
2 = -w- = n/a
3 = -wx = can create files but not list
4 = r-- = can list, but not read/write
5 = r-x = can list and read files
6 = rw- = n/a
7 = rwx = can read, write, list
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
when --ah-alg is not the default [none], all account passwords must be hashed
passwords can be hashed on the commandline with --ah-gen, but
copyparty will also hash and print any passwords that are non-hashed
(password which do not start with '+') and then terminate afterwards
if you have enabled --usernames then the password
must be provided as username:password for hashing
--ah-alg specifies the hashing algorithm and a
list of optional comma-separated arguments:
--ah-alg argon2 # which is the same as:
--ah-alg argon2,3,256,4,19
use argon2id with timecost 3, 256 MiB, 4 threads, version 19 (0x13/v1.3)
--ah-alg scrypt # which is the same as:
--ah-alg scrypt,13,2,8,4,32
use scrypt with cost 2**13, 2 iterations, blocksize 8, 4 threads,
and allow using up to 32 MiB RAM (ram=cost*blksz roughly)
--ah-alg sha2 # which is the same as:
--ah-alg sha2,424242
use sha2-512 with 424242 iterations
recommended: --ah-alg argon2
(takes about 0.4 sec and 256M RAM to process a new password)
argon2 needs python-package argon2-cffi,
scrypt needs openssl,
sha2 is always available
0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
the mDNS protocol is multicast-based, which means there are thousands
of fun and interesting ways for it to break unexpectedly
things to check if it does not work at all:
* is there a firewall blocking port 5353 on either the server or client?
(for example, clients may be able to send queries to copyparty,
but the replies could get lost)
* is multicast accidentally disabled on either the server or client?
(look for mDNS log messages saying "new client on [...]")
* the router/switch must be multicast and igmp capable
things to check if it works for a while but then it doesn't:
* is there a firewall blocking port 5353 on either the server or client?
(copyparty may be unable to see the queries from the clients, but the
clients may still be able to see the initial unsolicited announce,
so it works for about 2 minutes after startup until TTL expires)
* does the client have multiple IPs on its interface, and some of the
IPs are in subnets which the copyparty server is not a member of?
for both of the above intermittent issues, try --zm-spam 30
(not spec-compliant but nothing will mind)
eof