Add some faqs and edit readme

This commit is contained in:
schlagmichdoch 2023-01-25 10:43:00 +01:00
parent 70ff3f383d
commit 1278009706
3 changed files with 47 additions and 17 deletions

View file

@ -3,10 +3,10 @@
[PairDrop](https://pairdrop.net) is a sublime alternative to AirDrop that works on all platforms. [PairDrop](https://pairdrop.net) is a sublime alternative to AirDrop that works on all platforms.
It uses peer to peer connection in the same local network/Wi-Fi or with paired devices to send images, documents or text. It uses peer to peer connection in the same local network/Wi-Fi or with paired devices to send images, documents or text.
As it is web based, it runs on all devices including Android, Linux and Windows. As it is web based, it runs on all devices.
You want to quickly send a file from your iPhone to your Windows Laptop? You want to quickly send a file from your phone to your laptop?
<br>You want to share photos in original quality with friends using a mixture of Android and iOS? <br>You want to share photos in original quality with friends that use a mixture of Android and iOS?
<br>You want to share private files peer to peer between Linux systems? <br>You want to share private files peer to peer between Linux systems?
<br>AirDrop is unreliable again? <br>AirDrop is unreliable again?
<br>_Send it with PairDrop!_ <br>_Send it with PairDrop!_
@ -17,21 +17,22 @@ Developed based on [Snapdrop](https://github.com/RobinLinus/snapdrop)
### Device Pairing ### Device Pairing
* Pair devices via 6-digit code or QR-Code * Pair devices via 6-digit code or QR-Code
* Pair devices outside your local network or in complex network environment (public wifi, company network, Apple Private Relay, VPN etc.). * Pair devices outside your local network or in complex network environment (public Wi-Fi, company network, Apple Private Relay, VPN etc.).
* Connect to devices on your mobile hotspot.
* Paired devices will always find each other via shared secrets even after reopening the browser or the Progressive Web App * Paired devices will always find each other via shared secrets even after reopening the browser or the Progressive Web App
* You will always discover devices on your local network. Paired devices are shown additionally. * You will always discover devices on your local network. Paired devices are shown additionally.
* Paired devices outside your local network that are behind a NAT are connected automatically via [Open Relay: Free WebRTC TURN Server](https://www.metered.ca/tools/openrelay/) * Paired devices outside your local network that are behind a NAT are connected automatically via [Open Relay: Free WebRTC TURN Server](https://www.metered.ca/tools/openrelay/)
### [Improved UI for sending/receiving files](https://github.com/RobinLinus/snapdrop/issues/560) ### [Improved UI for sending/receiving files](https://github.com/RobinLinus/snapdrop/issues/560)
* The receiving peer must accept the request of files **before** they are transferred and downloaded automatically afterwords if possible * Files are transferred only after a request is accepted first. On transfer completion they are downloaded automatically if possible.
* Multiple files are downloaded as ZIP file * Multiple files are downloaded as ZIP file
* On iOS and Android the devices share menu is opened instead of downloading the files * On iOS and Android the devices share menu is opened instead of downloading the files
* Multiple files are transferred at one archive which shows the overall progress correctly * Multiple files are transferred at once with an overall progress indicator
* The integrity of the files is checked on receive * The integrity of the files is checked on receive
* By zipping the files before sending, all metadata is preserved * All metadata is preserved
### Share Files Directly From Share / Context Menu ### Share Files Directly From Share / Context Menu
* [Share files directly form context menu on Windows](/docs/how-to.md#share-files-directly-form-context-menu-on-windows) * [Share files directly from context menu on Windows](/docs/how-to.md#share-files-directly-from-context-menu-on-windows)
* [Share directly from share menu on iOS](/docs/how-to.md#share-directly-from-share-menu-on-ios) * [Share directly from share menu on iOS](/docs/how-to.md#share-directly-from-share-menu-on-ios)
* [Share directly from share menu on Android](/docs/how-to.md#share-directly-from-share-menu-on-android) * [Share directly from share menu on Android](/docs/how-to.md#share-directly-from-share-menu-on-android)
@ -41,9 +42,9 @@ Developed based on [Snapdrop](https://github.com/RobinLinus/snapdrop)
* [Prevent devices from sleeping on file transfer](https://github.com/RobinLinus/snapdrop/pull/413) * [Prevent devices from sleeping on file transfer](https://github.com/RobinLinus/snapdrop/pull/413)
* Open PairDrop on multiple tabs simultaneously (Thanks [@willstott101](https://github.com/willstott101)) * Open PairDrop on multiple tabs simultaneously (Thanks [@willstott101](https://github.com/willstott101))
* [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (Thanks [@victorwads](https://github.com/victorwads)) * [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (Thanks [@victorwads](https://github.com/victorwads))
* node-only implementation (Thanks [@Bellisario](https://github.com/Bellisario)) * Node-only implementation (Thanks [@Bellisario](https://github.com/Bellisario))
* automatic restart on error (Thanks [@KaKi87](https://github.com/KaKi87)) * Automatic restart on error (Thanks [@KaKi87](https://github.com/KaKi87))
* lots of stability fixes (Thanks [@MWY001](https://github.com/MWY001) [@skiby7](https://github.com/skiby7) and [@willstott101](https://github.com/willstott101)) * Lots of stability fixes (Thanks [@MWY001](https://github.com/MWY001) [@skiby7](https://github.com/skiby7) and [@willstott101](https://github.com/willstott101))
* To host PairDrop on your local network (e.g. on Raspberry Pi): [All peers connected with private IPs are discoverable by each other](https://github.com/RobinLinus/snapdrop/pull/558) * To host PairDrop on your local network (e.g. on Raspberry Pi): [All peers connected with private IPs are discoverable by each other](https://github.com/RobinLinus/snapdrop/pull/558)
## Screenshots ## Screenshots

View file

@ -11,16 +11,34 @@
* [Producthunt](https://www.producthunt.com/posts/snapdrop) * [Producthunt](https://www.producthunt.com/posts/snapdrop)
### Help! I can't install the PWA! ### Help! I can't install the PWA!
if you are using a Chromium-based browser (Chrome, Edge, Brave, etc.), you can easily install PairDrop PWA on your desktop by clicking the install button in the top-right corner while on [pairdrop.net](https://pairdrop.net) (see below). if you are using a Chromium-based browser (Chrome, Edge, Brave, etc.), you can easily install PairDrop PWA on your desktop
<img src="pwa-install.png"> by clicking the install-button in the top-right corner while on [pairdrop.net](https://pairdrop.net).
### On iOS received images cannot be added to the gallery! <img src="pwa-install.png" alt="Example on how to install a pwa with Edge">
On Firefox, PWAs are installable via [this browser extensions](https://addons.mozilla.org/de/firefox/addon/pwas-for-firefox/)
### Are there any shortcuts?
Sure!
- Send a message with `CTRL + ENTER`
- Close all send and pair dialogs by pressing `Escape`.
- Copy a received message to clipboard with `CTRL/⌘ + C`.
- Accept file transfer request with `Enter` and decline with `Escape`.
### When I receive images on iOS I cannot add them directly to the gallery?
Apparently, iOS does not allow images shared from a website to be saved to the gallery directly. Apparently, iOS does not allow images shared from a website to be saved to the gallery directly.
It simply does not offer the option for images shared from a website.
Shortcuts to win: iOS Shortcuts to the win:
I created a simple iOS shortcut, that takes your photos and saves them to your gallery: I created a simple iOS shortcut that takes your photos and saves them to your gallery:
https://routinehub.co/shortcut/13988/ https://routinehub.co/shortcut/13988/
### Is it possible to share files directly from the context / share menu?
Yes it finally is!
* [Share files directly from context menu on Windows](/docs/how-to.md#share-files-directly-from-context-menu-on-windows)
* [Share directly from share menu on iOS](/docs/how-to.md#share-directly-from-share-menu-on-ios)
* [Share directly from share menu on Android](/docs/how-to.md#share-directly-from-share-menu-on-android)
### What about the connection? Is it a P2P-connection directly from device to device or is there any third-party-server? ### What about the connection? Is it a P2P-connection directly from device to device or is there any third-party-server?
It uses a P2P connection if WebRTC is supported by the browser. WebRTC needs a Signaling Server, but it is only used to establish a connection and is not involved in the file transfer. It uses a P2P connection if WebRTC is supported by the browser. WebRTC needs a Signaling Server, but it is only used to establish a connection and is not involved in the file transfer.
@ -35,6 +53,17 @@ If your devices are paired and behind a NAT, the public TURN Server from [Open R
### What about security? Are my files encrypted while being sent between the computers? ### What about security? Are my files encrypted while being sent between the computers?
Yes. Your files are sent using WebRTC, which encrypts them on transit. Yes. Your files are sent using WebRTC, which encrypts them on transit.
### Transferring many files with paired devices takes too long
Naturally, if traffic needs to be routed through the turn server transfer speed decreases.
As a workaround you can open a hotspot on one of your devices to bridge the connection which makes transfers much faster.
- [How to open a hotspot on Windows](https://support.microsoft.com/en-us/windows/use-your-windows-pc-as-a-mobile-hotspot-c89b0fad-72d5-41e8-f7ea-406ad9036b85#WindowsVersion=Windows_11)
- [How to open a hotspot on Mac](https://support.apple.com/guide/mac-help/share-internet-connection-mac-network-users-mchlp1540/mac)
- [Library to open a hotspot on Linux](https://github.com/lakinduakash/linux-wifi-hotspot)
You can also use mobile hotspots on phones to do that.
Then, all data should be sent directly between devices and your data plan should not be charged.
### Why don't you implement feature xyz? ### Why don't you implement feature xyz?
Snapdrop and PairDrop are a study in radical simplicity. The user interface is insanely simple. Features are chosen very carefully because complexity grows quadratically since every feature potentially interferes with each other feature. We focus very narrowly on a single use case: instant file transfer. Snapdrop and PairDrop are a study in radical simplicity. The user interface is insanely simple. Features are chosen very carefully because complexity grows quadratically since every feature potentially interferes with each other feature. We focus very narrowly on a single use case: instant file transfer.
We are not trying to optimize for some edge-cases. We are optimizing the user flow of the average users. Don't be sad if we decline your feature request for the sake of simplicity. We are not trying to optimize for some edge-cases. We are optimizing the user flow of the average users. Don't be sad if we decline your feature request for the sake of simplicity.

View file

@ -1,5 +1,5 @@
# How-To # How-To
## Share files directly form context menu on Windows ## Share files directly from context menu on Windows
### Registering to open files with PairDrop ### Registering to open files with PairDrop
The [File Handling API](https://learn.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/how-to/handle-files) is implemented The [File Handling API](https://learn.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/how-to/handle-files) is implemented