diff --git a/README.md b/README.md index e25346ae..5659b71b 100644 --- a/README.md +++ b/README.md @@ -1131,6 +1131,8 @@ see the top of [./copyparty/web/browser.css](./copyparty/web/browser.css) where ## complete examples +* [running on windows](./docs/examples/windows.md) + * read-only music server `python copyparty-sfx.py -v /mnt/nas/music:/music:r -e2dsa -e2ts --no-robots --force-js --theme 2` @@ -1313,11 +1315,13 @@ below are some tweaks roughly ordered by usefulness: * `--hist` pointing to a fast location (ssd) will make directory listings and searches faster when `-e2d` or `-e2t` is set * `--no-hash .` when indexing a network-disk if you don't care about the actual filehashes and only want the names/tags searchable * `--no-htp --hash-mt=0 --mtag-mt=1 --th-mt=1` minimizes the number of threads; can help in some eccentric environments (like the vscode debugger) -* `-j` enables multiprocessing (actual multithreading) and can make copyparty perform better in cpu-intensive workloads, for example: - * huge amount of short-lived connections +* `-j0` enables multiprocessing (actual multithreading), can reduce latency to `20+80/numCores` percent and generally improve performance in cpu-intensive workloads, for example: + * lots of connections (many users or heavy clients) * simultaneous downloads and uploads saturating a 20gbps connection ...however it adds an overhead to internal communication so it might be a net loss, see if it works 4 u +* using [pypy](https://www.pypy.org/) instead of [cpython](https://www.python.org/) *can* be 70% faster for some workloads, but slower for many others + * and pypy can sometimes crash on startup with `-j0` (TODO make issue) ## client-side diff --git a/docs/examples/windows.md b/docs/examples/windows.md index 34ccb4b0..58a6add9 100644 --- a/docs/examples/windows.md +++ b/docs/examples/windows.md @@ -16,12 +16,12 @@ open up notepad and save the following as `c:\users\you\documents\party.conf` (f ```yaml [global] lo: c:\users\you\logs\cpp-%Y-%m%d.xz # log to file - e2dsa, e2ts, no-dedup, z # sets 4 flags; see below + e2dsa, e2ts, no-dedup, z # sets 4 flags; see expl. p: 80, 443 # listen on ports 80 and 443, not 3923 theme: 2 # default theme: protonmail-monokai lang: nor # default language: viking -[accounts] +[accounts] # usernames and passwords kevin: shangalabangala # kevin's password [/] # create a volume available at / @@ -52,6 +52,7 @@ the `[global]` section accepts any config parameters you can see when running co * `e2dsa` enables the upload deduplicator and file indexer, which enables searching * `e2ts` enables music metadata indexing, making albums / titles etc. searchable too * `no-dedup` writes full dupes to disk instead of symlinking, since lots of windows software doesn't handle symlinks well + * but the improved upload speed from `e2dsa` is not affected * `z` enables zeroconf, making the server available at `http://HOSTNAME.local/` from any other machine in the LAN * `p: 80,443` listens on the ports `80` and `443` instead of the default `3923` * `lang: nor` sets default language to viking