Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blenderskool/blaze
⚡ File sharing progressive web app built using WebTorrent and WebSockets
https://github.com/blenderskool/blaze
backend collaborate file-transfer frontend hacktoberfest node preact pwa-app sharing webrtc websockets webtorrent
Last synced: about 1 month ago
JSON representation
⚡ File sharing progressive web app built using WebTorrent and WebSockets
- Host: GitHub
- URL: https://github.com/blenderskool/blaze
- Owner: blenderskool
- License: mit
- Created: 2018-12-22T06:42:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T19:07:41.000Z (about 1 year ago)
- Last Synced: 2024-06-08T01:35:49.494Z (3 months ago)
- Topics: backend, collaborate, file-transfer, frontend, hacktoberfest, node, preact, pwa-app, sharing, webrtc, websockets, webtorrent
- Language: JavaScript
- Homepage: https://blaze.now.sh/
- Size: 3.25 MB
- Stars: 2,196
- Watchers: 30
- Forks: 272
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - blenderskool/blaze - ⚡ File sharing progressive web app built using WebTorrent and WebSockets (node)
- awesome-homelab - Blaze
README
Blaze - A P2P file sharing web app ⚡
Blaze is a file sharing progressive web app(PWA) that allows **users to transfer files between multiple devices.**
It works similar to SHAREit or the Files app by Google but uses web technologies to eliminate the process of installing
native apps for different devices and operating systems. It also supports instant file sharing with **multiple devices at once** which many file sharing apps lack.
Blaze primarily uses [WebTorrent](https://webtorrent.io) and WebSockets protocol (as a fallback) to transfer files between multiple devices. Files shared **via WebTorrent are peer-to-peer**(as they use WebRTC internally) which means there is direct transfer between the sender and receiver **without any intermediate server**. Do note that tracker servers in WebTorrent are used which carry metadata and facilitate the file transfer but do not get the complete file in any form.
### Features
- 💡 No account creation or signups.
- 🚀 One-to-One and Many-to-Many file transfers.
- 🔮 Works across different networks and devices.
- ⚡ Easy to use, and no app installation required.
- 📱 PWA for device-level integrations.
### Try it out!
- Go to a deployed client of Blaze - https://blaze.now.sh
- Set a basic nickname(this is not stored on any server)
- Create a new room. Room is where peers must join to share files among each other.
- On another device, follow the above steps and join the same room. (Make sure to give a different nickname)
- Both your devices should show up. Now start sharing some files!
Read more about how Blaze works at a basic level in this [Medium article](https://medium.com/@AkashHamirwasia/new-ways-of-sharing-files-across-devices-over-the-web-using-webrtc-2554abaeb2e6).
### Deploy your own instance of Blaze
Read more on [Deploying on your own server](#running-blaze-in-production)
## Sponsors
Blaze is sponsored by:
## Build process
- For the frontend, webpack is setup internally via preact-cli. Overrides can be made in `preact.config.js` file.
- For the backend, [sucrase](https://www.npmjs.com/package/sucrase) is used to transform ES modules imports/exports to CommonJS.
Environment variables
Following environment variables can be set in the build process:
| variable | description | default |
|----------------------|-----------------------------------------------------------------------|---------------------------------------------------|
| **client** | Variables for **client** should be set as build args if using Docker. | |
| `WS_HOST` | URL to the server that is running the Blaze WebSockets server. | 'ws://\:3030' |
| `SERVER_HOST` | URL to the server that running the Blaze HTTP server. | 'http://\:3030' |
| `WS_SIZE_LIMIT` | Max file size limit when transferring files over WebSockets in bytes. | 100000000 (100 MBs) |
| `TORRENT_SIZE_LIMIT` | Max file size limit when transferring files over WebTorrent in bytes. | 700000000 (700 MBs) |
| **server** | | |
| `ORIGIN` | Array of string URLs to allow CORS. | * |
| `PORT` | Port for the server to run. | 3030 |
| `WS_SIZE_LIMIT` | Max file size limit when transferring files over WebSockets in bytes. | 100000000 (100 MBs) |
| `DISABLE_SSE_EVENTS` | Disable server side events to reduce long-lived connections. | false |
| `TRUST_PROXY` | Whether server is behind a trusted proxy and can read forwarded IPs. | _false_ when standalone, _true_ in docker-compose |
----------------------------------------------------------------------------------------------------------------------------------------------------
**NOTE:** Any URL in the environment variables should not end with `/`.
## Running Blaze in production
Blaze can be easily deployed on your own server using Docker and `docker-compose`. The frontend and the backend is completely decoupled from each other.
### Docker images
Following Docker images are available:
- **[Blaze Server](https://hub.docker.com/r/akashhamirwasia/blaze-server)**: This is the backend Node.js server that is used for WebSockets communication. The environment variables listed for the server in previous section can be passed to the container. It exposes port `3030`.
- **[Blaze Client](https://hub.docker.com/r/akashhamirwasia/blaze-client)**: This is the frontend progressive web app of Blaze used by clients for sharing files. Nginx is used as a web server for this statically generated frontend. The environment variables listed above must be **passed as ARGS while building the image**. The frontend container exposes port `80`.
- **[Blaze](https://hub.docker.com/r/akashhamirwasia/blaze)**: This is a higher level image that includes both Blaze Server and Blaze Client images above. It must be used when docker-compose is not available in the environment, or there is a limit to run only a single container. docker-compose must be used to run Blaze in other cases which is explained in next section.
Running high level Blaze image
docker run -p 8080:80 -p 3030:3030 -e PORT=80 akashhamirwasia/blaze:latest
NOTE: The PORT environment variable and the container port should be the same.(In the above example, it is set as 80).
### Using docker-compose
A `docker-compose.yml` file is present at the root of this project which runs both the server and client containers and sets up a proxy for WebSocket connections on the frontend in Nginx configuration. To run using docker-compose:
```bash
git clone https://github.com/blenderskool/blaze
cd blaze
docker-compose up -d
```
### Directly via Node.js
**Building the frontend**
```bash
npm run build:fe
```
The frontend built code would be located in the `client/build` directory.
**Starting the server and frontend app**
```bash
npm start
```
Blaze app can now be accessed at port `8080` :tada:
## Privacy and Analytics
- Blaze server does not track or record the files that are being shared both by WebSockets and WebTorrent.
- Any user related data like nickname, room names are always stored on device, and are only shared with the server when the user joins a room for file sharing.
- Blaze client uses Google Analytics 4 to record the following:
- Part of [Basic visit data](https://support.google.com/analytics/answer/9234069?hl=en) - page views, scrolls and outbound clicks, rest are disabled.
- If Blaze PWA is installed on the device, and whether files are shared using share targets.
## Contributing
Documentation on contributing can be found in [CONTRIBUTING.md](https://github.com/blenderskool/blaze/blob/master/CONTRIBUTING.md)
## License
Blaze is [MIT Licensed](https://github.com/blenderskool/blaze/blob/master/LICENSE)