introducing copyparty, the FOSS file server
I made a video about copyparty, the selfhosted fileserver I've been making for the past 5 years.
The main focus of the video is the features, but it also touches upon configuration. Was hoping it would be easier to follow than the readme on github... not sure how well that went, but hey :D
This video is also available to watch on the copyparty demo server, as a high-quality AV1 file and a lower-quality h264.
Your readme looks super in depth, thanks for that! I haven't watched the video yet but will later.
I didn't see it mentioned from a quick glance, but is either sftp or ftps supported?
SFTP is not currently on the roadmap, but it's not entirely implausible.
FTPS is supported, but it requires an optional dependency to be installed (pyopenssl), so it's not available in the Windows EXE. And I just realized that the dependency is currently not present inside the docker images either, so I'll get that fixed right away.
Screenshots of the ui at the top of the readme would be nice
Clearly a labour of love 👍
Maybe support for some music streaming apps (subsonic?) would be cool?
That's a neat idea -- I've heard that a lot of stuff uses the subsonic API under the hood, so I'll see what it would take to become compatible with that. At first glance it looks like I'd have to mine and index way more information about audio files, but could still be doable :>
Looking at and/or incorporating Navidrome might be helpful.
You made this on your phone on the bus ride to and from work.
I cleaned the cat box yesterday and considered that an accomplishment.
Fuck.
Hey fellow scener, cool project!
Just a few thoughts/questions:
BTRFS and ZFS support real deduplication via copy on write, and would eliminate all current disadvantages of symlink and hardlink deduplication. It just works.
yeah that's a good point, I'll add an option to take advantage of this if you know you're running on a filesystem where that works as intended.
Why have it be one huge python source file?
oh don't worry, it's all separate files during development -- there's a build-stage which bundles everything up into a single file for distribution. But thanks for the concern :D
Just a remark from someone who runs ZFS since the beginning. Many people don't like the deduplication feature because of its memory footprint.
It's also nice to have this feature without relying on a certain filesystem.
The fact you mention security features, without ever saying it's 'super secure' tells me you know a lot about what you're doing. I'm so sick of apps like this that start with "most secure app on the net" but you know they're delusional. Thank you, going to check this out.
Oh my god, this seems really good and closer to what I want than anything yet. Been looking for something to replace Nextcloud and found nothing good so I might take a look at this.
Just curious, why did you replace nextcloud? I'm looking into transitioning from my current file server, and I've mostly heard only good things and not NextCloud.
I want something with a permission model that works the same when accessed over a network share (SMB, ideally NFS) and access over a web interface. Ideally it would have a Mac File Provider sync client and whatever the Windows equivalent is called as well.
Nextcloud is fine but it’s not that.
I replaced nextCloud’s file sharing with Syncthing just recently, as I found myself only synchronising between two computers (one desktop, one smartphone) anyway. :-)
you even mention ladybird as browser, nice 😎
it's such an impressive project! Amazing what they've accomplished in so little time, and so important too -- we need as many options as we can get.
I agree but it's still in an early development state. Not really usable for everyday work let alone most people never heard about it 😅 But yeah still cool to mention it under "modern" browsers. I wish them good luck with the first alpha next year. I hope it'll be successful.
I would probably remove python 2 support, it was end of life when the project was started.
As long as it's not causing any issues or drawbacks for modern python versions (and it isn't), I don't see any reason to do that -- on the contrary, I know people are running copyparty on retro equipment, so I'd very much prefer to keep it for as long as possible :>
I don’t think there is a Python 2 version for retro equipment (DOS?). ;-)
Just because something is EOL doesn't make it useless.
So long as it's known and managed, it's fine.
This looks great but I really wish it had SFTP.
thanks for the vote, I hear ya :>
Can we have Gopher support?
I was thinking of that!! But then I realized that even Firefox removed gopher support by now, so the joke was dead on arrival :P
Firefox isn’t that great for FTP either. Gopher still exists :-) and I’d love to use it even more.
I'm properly in awe at this project. Not only does it support a wide range of protocols and runs practically everywhere, but it can play audio, video, display images and has keyboard shortcut support ???
It's got everything I could think about and so much more.
I can't wait to try it out !
Thank you so much for your time and for making this open source.
Thanks a lot for the kind words! ready to answer questions if you hit any bumps :>
Sometimes I feel so new to setting up my own digital ecosystem because I look at a thing and think "that's so cool" but struggle to imagine it at home. So could someone help me understand.
This would be a replacement for something like Google Drive or Proton Drive? The actions I would use this for would be:
So I would spin this up on my NAS or my main PC and replace those services and accomplish those actions using this software?
Are there other services or actions I'm missing? Am I misunderstanding the premise entirely?
I think Copyparty would be great for that purpose. The only thing you're missing is a way to expose it to the internet, such as a public IP or some tunnel
Yep! Depending on what your home connection looks like, you have a few options:
if you are lucky enough to have your own private IP-address and are able to open ports, then you're almost done already -- you can put copyparty on some port (or keep the default 3923), and then anyone could connect to it by going to https://your.ip.address:3923/
(with this approach, you will want to create your own HTTPS certificate so the traffic is properly encrypted -- the best option here is to get a domain and get a certificate for the domain)
however, if you are behind CGNAT, meaning your internet provider has given you a shared IP-address, then people cannot connect directly to your home-PC. One way around that issue is by setting up a machine somewhere on the internet which bridges the gap back home to your PC. Cloudflare offers this as service, and this is explained in the copyparty readme -- see the "at home" section for one way to do that.
if you are against using Cloudflare for idealistic reasons (they are becoming quite powerful since they run a whole lot of the internet), then you can set up a cheap VPS which serves the same purpose. That's my setup, and how you are accessing the copyparty demo server right now -- I have the cheapest VPS you can get from Hetzner. The VPS is running nginx, and it forwards the traffic to my homeserver through an SSH tunnel. I haven't documented this approach in the copyparty readme, but I have a feeling a lot of other people have :>
Oh yea, copyparty could do that. I might just do that too. My issue is more how do I grant them access to my network to get the thing tough? I currently use wireguard profiles and lock down where they can reach with rules and shit on a firewalla on a per account basis but that’s really complex and inelegant. It works and would working copypasta, but I kind of wish there was a simple webUI where I could define what a WireGuard user should be able to reach on my network with simple checkboxes by rules I have created over time. Probably wouldn’t tie into firewalla nicely though it could be more likely with OPNsense.
Hmm. Surely someone must have thought of that already. It would make adopting things like copypasta much simpler and less risky.
Oh my gawd what a README!! I'm on my phone and I was trying to scroll back to the top of it from the bottom and I just kept on scrolling... Holy shit I'm going to put this on my kanban board give it proper attention
At this rate might be faster to read code than a read me. Or convert to a wiki style if this much details are really needed.
Great job on something like this! I'll probably give it a whirl soon, I like Nextcloud but find it clunky sometimes because it's often a bit more than I need. Maybe breaking it up into Immich + this would help! Thank you for sharing your project!
One thing to note, your comparison against Nextcloud has a partially-incorrect point regarding file upload max size. The client does upload chunking, so is unaffected by the Cloudflare issue as well, but I believe the web client is still affected, just not the apps. https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html#adjust-chunk-size-on-nextcloud-side
I suspect a few others may be as well, but I'm only familiar with the Nextcloud one because that's what I've been running, and discovered in making sure I could still upload video files recorded while out and about.
Also love that it looks like a simpler install!
Thanks for the correction; confirmed that Nextcloud now does chunked uploading (with the web-client too). Fixed :>
Good luck, and let me know if you hit any issues o/
Alright, you bought me with this
Amazing presentation and nice that you have a demo!
I've been using copyparty for months, and it's just been an absolute gem. and the fact there are even iOS shortcuts to upload things you stumble across while doomscrolling is just icing on top.
This looks sick. Thanks for making and sharing it!
I’m in the market for a self hosted file server so I can use it as a destination for website backups. Absolutely going to give this a look next week. Thanks for posting about it!
Looks really cool. Might spin up a test bed to try.
I have a samba fileserver behind wireguard. Would copyparty be an improvement over samba?
If all you need is basic remote file storage such as a samba server, and especially if you need samba in particular, then your current solution is probably a better fit for you.
Copyparty's main selling points is the large number of features in one package, and being pretty good at receiving file uploads (usually faster than other alternatives), but it does not have good samba support. Instead of samba, copyparty has WebDAV support, so you can still connect to it from your file manager -- but the performance will be different; depending on your access pattern and the type of files, it could be faster or slower than samba.
I have a question, and I want to emphasise thar this is not criticism but a request for dive into technicalities.
In the video you mentioned copyparty has an one-way sync tool. Is there a good reason why it's not two-way, or is this just something you weren't motivated to do?
No worries, good question :>
The problem with bidirectional filesync is that it's an absolutely massive can of worms, very easy to mess up, and the consequences of messing up are usually the worst kind (loss of data). There's an insane amount of edgecases to keep in mind, and you need to get every edgecase right every single time, otherwise you might wipe someone's vacation photos, or suddenly downgrade someone's keepass database to an older version... And stuff like syncing multiple devices to the same server makes it balloon further.
I've started becoming more confident in copyparty's filesystem-index database, but it's still just a hint/guideline, with the filesystem being the only source of truth -- it's still not something I'd trust with tracking sync-state against one or more clients.
The bigger guys who offer bidirectional sync (nextcloud, syncthing, etc.) have spent years perfecting their logic, so I'd like to leave this in their capable hands.
Look cool! I think you should consider putting a screenshot of the UI somewhere near the top of the README
Haven't looked at the project yet, but that's just the greatest name for a fileserver...
Looks fantastic, I'll actually be trying this. Love how it doesn't lock my files into some obscure format like seafiles.
Very sleek project. The language switcher bit was brilliant hahaha. Seriously, good job.
This is very impressive and I'm highly likely to give it a whirl. My question is, though: would it be something that my very non-tech savvy wife could use?
Eg. I'm thinking setup the app on her phone with a default location and when she asks me for a file I can just tell her that I've "put it in the app", and she'll be able to easily retrieve it. Also same thing but vice versa, though the video seems to cover that via the Android share menu...
Again, super impressive. Good job!
I have a hunch that the true answer, to be honest, is "no" -- at least with the current UI as it is. I've come to terms with not being the best at making intuitive user interfaces, so I went all-in on making it poweruser-friendly and efficiency instead.
Yeah, there's the android app for sending files to the server, and it'll always send files to the same folder, so that part should be pretty solid. But actually grabbing files from the server, perhaps not so much. Not sure I'd risk it, but I'll leave the decision to you hehe
I'm not aware of any user-friendly android/iOS apps for connecting to a webdav / ftps / sftp server, but if those exist, then that would probably have been a good option!
Any way to run the server as a docker container?
Yep -- https://github.com/9001/copyparty/tree/hovudstraum/scripts/docker
Hopefully that description makes sense (let me know if it doesn't)
You can run absolutely anything as a docker container that you have the binary (and other files if needed), or you can go fancy and compile from source in docker.
Just create a dockerfile.
From (some base image you want to use like Ubuntu or Alpine)
Copy necessary files
Run the binary
You can run it straight from command line, put it in a docker compose file, or even tag it and upload it to a repository (and then reference that in your docker compose)
Now it would be interesting to setup a raspberry pi with harddrives plugged in the USB 3 ports💡
Wow! This is great. I may give it a shot.
Elderly raspberry pi B [✓]
Large portable drive gathering dust [✓]
Guess I'm setting up a locally hosted file server in the near future.
This is really impressive
Everyone loves CP. Tell all your friends about CP.
OMG! I've been looking for something like this for quite some time!
I will try this as soon as I have time. Thank you!
Hey! Just set this up today and it seems pretty good. Only issue I'm having is that is pretty slow to download (~2mb/s) what are some good ways to speed it up?
This looks nighsome as blossom!
Can you point me to the WebDAV code? I’m interested to see your implementation. There are some parts of the spec that are ambiguous, and I like to see how those are implemented in different servers.
sure! my implementation is really basic, just the stuff that's needed to make the clients i've tested happy, so there's probably still clients that won't be able to connect (And i'll fix those as soon as I hear about them!)
httpcli.py is the http methods handler, and the webdav-specific handlers are all next to eachother, propfind // proppatch // lock // unlock // mkcol // and there's also put for the uploads, but that's not entirely webdav-specific, just webdav-aware.
🤯