Skip to content

Commit ef7a542

Browse files
MarketenDiego Mazo
andauthored
Improve tailscale docs (#462)
* improve tailscale docs * Mac connection process * fix image * add windows tailscale (#463) * android tailscale * finish android instructions * last fixes --------- Co-authored-by: Diego Mazo <dmazo@dappnode.io>
1 parent 848c7c7 commit ef7a542

File tree

3 files changed

+95
-29
lines changed

3 files changed

+95
-29
lines changed

docs/user/access-your-dappnode/vpn/tailscale.md

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,65 +12,131 @@ Using Tailscale is an excellent alternative if you're experiencing issues with U
1212

1313
Before starting, ensure you have:
1414

15+
- Access to your [Dappnode's Admin UI](http://my.dappnode).
1516
- A [Tailscale account](https://tailscale.com/).
16-
- Tailscale installed on your device. Download [here](https://tailscale.com/download)
17-
- Having access to your [Dappnode's Admin UI](https://my.dappnode)
17+
- Tailscale installed on the device you want to access your Dappnode from. Download [here](https://tailscale.com/download).
1818

19-
## Step 1: Create an Auth Key
19+
## Setting Up Tailscale
2020

21-
1. Visit [Tailscale Admin Settings](https://login.tailscale.com/admin/settings/keys).
22-
![Authkey1](/img/authkey1.png)
21+
### 1. Create an Auth Key
22+
23+
1. Log in to Tailscale and navigate to [Tailscale Admin Settings](https://login.tailscale.com/admin/settings/keys). Click on ***Generate auth key***.
24+
<p align="center">
25+
<img width="80%"src="/img/authkey1.png"/>
26+
</p>
2327
2. Create a new auth key. Any name will work.
24-
![Authkey2](/img/authkey2.png)
25-
3. Save the key for the next step.
26-
![Authkey3](/img/authkey3.png)
28+
<p align="center">
29+
<img width="50%"src="/img/authkey2.png"/>
30+
</p>
31+
3. Save the key for the next step. Do not share this key with anyone.
32+
<p align="center">
33+
<img width="50%"src="/img/authkey3.png"/>
34+
</p>
2735

28-
## Step 2: Install Tailscale on Your Dappnode
36+
### 2. Install Tailscale on Your Dappnode
2937

3038
1. Access your [Dappnode's Admin UI](https://my.dappnode)
3139
2. Navigate to **Dappstore** and search for the `Tailscale` package.
3240
3. Click **Install**
3341
4. Go to the Tailscale package in **Packages** tab and enter the auth key you created during installation.
34-
![Authkey4](/img/authkey4.png)
42+
<p align="center">
43+
<img width="80%"src="/img/authkey4.png"/>
44+
</p>
3545

36-
Once installed, Tailscale will run as a service on your Dappnode.
46+
Once installed, Tailscale will run as as any other package on your Dappnode. In order to connect to your Dappnode with Tailscale, this package will need to be running.
3747

38-
## Step 3: Configure Tailscale to Connect to Dappnode Internal Networks
48+
### 3. Configure Tailscale to Connect to Dappnode Internal Networks
3949

40-
### a. Accept Advertised Routes from Your Dappnode
50+
#### a. Accept Advertised Routes from Your Dappnode
4151

4252
1. Go to your [Tailscale Machines Dashboard](https://login.tailscale.com/admin/machines).
43-
![Machinelist](/img/machinelist.png)
53+
<p align="center">
54+
<img width="80%"src="/img/machinelist.png"/>
55+
</p>
4456
2. Find your Dappnode device in the list of machines
4557
3. Open the "Edit Route Settings" modal and check the Subnet Route that appears.
46-
![Subnetcheck](/img/subnetcheck.png)
58+
<p align="center">
59+
<img width="50%"src="/img/subnetcheck.png"/>
60+
</p>
4761

48-
### b. Add a Custom Nameserver
62+
#### b. Add a Custom Nameserver
4963

5064
1. Go to your [Tailscale DNS Admin Panel](https://login.tailscale.com/admin/dns).
51-
2. Find the Nameservers section, click Add nameserver button and add a custom nameserver.
52-
![Customserver](/img/customserver.png)
65+
2. Find the Nameservers section, click on **"Add nameserver"** and add a custom nameserver.
66+
<p align="center">
67+
<img width="50%"src="/img/customserver.png"/>
68+
</p>
69+
5370
3. Fill the popup with:
5471
- **Nameserver IP:** `172.33.1.2`
55-
- Activate "Restrict to domain" switch.
72+
- Activate **"Restrict to domain"** switch.
5673
- Set the domain as `dappnode`.
5774

58-
## Step 4: Access Your Dappnode
5975

60-
### a. Connect to Tailscale
76+
That's it! You've successfully configured Tailscale to connect to your Dappnode. All that's left is to install Tailscale on the device you want to access your Dappnode from.
77+
78+
### 4. Connecting to Dappnode with Tailscale
79+
80+
81+
<details>
82+
<summary><b>macOS</b></summary>
6183

62-
Ensure that your laptop, computer, or phone is connected to Tailscale.
84+
1. Open tailscale app in your finder
85+
2. Go to the top bar and click the tailscale logo (9 dots)
86+
<p align="center">
87+
<img width="50%"src="/img/tailscale-2.png"/>
88+
</p>
89+
3. Activate the switch to connect.
6390

64-
### b. Access Dappnode Services
91+
</details>
6592

66-
Visit [http://my.dappnode](http://my.dappnode) in your browser.
93+
<details>
94+
<summary> <b>Linux</b></summary>
6795

68-
:::warning
69-
Have 2 or more Dappnodes? It won't work out of the box. You won't be able to choose which one it connects to.
96+
1. Open up a terminal and run the following command:
97+
```bash
98+
sudo tailscale up --accept-routes
99+
```
70100

71-
You need to go to the machines you don't want to access and disable subnet routes. Your Tailscale will then direct you to the Dappnode that has subnets activated.
101+
2. If it's your first time using Tailscale in this device, a browser window may open asking to connect this device to your Tailscale account. Click on **"Connect"**. That's it! You're now connected to your Dappnode.
102+
103+
3. To stop Tailscale in any moment, run the following command:
104+
```bash
105+
sudo tailscale down
106+
```
107+
:::info
108+
Having trouble using Tailscale on Linux? Check out the [Tailscale Linux documentation](https://tailscale.com/kb/1031/install-linux) for more information.
72109
:::
73110

74-
---
111+
</details>
112+
113+
<details>
114+
<summary><b>Windows</b></summary>
115+
116+
1. Once installed, Tailscale's icon will appear in your system tray. Click on it.
117+
2. If it's your first time using Tailscale in this device, a browser window may open asking to connect this device to your Tailscale account. Click on **"Connect"**. That's it! You're now connected to your Dappnode.
118+
119+
<p align="center">
120+
<img width="50%"src="/img/tailscalewindows.png"/>
121+
</p>
122+
123+
3. To disconnect tailscale, right click on the icon on the system tray and log out or exit the application.
124+
125+
:::info
126+
Having trouble using Tailscale on Windows? Check out the [Tailscale Windows documentation](https://tailscale.com/kb/1022/install-windows) for more information.
127+
:::
128+
129+
</details>
130+
131+
<details>
132+
<summary><b>Android</b></summary>
133+
134+
1. Open your Tailscale app
135+
2. Connect to your dappnode by clicking on the "Connect" button.
136+
137+
</details>
138+
139+
<br/>
140+
75141

76-
If you encounter any issues or need further assistance, refer to the [Dappnode Community Forums](https://forum.dappnode.io/) or the [Tailscale Support](https://tailscale.com/support/).
142+
If you encounter any issues or need further assistance, refer to Dappnode's [Discord](https://discord.gg/dappnode), the [Dappnode Community Forums](https://forum.dappnode.io/), or [Tailscale Support](https://tailscale.com/support/).

static/img/tailscale-2.png

74.7 KB
Loading

static/img/tailscalewindows.png

18.1 KB
Loading

0 commit comments

Comments
 (0)