Guide · Open source
How to use copyparty: install, share folders and upload files
Updated · written with AI from the project's own documentation and checked against our catalogue data
copyparty is an open-source, single-file file server that turns almost any device into a file server you can reach from a web browser. This guide shows you how to get the server running, what it can do besides web access, and where to look for permissions and advanced settings. By the end you will know how to start copyparty, reach it from a browser and decide whether its other protocols fit your use.
copyparty9001/copyparty · ★ 47.2k · MIT Install options & downloads Quick start
- 1Check Python. Confirm Python 2 or Python 3 is installed on the machine that will host the files.
- 2Download the server. Use the README quickstart command to download copyparty-sfx.py.
- 3Start copyparty. Run copyparty-sfx.py as the README quickstart describes, then note the address it prints.
- 4Open it in a browser. Visit the server address from another device on your network to see the file listing.
- 5Set folder permissions. Read the accounts and volumes section and restrict each folder to the users who need it.
- 6Enable extra protocols if needed. Add flags such as --ftp 3921 or --tftp 3969 only for the services you need.
What copyparty needs before you start
copyparty is a Python program. The README says the server only needs Python 2 or 3, and that all other dependencies are optional.
It is released under the MIT licence and is written in Python.
- A machine with Python 2 or Python 3 installed
- A way to download the single-file server (copyparty-sfx.py)
- Read the configuration docs before exposing it beyond your home network
Download and start the single-file server
The README quickstart says to run copyparty-sfx.py. The project describes this as the whole server in one file, so there is nothing else to install to get started. Download it with the command below, then run it with Python.
The README's quickstart is the authoritative source for the exact run command and its options, so check it before running the file.
wget https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.pyOpen the file server in a web browser
Once the server is running, you use it from any modern web browser. The README says copyparty works with almost any web browser and supports resumable uploads and downloads.
The README's table of contents lists browser features such as thumbnails, zip downloads, drag-and-drop uploading, file search and a media player.
- Drag files or folders into the browser to upload them
- Press g or the grid icon to toggle thumbnail grid view
- Download folders or file selections as zip or tar files
- Use the file manager to cut, paste, rename and delete (if you have permission)
- Create temporary share links for a file or folder
Control who can see and change each folder
Permissions and volumes are set per folder, and per user. The README's 'accounts and volumes' section covers this, and it is the part of copyparty that needs the most reading. Plan your folder layout before you share anything beyond your own computer.
Use the README's 'shadowing' section to hide specific subfolders, and 'dotfiles' for Unix-style hidden files.
- Decide which folders are public and which need a login
- Check the per-user permission settings in the accounts and volumes section
- Hide subfolders you do not want listed
Use WebDAV, SFTP, FTP or TFTP for other access
Besides the browser, the README lists WebDAV, SFTP, FTP, TFTP and SMB support. It says the FTP server can be started with the flag --ftp 3921, and that the TFTP server can be started with --tftp 3969.
The README describes the SFTP server as roughly 700 MiB/s, slower than WebDAV and FTP. The README also says SMB is unsafe, slow and not recommended over WAN, so keep it for trusted local networks.
- WebDAV: read-write support, useful for developers and some desktop file managers
- SFTP: an encrypted file transfer option
- FTP: started with --ftp 3921 according to the README
- TFTP: started with --tftp 3969 according to the README
- SMB: the README advises against using it over the internet
--ftp 3921Handle uploads that get interrupted
The main reason many people pick copyparty is resumable uploads. The README says uploads can resume after a dropped connection, so a large transfer does not need to restart from zero.
The README also covers deduplication, which it describes as symlink-based upload deduplication, and file indexing, which it says enables music search, upload undo and better deduplication. Both are optional server settings described in the README.
- Resumable uploads survive a dropped connection
- Unpost lets you undo accidental uploads
- Self-destruct gives uploads a lifetime
- Race the beam lets you download files while they are still uploading
Keep copyparty safe on a network
Do not treat copyparty as a hardened internet service without reading the docs. The README says SMB is unsafe and not recommended over WAN, and that its reverse-proxy and port 80 and 443 setups are covered in separate sections.
The README also has a 'hiding from google' section if you do not want search engines to index your server.
- Keep SMB on trusted local networks only
- Use the reverse-proxy section if you publish it through another web server
- Review the server config section for logging and version-checker options
What people use it for
- Sharing files from an old computer or NAS on a home network
- Letting people upload large files that may be interrupted, using resumable uploads
- Giving a developer WebDAV, SFTP or FTP access to a folder
- Running one portable script instead of installing a full file-sharing suite
- Browsing and downloading files from an e-book reader through the OPDS feeds the README lists
Frequently asked questions
Is copyparty free?
copyparty is released under the MIT licence, according to the README and the project information. The licence lets you use and modify it under its terms, so read the licence file in the project for the exact wording.
What do I need to run copyparty?
The README says the server needs only Python 2 or Python 3. All other dependencies are optional, so you can start with the single-file copyparty-sfx.py.
How do I install copyparty?
The README quickstart says to download copyparty-sfx.py from the project's releases page and run it. There is no separate installer described in the source.
Is copyparty safe to put on the internet?
The README says SMB is unsafe and not recommended over WAN, and it recommends reading the configuration docs for permissions. Treat it as something to configure carefully rather than a service you can expose with minimal setup.
How does copyparty compare to Nextcloud or Samba?
The source lists Nextcloud, FileBrowser, Samba and WebDAV servers such as rclone serve as comparable projects. copyparty aims to be a single portable script, while Nextcloud is a fuller platform, so pick based on whether you want one script or a larger product.
Can I use copyparty to upload large files that might fail?
Yes, the README describes resumable uploads and downloads that survive a dropped connection. This is one of the main features the project highlights.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
copyparty suits people who want a portable, single-file server for a home network, NAS or developer folder, and who are willing to read the permissions docs. If you need a managed cloud sync product with desktop clients, or a hardened internet-facing service with minimal setup, pick a different tool such as Nextcloud.
Install options & downloads