From c5c7080ec6b15ccb659bd5593d7f20c98308efde Mon Sep 17 00:00:00 2001 From: ed Date: Tue, 7 Sep 2021 21:57:33 +0200 Subject: [PATCH] more readme fixup --- README.md | 6 ++++++ docs/README.md | 16 +++++++++++++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d2bc2ce3..874f7368 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ turn your phone or raspi into a portable file server with resumable uploads/down * top * **[quickstart](#quickstart)** - download **[copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py)** and you're all set! + * [on servers](#on-servers) - you may also want these, especially on servers * [on debian](#on-debian) - recommended additional steps on debian * [notes](#notes) - general notes * [status](#status) - feature summary @@ -86,8 +87,13 @@ some recommended options: * see [accounts and volumes](#accounts-and-volumes) for the syntax and other access levels (`r`ead, `w`rite, `m`ove, `d`elete) * `--ls '**,*,ln,p,r'` to crash on startup if any of the volumes contain a symlink which point outside the volume, as that could give users unintended access + +### on servers + you may also want these, especially on servers: + * [contrib/systemd/copyparty.service](contrib/systemd/copyparty.service) to run copyparty as a systemd service +* [contrib/systemd/prisonparty.service](contrib/systemd/prisonparty.service) to run it in a chroot (for extra security) * [contrib/nginx/copyparty.conf](contrib/nginx/copyparty.conf) to reverse-proxy behind nginx (for better https) diff --git a/docs/README.md b/docs/README.md index 8edfe2ec..9abc5d1b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,21 @@ -# example `.epilogue.html` +**NOTE:** there's more stuff (sharex config, service scripts, nginx configs, ...) in [`/contrib/`](/contrib/) + + + +# example resource files + +can be provided to copyparty to tweak things + + + +## example `.epilogue.html` save one of these as `.epilogue.html` inside a folder to customize it: * [`minimal-up2k.html`](minimal-up2k.html) will [simplify the upload ui](https://user-images.githubusercontent.com/241032/118311195-dd6ca380-b4ef-11eb-86f3-75a3ff2e1332.png) -# example browser-css +## example browser-css point `--css-browser` to one of these by URL: * [`browser.css`](browser.css) changes the background @@ -19,4 +29,4 @@ point `--css-browser` to one of these by URL: * notes on using rclone as a fuse client/server ## [`example.conf`](example.conf) -* example config file for `-c` which never really happened +* example config file for `-c` (supports accounts, volumes, and volume-flags)