Skip to content

Commit

Permalink
Update wireguard.md (#357)
Browse files Browse the repository at this point in the history
* Update wireguard.md

* Fix wireguard format

---------

Co-authored-by: dappnodedev <[email protected]>
  • Loading branch information
Pol-Lanski and dappnodedev authored Jan 25, 2024
1 parent 07e645d commit 2237617
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions docs/user/access-your-dappnode/vpn/wireguard.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

WireGuard is a modern, high-performance VPN protocol that offers a simple and streamlined approach for securely accessing your Dappnode. This guide will walk you through setting up WireGuard with your Dappnode.

You will need:
You will need:

1. Your dappnode
2. A Wireguard client installed on your usual device (laptop, mobile, etc.)

Expand All @@ -14,26 +15,30 @@ There are two primary methods to obtain your VPN credentials:

#### Option 1: Via Dappmanager UI


![VPN_credentials](/img/vpn-1.png)

If you have access to the Dappmanager:

- Navigate to **VPN > WireGuard**.

- **If you don't see any device added to the list:**
1. Provide a name for your device.
2. Click on 'Add New Device'.
- **If you don't see any device added to the list:**

1. Provide a name for your device.
2. Click on 'Add New Device'.

- **To retrieve the credentials:**
1. Click on the 'Get Credentials' button.
2. Copy the credentials displayed directly from the UI.
- **To retrieve the credentials:**

1. Click on the 'Get link' button on the credentials column.
2. You will be shown 3 different ways of retrieving the credentials:
- _Download config:_ it will download a .txt file with the credentials in plaintext
- _Copy config:_ it will copy the credentials in your clipboard so you can paste them in your wireguard client
- _Show config QR code:_ it will generate a QR that you can scan with a wireguard mobile client to add the config directly
3. Please, see step 3. Setting up Wireguard client to see how to use this config once you have a client in your device (desktop/laptop/phone)

- **For Local Access Credentials:**
1. Click on 'Show Local Credentials'.
2. Copy the local credentials displayed.


#### Option 2: Via Dappnode Terminal

If you can't access the Dappmanager, you'll need to get the credentials via the Dappnode terminal:
Expand All @@ -44,9 +49,9 @@ If you can't access the Dappmanager, you'll need to get the credentials via the

3. The credentials will be displayed directly on the terminal. Copy these credentials.

- **For Local Access Credentials:**
1. Execute the command: `dappnode_wireguard --local`.
2. Copy the local credentials displayed.
- **For Local Access Credentials:**
1. Execute the command: `dappnode_wireguard --local`.
2. Copy the local credentials displayed.

:::info Local Credentials Explained
Local credentials allow you to establish a connection to your Dappnode when you are on the same local network. They are especially useful when remote credentials might not work due to certain network restrictions or configurations.
Expand All @@ -56,7 +61,6 @@ While remote credentials enable access from outside your local network, local cr
Always remember: Local credentials **only work inside your own network**. If you're trying to access your Dappnode from a different location or network, you'll need to use the remote credentials.
:::


:::tip
Ensure you store these credentials securely. They provide direct access to your Dappnode. Treat them with the same level of caution as you would a password.
:::
Expand Down Expand Up @@ -166,4 +170,4 @@ To deactivate the tunnel, execute the command: `sudo wg-quick down wg0`.

:::tip Testing Your Connection
Once connected, you can directly type [http://my.dappnode](http://my.dappnode) in your browser to access the Dappmanager.
:::
:::

0 comments on commit 2237617

Please sign in to comment.