Weblink

English Introduction | 中文介绍

Introduction

Weblink is a pure web-based file transfer and chat application built on WebRTC. It requires no downloads and works directly in your browser. Utilizing a serverless P2P architecture, it supports multiple backends including Firebase and WebSocket for efficient peer-to-peer connections. Additionally, Weblink ensures the privacy and security of signaling messages through end-to-end encryption.

The project is deployed on Vercel and can be accessed at https://web1ink.vercel.app.

Alternatively, you can use the version deployed on Alibaba Cloud at https://webl.ink.

Features

Weblink currently supports the following features:

Feature	Description
✅ File Synchronization	Retrieve cached files from the other party
✅ Resume Transfer	Resume file transfer if the connection is interrupted
✅ File Caching	Transferred files are cached in IndexedDB
✅ File Search	Search for files cached by you and the other party
✅ Video Calling	Supports video calls
✅ Clipboard Transfer	Press `Ctrl + V` in the chat window or paste in the input box on mobile devices to send clipboard content
✅ Folder Transfer	Send folders, which will be automatically compressed
✅ Compressed Transfer	Choose to compress files during transfer; files will be compressed in blocks and sent accordingly
✅ Multi-Channel Transfer	Improve transfer performance by parallel data transfer through multiple DataChannels
✅ Share and Forward	After installing as a PWA, you can send text or files via system sharing
✅ Text Chat	Send text messages for chatting

More information can be found in CHANGELOG.

Usage

Run Locally

git clone https://github.com/99percentpeople/weblink.git
cd weblink
pnpm install

Make sure you configure the Firebase keys in the project (as shown below), then run the following command:

# Development
pnpm dev
# Build
pnpm build

Deploy to Docker

You can deploy this project to Docker using docker-compose.yaml, and it will automatically build the weblink-ws-server as backend.

Modify the docker-compose.yaml file to set the correct environment variables. Then run the following command:

docker-compose up -d

To enable SSL you need to provide the SSL certificate cert.pem and key key.pem files in the docker/ssl directory. And run the following command:

ENABLE_SSL=true docker-compose up -d

Alternatively, you can also use Dockerfile to deploy this project to Docker.

Deploy to Vercel

To deploy this project to Vercel, follow these steps:

Go to the Vercel website and log in (or create an account).
Connect your GitHub repository and select the cloned repository.
In your Vercel project settings, find "Environment Variables" and add the Firebase API key and other environment variables (as shown below).
Click the "Deploy" button, and Vercel will automatically build and deploy your project.

Environment Variables Configuration (Firebase)

You will need to configure Firebase keys for both local development and deployment to Vercel. Add the following Firebase environment variables:

VITE_FIREBASE_API_KEY

VITE_FIREBASE_AUTH_DOMAIN

VITE_FIREBASE_PROJECT_ID

VITE_FIREBASE_STORAGE_BUCKET

VITE_FIREBASE_MESSAGING_SENDER_ID

VITE_FIREBASE_APP_ID

VITE_FIREBASE_DATABASE_URL

Vercel Environment Variables Configuration

For Vercel deployment, set the environment variables by following these steps:

Open your Vercel project and go to "Settings."
Find "Environment Variables."
Add the Firebase configuration items above and input the corresponding values.

WEBSOCKET Configuration

This application can deploy its own WEBSOCKET server, and a WEBSOCKET server is provided. You can choose to use it or not. For details, please refer to weblink-ws-server.

Local Environment Variables (.env.local)

For local development, create a .env.local file and add the Firebase keys:

# backend choose FIREBASE or WEBSOCKET

# FIREBASE
VITE_BACKEND=FIREBASE
VITE_FIREBASE_API_KEY=your-firebase-api-key
VITE_FIREBASE_AUTH_DOMAIN=your-firebase-auth-domain
VITE_FIREBASE_PROJECT_ID=your-firebase-project-id
VITE_FIREBASE_STORAGE_BUCKET=your-firebase-storage-bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your-firebase-messaging-sender-id
VITE_FIREBASE_APP_ID=your-firebase-app-id
VITE_FIREBASE_DATABASE_URL=your-database-url

# WEBSOCKET
VITE_BACKEND=WEBSOCKET
VITE_WEBSOCKET_URL=your-websocket-url

Notes

STUN and TURN Server Configuration

If you are using P2P connections outside a local area network (in a NAT environment), you may need to configure a TURN server to ensure connections are established. In the settings page, you can configure the TURN server with the following format, support coturn and Cloudflare TURN server, and separate multiple configurations with newline characters:

TURN Configuration Format:

# use coturn with account and password
turn:turn1.example.com:3478|user1|pass1|longterm
# use coturn with timestamp
turns:turn2.example.com:5349|user2|pass2|hmac
# use cloudflare turn server
name|TURN_TOKEN_ID|API_TOKEN|cloudflare

Here are some methods to get public STUN and TURN servers:

Public STUN Server

This application defaults to using Google's STUN server. If you cannot connect, please configure your own STUN server. You can refer to https://gist.github.com/mondain/b0ec1cf5f60ae726202e for a list of public STUN servers. Then add the stun server in format stun:xxxx:xxxx to the STUN server list in the settings page such as stun:stun.l.google.com:19302.

Cloudflare Calls TURN Server

You can use the TURN server provided by Cloudflare Calls, please visit https://developers.cloudflare.com/calls/turn. Then add the TURN server in format name|TURN_TOKEN_ID|API_TOKEN|cloudflare to the TURN server list in the settings page.

Self-Hosted STUN/TURN Server

You can refer to https://github.com/coturn/coturn to set up your own TURN server.

Use in LAN

The application currently supports LAN use in non-secure environments. Ensure that your devices are in the same LAN and the firewall does not block P2P connections.

And at the same time, run weblink-ws-server to support WEBSOCKET connections.

Contribution

Contributions are welcome! Please feel free to submit issues or pull requests.

License

This project is open-sourced under the MIT License.