Skip to content

Commit

Permalink
📝 add public sharing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Wytamma committed Mar 1, 2024
1 parent 35c0b1f commit 5766b30
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion docs/tutorial/remote-beastiary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@

One of the main use cases of beastiary is accessing files on a remote server e.g. a high performance computer (HPC). Here we walk though the process of running beastiary on the University of Melbourne's HPC Spartan (although these steps apply to any remote server). This assumes beastiary is already installed on the remote server (e.g. `pip3 --user install beastiary`).
One of the main use cases of beastiary is accessing files on a remote server e.g. a high performance computer (HPC). Here we walk though the process of running beastiary on the University of Melbourne's HPC Spartan (although these steps apply to any remote server). This assumes beastiary is already installed on the remote server (e.g. `pip3 --user install beastiary`).

## Public sharing link

The easiest way to access beastiary on a remote server is to use the `--share` flag when starting beastiary. This will generate a public link that can be accessed from any machine.

<div class="termy">

```console
$ beastiary --share

🐙🐁 <span style="color: blue;">STARTING BEASTIARY</span> 🐁🐙

Go to: <span style="color: green;">http://127.0.0.1:5000/login?token=8e02d06b-d30e-4a89-8476-fb22712a31b3</span>

If prompted enter token: 8e02d06b-d30e-4a89-8476-fb22712a31b3

Creating public shareable link...

Beastiary is now publicly accessible at: https://grave-profits-stories-idaho.trycloudflare.com
```
</div>

When running beastiary with the `--share` it will use [with-cloudflared](https://github.com/wytamma/with-cloudflared) to create a public link that will redirect public traffic to the local beastiary server. The public link will only work while beastiary is running. If you close the beastiary server you will have to generate a new public link.

!!! warning

We strongly recommend against disabling security when using the `--share` flag. We try to make Beastiary as secure as possible, but it is still a public link and there are bad actors.


If you want to access beastiary on a remote server without creating a public link then you will have to use an SSH tunnel.

## SSH tunnel

Expand Down Expand Up @@ -41,6 +71,7 @@ $ beastiary
🐙🐁 <span style="color: blue;">STARTING BEASTIARY</span> 🐁🐙

Go to: <span style="color: green;">http://127.0.0.1:5000/login?token=8e02d06b-d30e-4a89-8476-fb22712a31b3</span>

If prompted enter token: 8e02d06b-d30e-4a89-8476-fb22712a31b3
```

Expand Down

0 comments on commit 5766b30

Please sign in to comment.