Skip to content

Commit

Permalink
Merge pull request #33 from geerlingguy/geerlingguy-readme
Browse files Browse the repository at this point in the history
Update README.md with instructions for quickly spinning this up on a VPS
  • Loading branch information
meejah authored Aug 19, 2023
2 parents db48e91 + 10f0413 commit 13ee053
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,35 @@ together, allowing them to pretend they have a direct connection.
This server used to be included in the magic-wormhole repository, but was
split out into a separate repo to aid deployment and development.

## Quick Example (running on a VPS)

If you would like to set up a transit server on a VPS or other publicly-accessible server running Ubuntu:

```
# Install Python 3 pip and twist
apt install python3-pip python3-twisted
# Install magic-wormhole-transit-relay
pip3 install magic-wormhole-transit-relay
# Run transit-relay in the background
twistd3 transitrelay
# Check on logs
cat twistd.log # or `tail -f twistd.log`
# Kill transit-relay
kill `cat twistd.pid`
```

Assuming you _haven't_ killed transit-relay, when you do `wormhole send`, make sure you add the `--transit-helper` argument, like:

```
wormhole send --transit-helper=tcp:[server ip here]:4001 file-to-send
```

On the receiving end, paste in the command output by `wormhole send`.

## Further Instructions

See docs/running.md for instructions to launch the server.

0 comments on commit 13ee053

Please sign in to comment.