Share a directory of files using WebRTC. For use with Figurl.
Prerequisite: NodeJS >= v16
pip install --upgrade rtcshare
rtcshare start --dir /path/to/directory/to/share --verbose
# Optionally add the --enable-remote-access option
# Optionally include plugins, for example --plugins isa,stan-playground
The console output will contain links for attaching to your service from within a web browser.
When the service is running with --enable-remote-access, Figurl can access files in your shared directory, as in this example:
A direct connection between peers is not always possible. In this case, a TURN server can be used to relay the data.
You can use a free TURN server for limited use from metered.ca. Sign up for an account, create a free app, and save the credentials. Then set the following environment variables prior to running rtcshare:
# The app name
export RTCSHARE_METERED_APP_NAME=...
# The API key
export RTCSHARE_METERED_APP_KEY=...In the future we will want to add support for using your own TURN server.