diff --git a/docs/user/access-your-dappnode/overview.md b/docs/user/access-your-dappnode/overview.md index ed0421c00..3c1c26b19 100644 --- a/docs/user/access-your-dappnode/overview.md +++ b/docs/user/access-your-dappnode/overview.md @@ -4,13 +4,13 @@ Dappnode is made to work on a dedicated computer, and its main control panel, th Here are **four ways** you can connect to your Dappnode: -1. [**📡 Wifi**](/docs/user/access-your-dappnode/wifi): A user-friendly way, especially for those with Dappnode pre-installed on their machines. +[**📡 Wifi**](/docs/user/access-your-dappnode/wifi): A user-friendly way, especially for those with Dappnode pre-installed on their machines. -2. [**🔐 VPN**](/docs/user/access-your-dappnode/vpn/overview): Using either Wireguard or OpenVPN, this method is both secure and versatile. You can connect from inside or outside your local network, but if you're connecting from outside, you might need to adjust some settings. +[**🔐 VPN**](/docs/user/access-your-dappnode/vpn/overview): Using either Wireguard or OpenVPN, this method is both secure and versatile. You can connect from inside or outside your local network, but if you're connecting from outside, you might need to adjust some settings. -3. [**🔗 Local Proxy (Recovery)**](/docs/user/access-your-dappnode/local): This is a backup connection method. It allows you to connect to Dappmanager when you're on the same local network. It's mainly for recovery purposes because of its limitations. +[**🔗 Local Proxy (Recovery)**](/docs/user/access-your-dappnode/local): This is a backup connection method. It allows you to connect to Dappmanager when you're on the same local network. It's mainly for recovery purposes because of its limitations. -4. [**💻 Terminal (Advanced, Recovery)**](/docs/user/access-your-dappnode/terminal): This is for those who know their way around computer commands. It provides complete control but might be complex for some users. +[**💻 Terminal (Advanced, Recovery)**](/docs/user/access-your-dappnode/terminal): This is for those who know their way around computer commands. It provides complete control but might be complex for some users. :::info 💡 To ensure you can always access your Dappnode, it's a smart idea to set up and know more than one connection method. In the coming sections, we'll guide you through setting up each of these connection ways. diff --git a/docs/user/packages/understanding-dappnode-packages.md b/docs/user/packages/understanding-dappnode-packages.md deleted file mode 100644 index b0bebc2d7..000000000 --- a/docs/user/packages/understanding-dappnode-packages.md +++ /dev/null @@ -1,59 +0,0 @@ -# Understanding Dappnode Packages - -## What are Dappnode packages and what features do they offer? - ---- - -### **Introduction** - -One of Dappnode's top features is to offer a user-friendly interface to interact with different packages that contain clients and other applications. This section will go over the basic features you'll find in any Dappnode package. - ---- - -#### Info -- **Version**: You'll find both the package's version and its upstream version here. -- **Getting Started**: Some of the basic information needed to run the package. -- **URLs**: These will offer a number of different options, starting with bundled package UI/Dashboards and related tools such as Launchpads or external documentation. -- **Package Status**: Will provide information about the package's status, for example if it's running fine or if it has crashed or in the process of restarting. -- **Pause/Restart Package**: Useful for troubleshooting or restarting a stopped package. -- **Remove Volumes**: Also known as the "gray trash bin", this option will wipe all of the package's data and start syncing from scratch in the case of clients. -- **Remove Package**: This would be the "red trash bin", and clicking it will give you the option to preserve or delete the associated database. - -![dappnode_packages1](/img/dappnode_packages1.png) - ---- - -#### Config -The package's settings will be available under this tab in both a simple and advanced mode. The advanced mode can be accessed by clicking the lower-right corner of the screen when available. - -![dappnode_packages2](/img/dappnode_packages2.png) - ---- - -#### Network -- **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. -- **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! - -![dappnode_packages3](/img/dappnode_packages3.png) - ---- - -#### 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) - ---- - -#### 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) - ---- - -#### 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) diff --git a/docs/user/packages/understanding-dappnode-packages/backup.md b/docs/user/packages/understanding-dappnode-packages/backup.md new file mode 100644 index 000000000..ee63068a5 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/backup.md @@ -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) diff --git a/docs/user/packages/understanding-dappnode-packages/config.md b/docs/user/packages/understanding-dappnode-packages/config.md new file mode 100644 index 000000000..f83c73838 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/config.md @@ -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) diff --git a/docs/user/packages/understanding-dappnode-packages/file-manager.md b/docs/user/packages/understanding-dappnode-packages/file-manager.md new file mode 100644 index 000000000..50eb0255d --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/file-manager.md @@ -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) diff --git a/docs/user/packages/understanding-dappnode-packages/info.md b/docs/user/packages/understanding-dappnode-packages/info.md new file mode 100644 index 000000000..52e0a57bb --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/info.md @@ -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) diff --git a/docs/user/packages/understanding-dappnode-packages/logs.md b/docs/user/packages/understanding-dappnode-packages/logs.md new file mode 100644 index 000000000..584ae3173 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/logs.md @@ -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) diff --git a/docs/user/packages/understanding-dappnode-packages/network.md b/docs/user/packages/understanding-dappnode-packages/network.md new file mode 100644 index 000000000..4f4a4628f --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/network.md @@ -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! + - From subdomain: the domain name you want to set for the mapping. It will be appended to your dappnode dynDNS domain. + + - To port: 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. + + - Basic auth: 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) diff --git a/docs/user/packages/understanding-dappnode-packages/overview.md b/docs/user/packages/understanding-dappnode-packages/overview.md new file mode 100644 index 000000000..d7d57158b --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/overview.md @@ -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. diff --git a/sidebars.js b/sidebars.js index 2ca0639b7..1fb650386 100644 --- a/sidebars.js +++ b/sidebars.js @@ -241,9 +241,45 @@ const sidebars = { label: "Packages", items: [ { - type: "doc", + type: "category", label: "Understanding Dappnode Packages", - id: "user/packages/understanding-dappnode-packages", + items: [ + { + type: "doc", + label: "Overview", + id: "user/packages/understanding-dappnode-packages/overview", + }, + { + type: "doc", + label: "Info", + id: "user/packages/understanding-dappnode-packages/info", + }, + { + type: "doc", + label: "Config", + id: "user/packages/understanding-dappnode-packages/config", + }, + { + type: "doc", + label: "Network", + id: "user/packages/understanding-dappnode-packages/network", + }, + { + type: "doc", + label: "Logs", + id: "user/packages/understanding-dappnode-packages/logs", + }, + { + type: "doc", + label: "Backup", + id: "user/packages/understanding-dappnode-packages/backup", + }, + { + type: "doc", + label: "File manager", + id: "user/packages/understanding-dappnode-packages/file-manager", + }, + ], }, { type: "doc", diff --git a/static/img/dappnode_package_network.png b/static/img/dappnode_package_network.png new file mode 100644 index 000000000..bddb89921 Binary files /dev/null and b/static/img/dappnode_package_network.png differ