-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add docs for https auth * fix path /understanding-dappnode-packages * update labels * Improve packages section --------- Co-authored-by: dappnodedev <[email protected]>
- Loading branch information
1 parent
320f0a6
commit 66a2a0e
Showing
11 changed files
with
120 additions
and
65 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 was deleted.
Oops, something went wrong.
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,5 @@ | ||
# Backup | ||
|
||
This option will be available in packages that generate any kind of local database that includes sensitive information such as validator keystores. You'll have two very self-explainatory options: "Backup Now" and "Restore Backup". | ||
|
||
![dappnode_packages5](/img/dappnode_packages5.png) |
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,5 @@ | ||
# Config | ||
|
||
The Config section provides access to the package's settings, available in both simple and advanced modes. You can switch to the advanced mode by clicking the option in the lower-right corner of the screen when it is available. This flexibility allows users to customize package parameters according to their needs, from basic adjustments to more detailed configurations. | ||
|
||
![dappnode_packages2](/img/dappnode_packages2.png) |
5 changes: 5 additions & 0 deletions
5
docs/user/packages/understanding-dappnode-packages/file-manager.md
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,5 @@ | ||
# File Manager | ||
|
||
Also handy whenever your package has a database you'll need to access or modify, but without going through a terminal. Download and upload files in an easy way with the File Manager. | ||
|
||
![dappnode_packages6](/img/dappnode_packages6.png) |
13 changes: 13 additions & 0 deletions
13
docs/user/packages/understanding-dappnode-packages/info.md
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,13 @@ | ||
# Info | ||
|
||
The Info section provides a comprehensive overview of the package's status and essential details. This section is crucial for understanding the current state of the package and managing its basic operations. Below are the key features you'll find in the Info section: | ||
|
||
- **Version**: Displays both the package's version and its upstream version. | ||
- **Getting Started**: Provides essential information needed to run the package. You can remove this section if it's not needed anymore. | ||
- **Links**: Offers various options, including bundled package UI/Dashboards, related tools such as Launchpads, and external documentation. | ||
- **Package Status Indicator**: Indicates the current status of the package (e.g., running, crashed, restarting). | ||
- **Package Status Manager**: Allows you to play/pause or restart the package for management and troubleshooting purposes. | ||
- **Remove Volumes**: Wipes all package data. For blockchain nodes/clients, this will force the package to start syncing from scratch (or from a checkpoint if a proper URL has been set). This option is represented by a gray trash bin icon. | ||
- **Remove Package**: Completely removes the package from your Dappnode. You can choose to either keep or delete any data associated with it. This option is represented by a red trash bin icon. | ||
|
||
![dappnode_packages1](/img/dappnode_packages1.png) |
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,5 @@ | ||
# Logs | ||
|
||
This is a great section for finding out something that is not working in your package or to look for both expected and unexpected behavior. Packages with multiple services will give you the option to switch logs in the top "Service" bar, something common for consensus clients for example, which usually run one service for the `beacon-chain` and another one for `validator`. Whenever you request for support in the Dappnode community, keep these handy! | ||
|
||
![dappnode_packages4](/img/dappnode_packages4.png) |
26 changes: 26 additions & 0 deletions
26
docs/user/packages/understanding-dappnode-packages/network.md
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,26 @@ | ||
# Network | ||
|
||
The Network section allows you to manage and configure the network settings for your packages. This includes adjusting network settings for individual services, changing port mappings, and setting up domain mappings to expose your package to the internet. | ||
|
||
![dappnode_packages3](/img/dappnode_packages3.png) | ||
|
||
- **Service**: Some packages may have multiple services running as part of the same container. This option will allow you to adjust each of their network settings separately. | ||
|
||
- **Public port mapping**: Need to change your package's port mapping? You can change this setting in this field as well as its protocol between TCP and UDP. Remember that Dappnode features UPnP technology, so if this protocol is enabled in your router, the port opened here will be forwarded in the router, too. | ||
|
||
- **HTTPs domain mapping**: Do you want to expose your package to the internet? You'll be able to add multiple public domains to your package here. This is a great way to share your node's RPC with friends and family! | ||
- <u>From subdomain</u>: the domain name you want to set for the mapping. It will be appended to your dappnode dynDNS domain. | ||
|
||
- <u>To port</u>: The container port you want to map to the domain. Double check you have chosen correctly the port you want to map. These ports are commonly used: | ||
- 80: Exposing UIs | ||
- 8545: Ethereum RPC APIs | ||
- 8551: Ethereum Engine endpoints | ||
- 3500: Beacon chain or validator API in Dappnode. | ||
|
||
- <u>Basic auth</u>: This parameter is optional and allows you to set a basic authentication for the domain. It will be required to access the domain, learn more about basic authentication [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). The basic auth is composed of fields **User** and **Password** | ||
|
||
:::warning | ||
For security reasons, the password is not stored in plain text. This means it cannot be recovered if lost. In such case, you will have to re-create the port mapping with a new password. | ||
::: | ||
|
||
![dappnode_packages3](/img/dappnode_package_network.png) |
19 changes: 19 additions & 0 deletions
19
docs/user/packages/understanding-dappnode-packages/overview.md
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 @@ | ||
# Dappnode Packages | ||
|
||
### What are Dappnode packages? What features do they offer? How are they managed? | ||
|
||
One of Dappnode's top features is its user-friendly interface, which allows users to interact with various packages containing clients and other applications. This section will go over the basic features you'll find in any Dappnode package. | ||
|
||
There are 6 sections in the package view: | ||
|
||
[**🔍 Info**](/docs/user/packages/understanding-dappnode-packages/info): Provides basic information about the package, including its running status and volume management. | ||
|
||
[**🔧 Config**](/docs/user/packages/understanding-dappnode-packages/config): Contains configuration settings for the package, allowing users to adjust parameters and customize its behavior according to their needs. | ||
|
||
[**📡 Network**](/docs/user/packages/understanding-dappnode-packages/network): Details the network configuration, including port settings and forwarding options. | ||
|
||
[**📝 Logs**](/docs/user/packages/understanding-dappnode-packages/logs): Provides access to various logs generated by each of the package's services, useful for troubleshooting and monitoring package performance. | ||
|
||
[**📁 File Manager**](/docs/user/packages/understanding-dappnode-packages/file-manager): Offers a file management interface that allows users to upload and download files within any of the services that make up the package. | ||
|
||
[**💾 Backup**](/docs/user/packages/understanding-dappnode-packages/backup): Includes backup options to safeguard package data, providing the ability to download and restore backups in a compressed file format. |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.