|
|
|
|
@ -1,74 +1,37 @@
|
|
|
|
|
<a href="https://xkcd.com/949/"><img src="http://imgs.xkcd.com/comics/file_transfer.png" alt="XKCD 949" width="30%" align="right" /></a> <img src="public/images/wordmark.png" alt="FilePizza wordmark" width="50%" /> <h3>Peer-to-peer file transfers in your browser</h3>
|
|
|
|
|
# FilePizza
|
|
|
|
|
|
|
|
|
|
*Cooked up by [Alex Kern](https://kern.io) & [Neeraj Baid](https://github.com/neerajbaid) while eating Sliver @ UC Berkeley.*
|
|
|
|
|
_Peer-to-peer file transfers in your browser_
|
|
|
|
|
|
|
|
|
|
Using [WebRTC](http://www.webrtc.org), FilePizza eliminates the initial upload step required by other web-based file sharing services. Because data is never stored in an intermediary server, the transfer is fast, private, and secure.
|
|
|
|
|
Using [WebRTC](http://www.webrtc.org/), FilePizza eliminates the need for intermediate servers when transferring files between two browsers. This makes the transfer faster, private, and no longer limited by server storage/bandwidth constraints.
|
|
|
|
|
|
|
|
|
|
A hosted instance of FilePizza is available at [file.pizza](https://file.pizza).
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
## What's new with FilePizza v2
|
|
|
|
|
Visit [file.pizza](https://file.pizza) to use the hosted version.
|
|
|
|
|
|
|
|
|
|
* A new UI with dark mode support, now built on modern browser technologies.
|
|
|
|
|
* Works on most mobile browsers, including Mobile Safari.
|
|
|
|
|
* Transfers are now directly from the uploader to the downloader's browser (WebRTC without WebTorrent) with faster handshakes.
|
|
|
|
|
* Uploaders can monitor the progress of the transfer and stop it if they want.
|
|
|
|
|
* Better security and safety measures with password protection and reporting.
|
|
|
|
|
* Support for uploading multiple files at once, which downloaders receive as a zip file.
|
|
|
|
|
* Streaming downloads with a Service Worker.
|
|
|
|
|
* Out-of-process storage of server state using Redis.
|
|
|
|
|
## Running locally
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ git clone https://github.com/kern/filepizza.git
|
|
|
|
|
$ pnpm install
|
|
|
|
|
$ pnpm dev
|
|
|
|
|
$ pnpm build
|
|
|
|
|
$ pnpm start
|
|
|
|
|
```bash
|
|
|
|
|
pnpm install
|
|
|
|
|
pnpm dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Running with Docker
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ pnpm docker:build
|
|
|
|
|
$ pnpm docker:up
|
|
|
|
|
$ pnpm docker:down
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Stack
|
|
|
|
|
|
|
|
|
|
* Next.js
|
|
|
|
|
* Tailwind
|
|
|
|
|
* TypeScript
|
|
|
|
|
* React
|
|
|
|
|
* PeerJS for WebRTC
|
|
|
|
|
* View Transitions
|
|
|
|
|
* Redis (optional)
|
|
|
|
|
## Environment variables
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
- `REDIS_URL` – Redis connection URL (defaults to `redis://localhost:6379`)
|
|
|
|
|
- `PEERJS_HOST` – PeerJS server hostname
|
|
|
|
|
- `PEERJS_PORT` – PeerJS server port
|
|
|
|
|
- `PEERJS_PATH` – PeerJS server path
|
|
|
|
|
- `COTURN_ENABLED` – When set to `true`, enables TURN support for connecting peers behind restrictive NATs.
|
|
|
|
|
- `COTURN_URL` – TURN server URL
|
|
|
|
|
- `COTURN_SECRET` – TURN server shared secret
|
|
|
|
|
- `COTURN_TTL` – TURN credential TTL in seconds
|
|
|
|
|
|
|
|
|
|
The server can be customized with the following environment variables:
|
|
|
|
|
## Docker
|
|
|
|
|
|
|
|
|
|
- `REDIS_URL` – Connection string for a Redis instance used to store channel metadata. If not set, FilePizza falls back to in-memory storage.
|
|
|
|
|
- `COTURN_ENABLED` – When set to `true`, enables TURN support for connecting peers behind NAT.
|
|
|
|
|
- `TURN_HOST` – Hostname or IP address of the TURN server. Defaults to `127.0.0.1`.
|
|
|
|
|
- `TURN_REALM` – Realm used when generating TURN credentials. Defaults to `file.pizza`.
|
|
|
|
|
- `STUN_SERVER` – STUN server URL to use when `COTURN_ENABLED` is disabled. Defaults to `stun:stun.l.google.com:19302`.
|
|
|
|
|
- `PEERJS_HOST` – Hostname or IP address to the self-hosted PeerJS server. Defaults to `0.peerjs.com`.
|
|
|
|
|
- `PEERJS_PATH` – Path to self-hosted PeerJS server. Defaults to `/`.
|
|
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
|
|
|
|
**How are my files sent?** Your files are sent directly from your browser to the downloader's browser. They never pass through our servers. FilePizza uses WebRTC to send files. This requires that the uploader leave their browser window open until the transfer is complete.
|
|
|
|
|
|
|
|
|
|
**Can multiple people download my file at once?** Yes! Just send them your short or long URL.
|
|
|
|
|
|
|
|
|
|
**How big can my files be?** As big as your browser can handle.
|
|
|
|
|
|
|
|
|
|
**What happens when I close my browser?** The URLs for your files will no longer work. If a downloader has completed the transfer, that downloader will continue to seed to incomplete downloaders, but no new downloads may be initiated.
|
|
|
|
|
|
|
|
|
|
**Are my files encrypted?** Yes, all WebRTC communications are automatically encrypted using public-key cryptography because of DTLS. You can add an optional password to your upload for an extra layer of security.
|
|
|
|
|
```bash
|
|
|
|
|
docker-compose up
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## License & Acknowledgements
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
FilePizza is released under the [BSD 3-Clause license](https://github.com/kern/filepizza/blob/main/LICENSE). A huge thanks to [iblowyourdesign](https://dribbble.com/iblowyourdesign) for the pizza illustration.
|
|
|
|
|
Copyright (c) 2024 kern. MIT License.
|
|
|
|
|
|
ChinhLee
2 months ago
committed by
GitHub