[Script request]: CopyParty

[mon5termatt]

Application Name

CopyParty

Website

https://github.com/9001/copyparty

Description

Honestly, I'm just going to drop this video because it would explain better than I ever could.

https://youtu.be/15_-hgsX2V0

Due Diligence

• I have searched existing scripts and found no duplicates.
• I have searched existing discussions and found no duplicate requests.

[MickLesk]

Please help me out here, is this really worth an LXC, or is it more of a plugin for existing systems?

I installed it on my DEV-LXC for Mealie (intentionally in /opt) and only have access to the existing and subordinate folders.

What would be the right thing to do? I see it more as a plugin like the file browser, but then there's the question of whether it should be located in /root, or where?

[MickLesk]

According to this statement, the tool should be a separate LXC rather than an add-on? I see it more as an addon for every LXC 🤔 (I've had it ready in the dev for over 2 weeks, but haven't merged it yet).

[Elyviere]

I don't really see why this would be a plugin? Is this not most closely related to Nextcloud, which have separate scripts for a VM and an LXC, but not as an addon. Why would I want to add a file sharing server as an addon to my existing LXCs?

[OscarBrad]

@Elyviere , is an addon not more flexible? I have been using copyparty both in its own container, but in one instance I wanted to move large number of small files from my friend's phone to one of my containers so I just installed it temporarily as an addon. IMO a full LXC is an oversimplification as copyparty.conf does require some tweaking post install anyway.

[Elyviere]

I suppose that's a good argument yea. It's easy enough to spin up a Debian LXC and run an addon command within it for those that want a standalone LXC. And that keeps the flexibility for those that just want to spin it up quickly in an existing system.

[MickLesk]

Perfect. Then i only make an addon. Its simply easier to handle and can be used on the host or in any LXC. I'll make sure I finish it this week (alpine is still missing), then I'll push it.

[ThisWasNotTaken]

i mean i think a plugin would be great and mabye using

https://github.com/9001/copyparty/blob/hovudstraum/contrib/systemd/copyparty.service

cause i cant make senes of this

[OscarBrad]

I can probably write a script to do so; I imagine an addon would be preferable to an LXC given copyparty is designed to run on anything? I am new to the community so unsure what the standard expectation is on how comprehensive the addon needs to be. The primary issue I forsee is that automating the instructions at the top of the sample service file is probably only a very bare bones setup. Reading the docs (and especially the chungus.conf ) is almost mandatory to get any value out of copyparty.

for now, steps to get copyparty running as a service (I did it on debian first, and then swapped to alpine for lower overhead). Here is my Alpine setup:

watered down sample config (/etc/copyparty.conf) . The video and docs will customize your own.

[global]
  # Basic Features
  e2dsa       # Enable file indexing
  ansi        # Colorful logs (easier debugging)
  z           # visible in file browsers
  e2ts        # scan newly discovered files for metadata on startup; sets -e2t (enable metadata indexing; makes it possible to search for artist/title/codec/resolution/etc)
  no-athumb    # disables spectograms for audio to save CPU 
  # re-dirsz   # if the directory-sizes in the UI are bonkers, use this along with -e2dsa to rebuild the index from scratch
  # re-dhash   # force a cache rebuild on startup; enable this once if it gets out of sync (should never be necessary)
  #qr         # useful while debugging network config   
  spinner: 🦐
  xvol        #ignore all symlinks leaving the volume's top directory, but still allow bind-mounts pointing elsewhere (as long as the user has access)

  #housekeeping
  #df: 1                  #don't allow uploads when there is under 1GB free disk space (make sure your disk is big enough first)
  no-robots, force-js    #might be nice to have.
  ban-url: 3,5,10080     # attempting to hit \.php$|(^|/)wp-(admin|content|includes)/ URLS 3 times within 5 minutes will bank you for a week
  
  # Logging (optional)
  q
  lo: /var/log/copyparty/%Y-%m%d.log.xz   # Compressed logs in /var/log/copyparty/

[accounts]
  # Format: username: password
  admin: password                # Full access
  guest: readonly                # less privleged user example

[groups]
 admins: admin

#storage locations
[/media]
  /mnt/media                   # Host path: /xxx/media
  accs:
    r: guest                     # guests can only read
    A: @admins                   # A = rwmda. 
  flags:
    grid                     #display files in a grid by default
    dedup                    #deduplication

Sample OpenRC service file ( /etc/init.d/copyparty)

#!/sbin/openrc-run

name="copyparty"
description="copyparty file server"
command="/usr/bin/python3"
command_args="/usr/local/bin/copyparty-sfx.py -c /etc/copyparty.conf"
command_user="copyparty:copyparty"
pidfile="/run/${RC_SVCNAME}.pid"
directory="/var/lib/copyparty"
export XDG_CONFIG_HOME="/var/lib/copyparty/.config"

depend() {
    need net
}

start_pre() {
    checkpath --directory --owner $command_user --mode 0755 "$directory"
    checkpath --directory --owner $command_user --mode 0755 /var/log/copyparty
}

start() {
    ebegin "Starting ${name}"
    start-stop-daemon --start --quiet \
        --pidfile "$pidfile" \
        --chuid "$command_user" \
        --exec "$command" -- $command_args &
    eend $?
}

stop() {
    ebegin "Stopping ${name}"
    start-stop-daemon --stop --quiet --pidfile "$pidfile"
    eend $?
}

In terminal

apk update
apk upgrade
apk add python3 py3-pip py3-pillow ffmpeg iptables

wget https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py \
    -O /usr/local/bin/copyparty-sfx.py

chmod +x /usr/local/bin/copyparty-sfx.py
chmod +x /etc/init.d/copyparty

addgroup -S copyparty
adduser -S -H -s /sbin/nologin -h /var/lib/copyparty -G copyparty copyparty

mkdir -p /var/lib/copyparty /var/log/copyparty /var/lib/copyparty/.config
chown -R copyparty:copyparty /var/lib/copyparty /var/log/copyparty

iptables -A INPUT -p tcp --dport 3923 -j ACCEPT
rc-update add iptables default
rc-update add copyparty default

reboot

very likely not the most optimal config as I am new to self hosting and have probably missed something important.

[Gangstrocity]

Commenting to add my support as well. Would love to see this as a script.

[Aareon]

Also very interested to see this added as an LXC

[MickLesk]

LXC is so useless, for what? Its only useful as plugin for existing LXC's - Own LXC decline. Its just an oneliner? Download python file and run?

[teohz]

TD;DR: I use it as a stand-alone "file server".

Personally, I use it as a replacement for all other "file-sharing" apps like gokapi - mainly because it's stupid easy to run and use, especially because you can push/pull directories and files using curl - so great for all other systems you have nothing on, but need to move some files or logs ad-hoc.

Also has the "share" dir you can set in authentik or other proxy to not require Auth, to share stuff outside the network.

So on the one hand, it can be used as a plugin, on the other, as a standalone server.
However, setting it up literally takes a few seconds really, but I guess, one could benefit from bootstrapping and some initial basic config with a running service.

[MickLesk]

PR Created:
#6929

Script can be tested in meanwhile here:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/tools/addon/copyparty.sh)"

[MickLesk]

Merged