Skip to content

Commit 5766b30

Browse files
committed
📝 add public sharing docs
1 parent 35c0b1f commit 5766b30

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

docs/tutorial/remote-beastiary.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11

2-
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`).
2+
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`).
3+
4+
## Public sharing link
5+
6+
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.
7+
8+
<div class="termy">
9+
10+
```console
11+
$ beastiary --share
12+
13+
🐙🐁 <span style="color: blue;">STARTING BEASTIARY</span> 🐁🐙
14+
15+
Go to: <span style="color: green;">http://127.0.0.1:5000/login?token=8e02d06b-d30e-4a89-8476-fb22712a31b3</span>
16+
17+
If prompted enter token: 8e02d06b-d30e-4a89-8476-fb22712a31b3
18+
19+
Creating public shareable link...
20+
21+
Beastiary is now publicly accessible at: https://grave-profits-stories-idaho.trycloudflare.com
22+
```
23+
</div>
24+
25+
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.
26+
27+
!!! warning
28+
29+
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.
30+
31+
32+
If you want to access beastiary on a remote server without creating a public link then you will have to use an SSH tunnel.
333

434
## SSH tunnel
535

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

4373
Go to: <span style="color: green;">http://127.0.0.1:5000/login?token=8e02d06b-d30e-4a89-8476-fb22712a31b3</span>
74+
4475
If prompted enter token: 8e02d06b-d30e-4a89-8476-fb22712a31b3
4576
```
4677

0 commit comments

Comments
 (0)