mirrors/copyparty
1
0
Fork 0
mirror of https://github.com/9001/copyparty.git synced 2025-08-17 09:02:15 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md Quickstart

Browse source 
Signed-off-by: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com>
This commit is contained in:
ChristophorusReyhan 2025-07-30 16:04:51 +07:00 committed by GitHub
parent c3cc2ddeae
commit 559f72770c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 56 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -144,6 +144,8 @@ made in Norway 🇳🇴
## quickstart ## quickstart
### 1-Line Install (Instant Run)
just run **[copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py)** -- that's it! 🎉 just run **[copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py)** -- that's it! 🎉
* or install through [pypi](https://pypi.org/project/copyparty/): `python3 -m pip install --user -U copyparty` * or install through [pypi](https://pypi.org/project/copyparty/): `python3 -m pip install --user -U copyparty`
@ -159,7 +161,60 @@ just run **[copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/
* or if you prefer to [use docker](./scripts/docker/) 🐋 you can do that too * or if you prefer to [use docker](./scripts/docker/) 🐋 you can do that too
* docker has all deps built-in, so skip this step: * docker has all deps built-in, so skip this step:
enable thumbnails (images/audio/video), media indexing, and audio transcoding by installing some recommended deps: ### Config-File Install (Recommended)
**1. Run Copyparty**
```bash
curl -O https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py
python copyparty-sfx.py
```
Or use the Windows binary:
```plaintext
https://github.com/9001/copyparty/releases/latest/download/copyparty.exe
```
Then open: http://127.0.0.1:3923
**2. Basic Usage**
By default, the current directory is shared with full read/write access.
**3. Use a Config File (Recommended)**
Create `config.conf`:
```yaml
[accounts]
alice: secret123
bob: hunter2
[/]
./shared
accs:
r: alice, bob
rw: alice
[/drop]
./dropbox
accs:
w: bob
```
Start with:
```bash
python copyparty-sfx.py -c config.conf
```
**4. Install Extras (Optional)**
See [Thumbnails Section](#thumbnails) for more
Ubuntu/Debian: `sudo apt install python3-pil ffmpeg`
Windows: `pip install --user Pillow` + add FFmpeg to PATH
**5. Expose Publicly (Optional)**
```bash
cloudflared tunnel --url http://127.0.0.1:3923
```
### thumbnails
Enable thumbnails (images/audio/video), media indexing, and audio transcoding by installing some recommended deps:
* **Alpine:** `apk add py3-pillow ffmpeg` * **Alpine:** `apk add py3-pillow ffmpeg`
* **Debian:** `apt install --no-install-recommends python3-pil ffmpeg` * **Debian:** `apt install --no-install-recommends python3-pil ffmpeg`