Be aware, this is a Beta version, which might have some issues or not work as expected in all browsers.
Winden is a free web application for secure, fast, and easy file transfers between devices in real-time. Winden is identity-free, meaning that senders and receivers don’t need to know each other’s identity to use it, or to reveal their identity to us.
We do not require people to sign up or log in and we cannot access any files you send, as they are end-to-end encrypted. Files are never stored on our servers and transfers happen in real-time. While these aspects ensure the app is more private and secure, it means that both the sender and receiver need to be online at the same time. Learn more about how Winden works in our FAQ.
Based on the Magic Wormhole protocol, Winden was developed to scale the protocol without compromising its security and make it ready for web-usage. Part of this work was funded by the European Union’s Next Generation Internet program (NGI_Trust).
Try it out at winden.app.
Follow these steps to get the whole setup running on a local computer for easy development and debugging.
git clone email@example.com:LeastAuthority/winden.git cd winden git submodule init git submodule update --recursive
or you can do it in one step:
git clone --recurse-submodules firstname.lastname@example.org:LeastAuthority/winden.git
- docker compose
docker compose build docker compose run client npm i docker compose run client-e2e npm i
The following command will run
gulp watchin the
gulp watchessentially does the following:
- rebuild the WASM module whenever changes are made to the
- serve the output at localhost:8080 and automatically refresh the page on any change.
Learn more about the build system at ARCHITECTURE.md
docker compose up -d client docker compose run -p 8080:8080 client gulp watch # equivalent command
docker compose logs -f
docker compose down
docker compose run -p 6006:6006 client npm run storybook
The e2e tests run on the selenium docker containers. They will run the test against the
clientrunning on the host. To get the containers to connect to be able to connect to the host, we need to add the host's local IP to the environment:
- Create an empty file
HOST_IP=<YOUR_IP_HERE>(you could find your local IP through
Run the unit and integration tests using the following:
# run tests once docker compose run client npm run test # or automatically re-run tests when editing a file docker compose run client npm run test -- --watch # or run individual tests docker compose run client npm run test -- -i client/src/worker/tests/streaming.test.ts
Run the end-to-end tests with the following
# Run the tests. This would also start the selenium hub if it's not running yet. docker-compose run --rm client-e2e # Once you're done working with the e2e tests, stop the containers running the selenium hub. docker-compose --profile e2e down
See https://github.com/SeleniumHQ/docker-selenium#debugging And https://webdriver.io/docs/api/browser/debug/
client/.envif it does not exist already
- Fill it with the following for:
MAILBOX_URL="wss://<mailbox server>/v1" RELAY_URL="wss:///<relay server>" # Use the following line for a development build NODE_ENV=development
# Production MAILBOX_URL="wss://<mailbox server>/v1" RELAY_URL="wss:///<relay server>" # Or use the following line instead for a production build NODE_ENV=production
We build and deploy by running a gulp task inside a docker container. You will need to provide your AWS credentials to the container. We do this through the
client/.envif it does not exist already
- Fill it with the following: (Replace placeholders in angle brackets with the appropriate values)
AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY> AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY> AWS_DEFAULT_REGION=<REGION> S3_BUCKET=<URL> CDF_DISTRIBUTION_ID=<ID> MAILBOX_URL="wss://<mailbox server>/v1" RELAY_URL="wss://<relay server>" NODE_ENV=production # or `development` if deploying to playground
Now you can deploy by running the following:
docker-compose run client gulp deploy
Note that this gulp task will also create a new build of the app.
See ARCHITECTURE.md for an in-depth look at the codebase structure.