Skip to content
This repository was archived by the owner on Aug 25, 2026. It is now read-only.

Commit 1f5c023

Browse files
committed
improvements to st and clearnet sections
1 parent e27a598 commit 1f5c023

3 files changed

Lines changed: 15 additions & 7 deletions

File tree

src/misc-guides/start-tunnel.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Installation
44

5-
Follow the [official instructions](https://github.com/Start9Labs/start-os/blob/next/major/START-TUNNEL.md) to install StartTunnel on a VPS.
5+
Follow the [official StartTunnel instructions](https://github.com/Start9Labs/start-os/blob/next/major/START-TUNNEL.md) to install StartTunnel on a VPS.
66

7-
The instructions below assume you chose to initialize the web interface. If not, you can do everything using the start-tunnel CLI.
7+
The instructions below assume you chose to initialize the StartTunnel web interface. If not, you can do everything using the start-tunnel CLI.
88

99
## Adding your StartOS Server
1010

@@ -14,14 +14,14 @@ The instructions below assume you chose to initialize the web interface. If not,
1414

1515
- Give your server a name (e.g. "Start9 Server").
1616
- Select a subnet (the default subnet, `10.59.0.1/24`, is fine).
17-
- Accept/Choose what IP address your server will have on the a LAN.
17+
- Accept/choose what IP address your server will have on the a LAN.
1818
- Click "Save".
1919

2020
1. Download the resulting `start-tunnel.conf`, (or copy to your clipboard).
2121

2222
1. In StartOS, navigate to `System -> Gateways` and click "Add".
2323

24-
1. Give the gateway a name (e.g. "StartTunnel").
24+
1. Give the gateway a name (e.g. "StartTunnel 1").
2525

2626
1. Upload `start-tunnel.conf` (or paste from your clipboard).
2727

@@ -55,7 +55,7 @@ In order to expose a service interface to the public Internet, it is necessary t
5555

5656
1. Under `Addresses`, find the `Public` address you want to expose. A domain is usually best, but it is also possible to expose `IP:port`.
5757

58-
1. Click the "ⓘ" icon.
58+
1. Click the blue "ⓘ" icon.
5959

6060
1. Find the line that says "Requires port forwarding in gateway..." and take note of the `:externalPort -> IP:internalPort`.
6161

src/user-manual/connecting-remotely/clearnet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ With few exceptions, you should add a domain to your service interface so that y
2929

3030
```admonish warning
3131
If you select your server's Root CA, only devices that have downloaded and trusted your server's Root CA will be able to access the domain without issue.
32+
33+
If you want other devices to reach this domain without issue, you should select Let's Encrypt from the dropdown. To add Let's Encrypt to your list of available Certificate Authorities, follow the [instructions](../authorities.md).
3234
```
3335

3436
1. Click "Save".

src/user-manual/connecting-remotely/vpn.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,15 @@ Most modern routers include a VPN server feature. If so, it is usually the prefe
2323

2424
## Option 2: StartTunnel
2525

26-
There are two reasons to select this option: (1) your router does not offer a VPN server or (2) you are already using StartTunnel for [clearnet](./clearnet.md) hosting, so most of the work is already done.
26+
By default, StartTunnel exports wireguard config files that are configured for split tunneling, allowing you to use your StartTunnel VPN to access your StartOS server and installed services while also preventing it from being automatically used for all Internet traffic.
2727

28-
See [Creating a StartTunnel Private Gateway](../../misc-guides/start-tunnel.md).
28+
There are three reasons to select this option:
29+
30+
1. Your router does not offer a VPN server.
31+
2. Your router's VPN server is not automatically configured for split tunneling.
32+
3. You are already using StartTunnel for clearnet hosting, so most of the work is already done.
33+
34+
To use StartTunnel for private, remote VPN access, see [Creating a StartTunnel Private Gateway](../../misc-guides/start-tunnel.md), including the section for [Adding a Client Device for Private Access](../../misc-guides/start-tunnel.md#adding-a-client-device-for-private-access)
2935

3036
## Connecting Clients
3137

0 commit comments

Comments
 (0)