-
Notifications
You must be signed in to change notification settings - Fork 207
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
60 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
The most straightforward way to add TLS on top of SilverBulet is to use use [Caddy](https://caddyserver.com/). Caddy can automatically provision an SSL certificate for you. | ||
|
||
When you’re deploying on a public server accessible to the Internet, you can do this as follows: | ||
|
||
```shell | ||
$ sudo caddy reverse-proxy --to :3000 --from yourdomain.com:443 | ||
``` | ||
|
||
If you’re deploying on a local network and access your server via a VPN, this is a bit more tricky. The recommended setup here is to use [Tailscale](https://tailscale.com/) which now [supports TLS certificates for your VPN servers](https://tailscale.com/kb/1153/enabling-https/). Once you have this enabled, get a certificate via: | ||
|
||
```shell | ||
$ tailscale cert yourserver.yourtsdomain.ts.net | ||
``` | ||
|
||
Caddy can automatically find these certificates once provisioned, so you can just run: | ||
|
||
```shell | ||
$ sudo caddy reverse-proxy --to :3000 --from yourserver.yourtsdomain.ts.net:443 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
If you would like to expose your local SilverBullet instance running on your laptop to the wider Internet (so you can access it from other machines, or even outside your home) using [ngrok](https://ngrok.com/) is a simple and free solution. | ||
|
||
**Note:** this will require you to keep the machine you’re running SilverBullet **switched on at all times** (or at least when you want access to SB). When you shut it down (or clause the lid), SilverBullet will become inaccessible (unless you use the sync [[Client Modes|client mode]] of course, but then content will only sync when the machine is on). | ||
|
||
## Setup | ||
Generally this setup involves a few steps: | ||
1. [[Install]] and run SilverBullet either via Deno or Docker on your local machine | ||
2. Sign up, install and launch [ngrok](https://ngrok.com/) to expose the local port to the Internet | ||
3. Profit | ||
|
||
It is **absolutely key** to enable [[Authentication]] on SilverBullet, otherwise anybody who can guess the URL ngrok gives you, and view and edit your files at will (or worse). | ||
|
||
So generally the steps are to run SilverBullet (e.g. via Deno) (see [[Install]] for more options) — note the port here (`3000`): | ||
|
||
```bash | ||
$ silverbullet -p 3000 --user mysuser:mypassword path/to/space | ||
``` | ||
|
||
Then, create a free [ngrok](https://dashboard.ngrok.com/) account, and follow the instructions to download the ngrok client for your platform, and authenticate it (look for the `ngrok config add-authtoken` command). | ||
|
||
Then, in another terminal run `ngrok`: | ||
|
||
```bash | ||
$ ngrok http 3000 | ||
``` | ||
|
||
This will give you a `https://xxx.ngrok-free.app` style URL you can open in your browser. | ||
|
||
Note that this URL changes every time, which is inconvenient. Therefore it’s **recommended you create a domain** as well (you get 1 for free). Follow the [instructions on the domains page](https://dashboard.ngrok.com/cloud-edge/domains) in the ngrok dashboard on how to do this. Once you created your domain, you can launch `ngrok` as follows: | ||
|
||
```bash | ||
$ ngrok http --domain=your-domain.ngrok-free.app 3000 | ||
``` | ||
|
||
Enjoy! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters