docs: add LICENSE and README files
Added an MIT LICENSE file to ensure proper open-source licensing and intellectual property protection. Created a README file detailing the purpose, features, installation, configuration, and usage of the Transfer.coffee application, facilitating user onboarding and project understanding.
This commit is contained in:
parent
70be1e0be3
commit
6b361e3839
GPG key ID:
ECBCC9082395383F
2 changed files with 105 additions and 0 deletions
19
LICENSE
Normal file
19
LICENSE
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
Copyright (c) 2024 Private.coffee Team <support@private.coffee>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
86
README.md
Normal file
86
README.md
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
# Transfer.coffee
|
||||||
|
|
||||||
|
[](https://private.coffee)
|
||||||
|
[](https://matrix.to/#/#private.coffee:private.coffee)
|
||||||
|
[](https://git.private.coffee/privatecoffee/transfer.coffee)
|
||||||
|
|
||||||
|
Transfer.coffee is a simple Node.js web application that allows users to share files using WebTorrent. Users can upload files, generate mnemonic seeds, and share these seeds with others to download the files directly via peer-to-peer connections. The application supports optional configuration of STUN and TURN servers to facilitate NAT traversal.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Peer-to-peer file sharing using WebTorrent
|
||||||
|
- Mnemonic seed generation for easy file sharing
|
||||||
|
- Optional STUN and TURN server configuration for NAT traversal
|
||||||
|
- Progress indicators for file upload and download
|
||||||
|
- Configurable tracker URL
|
||||||
|
- Bundled WebTorrent tracker
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Node.js (tested with v22.3 but anything recent should work)
|
||||||
|
- npm
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.private.coffee/PrivateCoffee/transfer.coffee.git
|
||||||
|
cd transfer.coffee
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install the dependencies:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Optional, but recommended for production: Put the application behind a reverse proxy (e.g. Caddy or nginx) and configure SSL.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
You can configure the application using environment variables:
|
||||||
|
|
||||||
|
- `TRACKER_URL`: The WebTorrent tracker URL (default: `ws://localhost:8106`)
|
||||||
|
- `STUN_SERVER_URL`: The STUN server URL (optional - not used if unset)
|
||||||
|
- `TURN_SERVER_URL`: The TURN server URL (optional - not used if unset)
|
||||||
|
- `TURN_SECRET`: The static-auth-secret for the TURN server (required if `TURN_SERVER_URL` is set)
|
||||||
|
|
||||||
|
## Running the Application
|
||||||
|
|
||||||
|
1. Start the tracker:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run tracker
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Set the environment variables and start the server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export TRACKER_URL="wss://tracker.your-domain.com" # URL of the WebTorrent tracker - default: ws://localhost:8106, use wss:// for secure connections
|
||||||
|
export STUN_SERVER_URL="stun:stun.nextcloud.com:443" # Optional - there are public STUN servers available - not used if unset
|
||||||
|
export TURN_SERVER_URL="turn:your-turn-server-url" # Optional - you would need to set up your own TURN server - don't set this if you don't have one
|
||||||
|
export TURN_SECRET="your-static-auth-secret" # Required if you have a TURN server - don't set this if you don't have one
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Open your browser and navigate to `http://localhost:3000`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Sharing a File
|
||||||
|
|
||||||
|
1. Select a file to share using the file input.
|
||||||
|
2. Click the "Share" button.
|
||||||
|
3. Share the generated mnemonic seed with others.
|
||||||
|
|
||||||
|
### Receiving a File
|
||||||
|
|
||||||
|
1. Enter the mnemonic seed in the input field.
|
||||||
|
2. Click the "Receive" button.
|
||||||
|
3. The file will be downloaded directly from the peer.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
Loading…
Reference in a new issue