wtshare/README.md

29 lines
809 B
Markdown
Raw Permalink Normal View History

2022-10-14 21:13:16 +00:00
# wtshare - WebTorrent Share
2022-10-15 09:36:58 +00:00
You can share files from the browser with P2P technology ([WebTorrents](https://webtorrent.io/)) without installing anything, there is no size limit
2022-10-14 21:13:16 +00:00
2022-10-15 09:36:58 +00:00
![wtshare](capture.png)
This project can be used with NodeJS only, but if you like you can use `docker` and `docker-compose` to deploy
## Configuration and Recommendations
- You need to set some variables in the `public/js/main.js` file to work properly
2022-10-16 20:36:18 +00:00
- `Warning`: be careful if you put this project into production, you are using a public local torrent tracker, look at the [bittorrent-tracker](https://github.com/webtorrent/bittorrent-tracker) options to filter connections, consider using it behind a proxy
2022-10-14 21:13:16 +00:00
2022-10-15 09:36:58 +00:00
## Build
2022-10-14 21:13:16 +00:00
```bash
docker-compose build --no-cache
```
2022-10-15 09:36:58 +00:00
## Run
2022-10-14 21:13:16 +00:00
```bash
docker-compose up -d
```
2022-10-15 09:36:58 +00:00
## License
2022-10-14 21:13:16 +00:00
2022-10-14 21:14:41 +00:00
MIT