From 395e3386b7f627831fd96a9d6326bb6099ebc934 Mon Sep 17 00:00:00 2001 From: ed Date: Sat, 2 Dec 2023 23:32:31 +0000 Subject: [PATCH] mention --help for features not documented in readme plus some small fixes to the packaging section --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5c09ac7c..a104877e 100644 --- a/README.md +++ b/README.md @@ -148,9 +148,10 @@ you may also want these, especially on servers: * [contrib/systemd/copyparty.service](contrib/systemd/copyparty.service) to run copyparty as a systemd service (see guide inside) * [contrib/systemd/prisonparty.service](contrib/systemd/prisonparty.service) to run it in a chroot (for extra security) +* [contrib/openrc/copyparty](contrib/openrc/copyparty) to run copyparty on Alpine / Gentoo * [contrib/rc/copyparty](contrib/rc/copyparty) to run copyparty on FreeBSD -* [contrib/nginx/copyparty.conf](contrib/nginx/copyparty.conf) to [reverse-proxy](#reverse-proxy) behind nginx (for better https) * [nixos module](#nixos-module) to run copyparty on NixOS hosts +* [contrib/nginx/copyparty.conf](contrib/nginx/copyparty.conf) to [reverse-proxy](#reverse-proxy) behind nginx (for better https) and remember to open the ports you want; here's a complete example including every feature copyparty has to offer: ``` @@ -341,7 +342,7 @@ upgrade notes * yes, using [hooks](https://github.com/9001/copyparty/blob/hovudstraum/bin/hooks/wget.py) * i want to learn python and/or programming and am considering looking at the copyparty source code in that occasion - ```bash + * ```bash _| _ __ _ _|_ (_| (_) | | (_) |_ ``` @@ -823,6 +824,9 @@ using arguments or config files, or a mix of both: * or click the `[reload cfg]` button in the control-panel if the user has `a`/admin in any volume * changes to the `[global]` config section requires a restart to take effect +**NB:** as humongous as this readme is, there is also a lot of undocumented features. Run copyparty with `--help` to see all available global options; all of those can be used in the `[global]` section of config files, and everything listed in `--help-flags` can be used in volumes as volflags. +* if running in docker/podman, try this: `docker run --rm -it copyparty/ac --help` + ## zeroconf @@ -1365,15 +1369,19 @@ note: the following metrics are counted incorrectly if multiprocessing is enable the party might be closer than you think +if your distro/OS is not mentioned below, there might be some hints in the [«on servers»](#on-servers) section + ## arch package now [available on aur](https://aur.archlinux.org/packages/copyparty) maintained by [@icxes](https://github.com/icxes) +it comes with a [systemd service](./contrib/package/arch/copyparty.service) and expects to find one or more [config files](./docs/example.conf) in `/etc/copyparty.d/` + ## fedora package -now [available on copr-pypi](https://copr.fedorainfracloud.org/coprs/g/copr/PyPI/) , maintained autonomously -- [track record](https://copr.fedorainfracloud.org/coprs/g/copr/PyPI/package/python-copyparty/) seems OK +now [available on copr-pypi](https://copr.fedorainfracloud.org/coprs/g/copr/PyPI/) , autogenerated from pypi by fedora -- [track record](https://copr.fedorainfracloud.org/coprs/g/copr/PyPI/package/python-copyparty/) seems OK ```bash dnf copr enable @copr/PyPI