docs: add production setup instructions to README

Added a new section in the README for production setup. It highlights the usage of a process manager like systemd to ensure the application remains running in a production environment, providing a link to the systemd files included in the repository. This update aims to guide users in deploying the application more reliably.

2024-08-02 20:29:53 +02:00

3.4 KiB

Raw Blame History

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

Clone the repository:

git clone https://git.private.coffee/PrivateCoffee/transfer.coffee.git
cd transfer.coffee

Install the dependencies:

npm install

Optional, but recommended for production: Put the application (:8105) and the tracker (:8106) behind a reverse proxy (e.g. Caddy or nginx) and configure SSL.

Running the Application

Start the tracker:

npm run tracker

Create a .env file in the root directory of the project and set the environment variables:

TRACKER_URL="wss://tracker.your-domain.com" # URL of the WebTorrent tracker - default: ws://localhost:8106, use wss:// for secure connections
STUN_SERVER_URL="stun:stun.nextcloud.com:443" # Optional - there are public STUN servers available - not used if unset
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
TURN_SECRET="your-static-auth-secret" # Required if you have a TURN server - don't set this if you don't have one

If you are using a reverse proxy, you should set the TRACKER_URL to the URL of the tracker behind the reverse proxy, e.g. wss://tracker.your-domain.com.

The STUN and TURN server URLs should be set to the public URLs of your STUN and TURN servers, if you have them.

Start the application:

. .env
npm start

Open your browser and navigate to http://localhost:8105 (or the URL you have configured in your reverse proxy)

Production

For production, you should use a process manager like systemd to keep the application running. You can use the systemd files provided in contrib/systemd as a starting point.

Usage

Select a file to share using the file input.
Click the "Share" button.
Share the generated mnemonic seed with others.

Receiving a File

Enter the mnemonic seed in the input field.
Click the "Receive" button.
The file will be downloaded directly from the peer.

License

This project is licensed under the MIT License. See the LICENSE file for details.

3.4 KiB Raw Blame History