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..3a7ac1126 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/config.md @@ -0,0 +1,5 @@ +# 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) 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..4131690e8 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/info.md @@ -0,0 +1,11 @@ +# 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) 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..6bf9c2683 --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/network.md @@ -0,0 +1,22 @@ +# Network + +![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. +- **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. Common ports are: + - 80: Commonly used for exposing UIs + - 8545: Commonly used for Ethereum RPCs + - 8551: Commonly used for Ethereum Engine endpoints + - 3500: Commonly used for the beacon chain API in dappnode. + - 4500: Commonly used for the 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 two fields: + - User: The username you want to set for the basic authentication. + - Password: The password you want to set for the basic authentication. + :::warning + For security reasons the password is stored hashed in the HTTPS package database. If you lose it, you will have to reset the 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..dd2b8c3cb --- /dev/null +++ b/docs/user/packages/understanding-dappnode-packages/overview.md @@ -0,0 +1,7 @@ +# 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. diff --git a/sidebars.js b/sidebars.js index 627080490..165472abc 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/overview", + }, + { + type: "doc", + label: "Overview", + id: "user/packages/info", + }, + { + type: "doc", + label: "Overview", + id: "user/packages/config", + }, + { + type: "doc", + label: "Overview", + id: "user/packages/network", + }, + { + type: "doc", + label: "Overview", + id: "user/packages/logs", + }, + { + type: "doc", + label: "Overview", + id: "user/packages/backup", + }, + { + type: "doc", + label: "Overview", + id: "user/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..88432b018 Binary files /dev/null and b/static/img/dappnode_package_network.png differ