> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/9001/copyparty/llms.txt > Use this file to discover all available pages before exploring further. # Volume Flags > Per-volume configuration options and flags in copyparty Volflags are per-volume configuration options. Many global options can be set as volflags, and most volflags can also be set as global options. See the [complete list of volflags](https://copyparty.eu/cli/#flags-help-page) for all available options. ## Syntax Volflags are specified in the `flags:` section of a volume configuration: ```yaml theme={null} [/volume] /path/to/folder accs: rw: user flags: e2d # simple boolean flag fk: 4 # flag with value scan: 60 # another flag with value ``` ## Upload Configuration ### Deduplication Enable symlink-based file deduplication When enabled, duplicate uploads create symlinks instead of storing the file again. ```yaml theme={null} flags: dedup safededup: 50 # verify file contents before dedup ``` Enable hardlink-based deduplication, fallback to symlinks when impossible Dedup with hardlink only, never symlink. Make full copy if hardlink impossible. Enable reflink-based deduplication (CoW filesystems), fallback to full copy when impossible How careful to be when deduplicating: * `1` = just verify filesize * `50` = verify file contents have not been altered (default) Reject duplicate files during upload (only matches within same volume) ```yaml theme={null} flags: e2d # required for dupe detection nodupe # reject duplicates ``` Also reject dupes when moving a file into another volume Don't use existing data on disk for dupes. Reduces HDD reads but increases network load. ### Upload Rules Maximum number of uploads in a time period ```yaml theme={null} flags: maxn: 250,600 # max 250 uploads over 10 minutes (600 seconds) ``` Maximum upload bytes in a time period ```yaml theme={null} flags: maxb: 1g,300 # max 1 GiB over 5 minutes ``` Suffixes: `b`, `k`, `m`, `g`, `t` Total volume size limit ```yaml theme={null} flags: vmaxb: 10g # volume cannot exceed 10 GiB total ``` Maximum number of files in volume ```yaml theme={null} flags: vmaxn: 4k # max 4096 files in volume ``` Allow filesizes within range ```yaml theme={null} flags: sz: 1k-3m # only accept files between 1 KiB and 3 MiB ``` Ensure free disk space by rejecting uploads ```yaml theme={null} flags: df: 1g # ensure at least 1 GiB remains free ``` ### Upload Behavior Force randomized filenames, 9 characters long by default ```yaml theme={null} flags: rand nrand: 12 # make random filenames 12 chars long ``` Length of randomized filenames When to overwrite existing files: * `0` = never (generate new filename) * `1` = if client file is newer * `2` = always overwrite ```yaml theme={null} flags: u2ow: 1 # overwrite if newer ``` How to timestamp uploaded files: * `c` = client last-modified time * `u` = upload time (server time) * `fc` = force client time * `fu` = force upload time ```yaml theme={null} flags: u2ts: fc # always use client timestamp ``` Enable filetype detection for nameless uploads Filename template for nameless uploads ```yaml theme={null} flags: put_name: upload-{now}.bin ``` Force all uploads into the top folder of the volume (prevent subdirectories) Delete unfinished uploads when they timeout (after `--snap-drop` period) ### Upload Rotation Move uploads into organized folder structures automatically. Organize by number of files per folder ```yaml theme={null} flags: rotn: 100,3 # 3 levels of subfolders with 100 entries each ``` Example: `file-1234.jpg` → `12/34/file-1234.jpg` Organize by date/time format ```yaml theme={null} flags: rotf: %Y-%m/%d-%H # organize by year-month/day-hour rotf_tz: Europe/Oslo # timezone (default: UTC) ``` Example: Upload at 2026-03-03 14:30 → `2026-03/03-14/file.jpg` Timezone for `rotf` date formatting Examples: `Europe/Oslo`, `America/Toronto`, `Asia/Tokyo` Auto-delete uploads after N seconds ```yaml theme={null} flags: lifetime: 3600 # files deleted after 1 hour ``` Clients can specify shorter lifetimes when uploading. ### File Permissions Unix permissions for new files ```yaml theme={null} flags: chmod_f: 644 # owner RW, others R chmod_f: 600 # owner RW only ``` Unix permissions for new directories ```yaml theme={null} flags: chmod_d: 755 # owner RWX, others RX chmod_d: 2750 # setgid + owner RWX, group RX ``` Unix user-id to chown new files/folders to (-1 = don't change) Unix group-id to chown new files/folders to (-1 = don't change) Allow uploading even if volume is inside a ramdisk All uploaded data will be lost on server reboot! ### Compression Allow server-side gzip compression of uploads with `?gz` URL parameter Allow server-side lzma compression of uploads with `?xz` URL parameter Force server-side compression (optional: specify algorithm and level) ```yaml theme={null} flags: pk: xz,9 # force LZMA compression at level 9 ``` ## Database Configuration ### Indexing Enable database; makes files searchable and enables upload-undo Scan writable folders for new files on startup (also sets `e2d`) Scan all folders for new files on startup (also sets `e2d`) Enable multimedia indexing (audio/video tags) Scan existing files for tags on startup (also sets `e2t`) Delete all metadata from DB for full rescan (also sets `e2ts`) Disable metadata collection (overrides `-e2t*`) Recommended for security when accepting uploads from untrusted users. Disable all database features (overrides all `-e2*`) ### Database Location Location for thumbnails and database ```yaml theme={null} flags: hist: /tmp/cdb # put .hist folder at /tmp/cdb ``` Location for database only (keep thumbnails in volume) ```yaml theme={null} flags: dbpath: /ssd/music-db # database on fast SSD ``` Disable database if specified file doesn't exist ```yaml theme={null} flags: landmark: .enable-db # DB disabled if .enable-db missing ``` ### Database Behavior Scan for new files every N seconds ```yaml theme={null} flags: scan: 60 # rescan every 60 seconds ``` Skip hashing files matching regex pattern ```yaml theme={null} flags: nohash: \.iso$ # don't hash *.iso files ``` Fully ignore files matching regex pattern ```yaml theme={null} flags: noidx: /\.(git|svn)/ # ignore git/svn folders ``` Don't forget files when deleted from disk (keep in database) Forget uploader IP after N seconds (GDPR compliance) ```yaml theme={null} flags: forget_ip: 43200 # forget IPs after 12 hours ``` Never store uploader IP in database (disables unpost feature) Database speed-durability tradeoff: * `acid` = safest, slowest * `swal` = safe, fast * `wal` = balanced (default) * `yolo` = fastest, data loss possible ```yaml theme={null} flags: dbd: yolo # maximum performance, minimal safety ``` Cross-volume dupe detection/linking Dangerous - can create links outside volume boundaries! Don't descend into other filesystems during scanning Don't follow symlinks leaving the volume root ## Filekeys and Dirkeys Generate per-file access keys (N characters long) ```yaml theme={null} [/private] /mnt/private accs: g: * # anyone with URL+key can download rw: admin flags: fk: 4 # 4-character keys ``` Keys are invalidated if filesize or inode changes. Example URL: `https://example.com/file.jpg?k=Ab3D` Generate slightly weaker per-file keys (not affected by filesize/inode) Better for files that may be modified. Generate per-directory access keys ```yaml theme={null} flags: dk: 6 # 6-character directory keys dks # allow browsing into subdirs ``` Per-directory keys allow browsing into subdirectories Allow seeing files (not folders) in a directory with `g` permission without valid dirkey ## Thumbnails Disable all thumbnails Disable video thumbnails only Disable audio thumbnails (spectrograms) only Disable image thumbnails only Thumbnail resolution (WxH) ```yaml theme={null} flags: thsize: 320x240 ``` Center-cropping behavior: `y`, `n`, `fy`, `fn` 3x resolution thumbnails: `y`, `n`, `fy`, `fn` WebP/JPEG thumbnail quality (10-90) Convert-to-image timeout in seconds Convert-to-audio timeout in seconds Make spectrograms: * `0` = never * `1` = fallback if no thumbnail available * `2` = always Use custom thumbnail for file extension ```yaml theme={null} flags: ext_th: exe=/icons/exe.png ext_th: pdf=/icons/pdf.svg ``` ## Client and UX Show grid/thumbnails view by default Enable selecting files in grid by ctrl-click Default sort order ```yaml theme={null} flags: sort: href # sort by filename (default) ``` Natural-sort of leading digits in filenames (e.g., file2 before file10) Don't list files matching regex ```yaml theme={null} flags: unlist: ^\. ``` Force-download files on click (no inline preview) Don't show total folder size (\~30% faster listings) Who can see disk usage info: * `no` = nobody * `a` = admin permission * `rw` = read-write access * `w` = write access * `auth` = authenticated users * `all` = everyone Per-volume favicon URL ```yaml theme={null} flags: ufavico: /icons/music.ico ``` Theme color (hint for browsers, discord embeds) ```yaml theme={null} flags: tcolor: #fc0 ``` ## Document Embedding Files to embed as readmes ```yaml theme={null} flags: readmes: README.md,readme.txt,info.md ``` Files to embed as preadmes (before file listing) Files to embed above/before files Files to embed below/after files Write-only users can upload prologues/epilogues without getting renamed ## Security Return HTML and markdown as text/plain (prevents XSS) ```yaml theme={null} [/uploads] /mnt/uploads accs: w: * # untrusted uploads flags: nohtml # prevent XSS attacks ``` Allow indexing by search engines (default) Ask search engines not to index this volume Show dotfiles in search results (if user can see dotfiles) Allow all users with read-access to enable showing dotfiles in listings ## Other Features Enable RSS feeds (add `?rss` to folder URL) Enable OPDS feeds for e-book readers Who can create shares: * `no` = nobody * `a` = admin permission * `auth` = authenticated users Restrict download-as-zip/tar access (0=nobody, 1=admins, 2=everyone) Reject zip download if more than N files ```yaml theme={null} flags: zipmaxn: 9k # max 9000 files in zip ``` Reject zip download if total size exceeds limit ```yaml theme={null} flags: zipmaxs: 2g # max 2 GiB zip ``` Don't create volume's folder if it doesn't exist Crash on startup if volume's folder doesn't exist ## Complete Example ```yaml theme={null} [/music] /mnt/music accs: r: * rw: admin flags: # Database e2dsa # scan all on startup e2ts # index audio tags scan: 300 # rescan every 5 minutes hist: /ssd/music-cache # Thumbnails dathumb # no audio spectrograms thsize: 320x320 th_qv: 60 # higher quality thumbnails # Client UX grid # show thumbnails by default sort: n # sort by filename nsort # natural number sorting # Features rss # enable RSS feeds robots # allow search engines ```