gfile

Direct file transfer over WebRTC

Build Status
Go Report Card
Codacy Badge
Coverage Status
License: MIT
Mentioned in Awesome Go

GFile

gfile is a WebRTC based file exchange software.

It allows to share a file directly between two computers, without the need of a third party.

ezgif-5-9936f8008e4d

Note

This project is still in its early stage.

How does it work ?

Schema

The STUN server is only used to retrieve informations metadata (how to connect the two clients). The data you transfer with gfile does not transit through it.

More informations here

Usage

Sender

gfile send --file filename
  • Run the command
  • A base64 encoded SDP will appear, send it to the remote client
  • Follow the instructions to send the client's SDP to your process
  • The file transfer should start

Receiver

# SDP being the base64 SDP gotten from the other client
echo "$SDP", gfile receive -o filename
  • Pipe the other client's SDP to gfile
  • A base64 encoded SDP will appear, send it to the remote client
  • The file transfer should start

Benchmark

gfile is able to benchmark the network speed between 2 clients (1 master and 1 slave) with the bench command.
For detailed instructions, see Sender and Receiver instructions.

This feature is still an experiment.

# Run as 'master'
gfile bench -m

# Run as 'slave'
echo "$SDP", gfile bench

Web Interface

A web interface is being developed via WebAssembly. It is currently not working.

Debug

In order to obtain a more verbose output, it is possible to define the logging level via the GFILE_LOG environment variable.

Example: export GFILE_LOG="TRACE"
See function setupLogger in main.go for more information

Contributors

Special thanks to Sean DuBois for his help with pion/webrtc and Yutaka Takeda for his work on pion/sctp

主要指标

概览
名称与所有者Antonito/gfile
主编程语言Go
编程语言Makefile (语言数: 4)
平台
许可证MIT License
所有者活动
创建于2019-03-08 06:02:16
推送于2023-02-25 02:39:13
最后一次提交2019-04-12 19:43:35
发布数3
最新版本名称v0.1.0 (发布于 )
第一版名称v0.0.1 (发布于 2019-03-09 20:52:08)
用户参与
星数754
关注者数16
派生数50
提交数68
已启用问题?
问题数7
打开的问题数4
拉请求数1
打开的拉请求数3
关闭的拉请求数0
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?