Skip to content

Commit 5bef09d

Browse files
diegomazoroDiego MazoMarketen
authored
App-docs (#487)
* Dappnode App docs Co-authored-by: Diego Mazo <[email protected]> Co-authored-by: Marketen <[email protected]>
1 parent f6e26b5 commit 5bef09d

27 files changed

+192
-0
lines changed
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# How to install the Dappnode app
2+
3+
The complete process to install the Dappnode app is the following:
4+
- Go to http://my.dappnode
5+
- Go to **System** in the navigation menu on the left and click **App** section.
6+
- After clicking Continue, you will be redirected to a private domain (https) to start the App installation. In the first login you will need to type your Dappnode credentials.
7+
8+
![continue-app](/img/continue-app.png)
9+
10+
- You need to **set up your VPN connection before installing the Dappnode app**. This is mandatory to connect remotely to your Dappnode.
11+
![install-button](/img/install-button.png)
12+
13+
14+
There are two VPN options: **Tailscale and Wireguard.** OpenVPN is not supported.
15+
You can do the setup in the VPN section in the navigation menu on the left.
16+
17+
Follow these steps to setup the VPN connection:
18+
19+
**1. Download the VPN package in your Dappnode.**
20+
- Wireguard is installed by default in your Dappnode
21+
- Tailscale can be downloaded in the Dappstore
22+
23+
**2. Configure the VPN.**
24+
- Follow the installation process of [Wireguard](https://docs.dappnode.io/docs/user/access-your-dappnode/vpn/wireguard) or [Tailscale](https://docs.dappnode.io/docs/user/access-your-dappnode/vpn/tailscale)
25+
26+
**3. Install the VPN app in your phone.**
27+
- Go to Google play/App store and **download the VPN app in your phone**. After the previous configuration, you just need to **activate the VPN connection in the VPN mobile app.**
28+
29+
### Dappnode App specific installation
30+
31+
Now that you are done with the VPN connection, you can **install the Dappnode App** in your phone or computer.
32+
33+
The Dappnode App will be installed in the browser. **We recommend you to use Chrome** to have the best experience. Other browser options are Brave and Safari (requires manual setup, check Safari section below)
34+
35+
The following installation process is based on the **Chrome mobile and desktop experience**:
36+
37+
#### Mobile installation
38+
1. Go to http://my.dappnode and then go to System / App
39+
40+
2. Click the **Install App** button and then click Install in the pop up.
41+
<p align="center">
42+
<img src="../../../img/dnp-app-mobile.png"/>
43+
</p>
44+
45+
3. The App will open in a new window and you need to click **Grant permissions** button. In the following browser pop up click **Allow**.
46+
<p align="center">
47+
<img src="../../../img/grant-mobile.png"/>
48+
</p>
49+
50+
4. The app was **succesfully configured**. You can manage your subscribed devices and test the notifications.
51+
<p align="center">
52+
<img src="../../../img/devices-mobile.png"/>
53+
</p>
54+
55+
56+
#### Desktop installation
57+
1. Go to http://my.dappnode and then go to System / App
58+
![install-button](/img/install-button.png)
59+
60+
2. Click **Install** in the browser pop up. The app will be installed and opened in a new window.
61+
![install-app](/img/install-app.png)
62+
63+
3. **Grant permissions** to receive push notifications.
64+
![grant-permission](/img/enable-notifications.png)
65+
66+
4. Click **Allow** in the popup to receive push notifications.
67+
![app-popup](/img/app-popup.png)
68+
69+
5. The Dappnode app is **successfully configured** and you can manage your **subscribed devices**.
70+
![app-installed](/img/app-success.png)
71+
72+
6. In the **Devices** tab in the Notifications section you can edit the name of the device subscription, delete the subscription and send a test notification to your device.
73+
![devices](/img/devices.png)
74+
75+
76+
#### Brave browser
77+
The installation process in Brave works similarly to Chrome but there are a few extra steps to consider:
78+
79+
After installing the app, you need to grant permissions twice:
80+
81+
1. Change "Remember my decision" to **Forever** in the Pop up. Click **Allow**. This step is critical to receive the notifications.
82+
![allow-notifications](/img/allow-notifications.png)
83+
84+
2. You must activate the field **"Use Google services for push messaging"** in Settings / Privacy & security. To change it, go to Brave settings or write brave://settings/privacy in the browser search bar in desktop.
85+
![activate-push-messaging](/img/brave-settings.png)
86+
87+
#### Safari browser
88+
89+
1. Go to http://my.dappnode in Safari, then go to System / App
90+
2. In the Safari menu, click on the first icon on the top right corner / **Add to Dock**
91+
![add-dock](/img/add-to-dock.png)
92+
93+
3. Click the **Dappnode App icon in the dock** (bottom menu) to open it.
94+
4. Click Grant Permissions button.
95+
![grant-permission](/img/enable-notifications.png)
96+
97+
5. **Click Options** and **Allow** on the Popup to activate the notifications. If you click over the banner, notifications will be blocked directly.
98+
![grant-popup](/img/safari-popup.png)
99+
100+
6. Your App was successfully configured.
101+
![success-popup](/img/app-success.png)
102+
103+
7. In case you blocked the notifications, you need to go to **System Settings / Notifications / Dappnode app** and activate the **Allow notifications** toggle.
104+
![activate-notifications](/img/activate-notifications.png)
105+
106+
8. To update the Permission changes in the App, **close the App by clicking Quit** at the dock icon.
107+
108+
9. Open the Dappnode App again and click **manage devices** to subscribe your device to notifications.
109+
![manage-devices](/img/manage-devices.png)
110+
111+
10. The Dappnode App **installation is completed** in Safari. Congrats!
112+
113+
114+
### Frequent Asked Questions
115+
116+
#### Access the Dappnode app after installation
117+
118+
Option 1: You will have the **Dappnode app icon** in your phone or computer home screen (as any other app).
119+
120+
Option 2: In desktop you can type in your browser search bar the following:
121+
- brave://apps/ (For Brave)
122+
- chrome://apps/ (For Chrome)
123+
124+
Option 3: You can access the Dappnode app using your **dyndns** (Dappnode's unique identifier) and **https** writing the domain below in the browser:
125+
https://pwa."your-dyndns".io
126+
e.g. https://pwa.e17cb74a302298e6.dyndns.dappnode.io/
127+
You can find your dyndns in the top right icon in the Dappmanager.
128+
![dyndns](/img/dyndns.png)
129+
130+
131+
#### Reset notifications permissions
132+
133+
If you denied the permission to send you push notifications, you need to change the notifications configuration manually.
134+
135+
In **Chrome**:
136+
Within the app, go to the three vertical points in the top right corner.
137+
![points](/img/three-points.png)
138+
139+
Click App Info and activate Notifications.
140+
![app-info](/img/app-info.png)
141+
142+
In Chrome mobile the route changes slightly:
143+
Go directly to browser settings **Settings/Site settings/ Notifications/Managed by app/ Notifications**. and activate the permission.
144+
145+
In **Brave**:
146+
147+
Within the app, go to the three horizontal lines in the top right corner.
148+
Click App Info and activate Notifications.
149+
150+
In the browser you can go to **Settings/Privacy and security/ Site and Shield settings**
151+
In mobile the route changes slightly: **Settings/Site settings/Notifications**
152+
153+
In **Safari**:
154+
In your Device go to **System Settings/Notifications/Dappnode App** and activate the general toggle to allow notifications. If you enter the App and your permissions are not granted yet, please close the App completely to update the permissions and try to enter again.
155+
156+
#### Requirements to use the Dappnode app
157+
158+
You need to update at least to Dappnode Core v0.3.2.
159+
160+
Default packages like Https, Notifications and Bind will be updated automatically with the Core update.
161+
A VPN connection is needed to have the Dappnode App working.
162+
163+
Enjoy your Dappnode App experience!
164+

docs/user/dappnode-app/overview.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Overview
2+
3+
The **Dappnode app** is a new form of interaction with Dappnode from **mobile and desktop devices**. It helps users to enter the Dappmanager remotely and get notified about the hardware status and the staking performance.
4+
5+
The Dappnode App is a Progressive Web App (PWA) that can be installed as an application in mobile and desktop. It connects to your Dappnode through VPN to let you execute all the actions to manage your Dappnode remotely.
6+
7+
### Benefits
8+
- Use the **Dappmanager in your mobile phone** in a seamless experience.
9+
- Receive **notifications** of your Dappnode and your validators to monitor its performance.
10+
- Configure the **staking clients remotely** from your mobile

sidebars.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,24 @@ const sidebars = {
442442
},
443443
],
444444
},
445+
{
446+
type: "category",
447+
label: "Dappnode App",
448+
items: [
449+
{
450+
type: "doc",
451+
label: "Overview",
452+
id: "user/dappnode-app/overview",
453+
},
454+
{
455+
type: "doc",
456+
label: "How To Install Dappnode App",
457+
id: "user/dappnode-app/how-to-install",
458+
},
459+
460+
461+
],
462+
},
445463
{
446464
type: "category",
447465
label: "Ethical metrics",
887 KB
Loading

static/img/add-dock.png

689 KB
Loading

static/img/add-to-dock.png

496 KB
Loading

static/img/allow-notifications.png

453 KB
Loading

static/img/app-info.png

363 KB
Loading

static/img/app-installed.png

290 KB
Loading

static/img/app-popup.png

307 KB
Loading

0 commit comments

Comments
 (0)