# Configuring the Smartnode Stack (Docker Mode)

Running complete Execution layer (ETH1) and Consensus layer (ETH2) clients can be daunting; there are several options to choose from and each of them has a plethora of different settings. Luckily, the Smartnode is designed to hide all of that complexity so it's quick and easy to configure, while still giving you the freedom to customize everything if you so desire.

In this section, we'll go over the various methods for configuring the Smartnode if you're using the Docker-based setup or a Hybrid setup where you connect to externally managed Execution or Consensus clients (e.g., clients you manage outside of the Smartnode for solo staking).

NOTE

If you're using Native mode without Docker, please visit the Native configuration guide instead.

There are three ways to configure it:

  • Via the Wizard UI - this is the easiest way. It only asks you a few basic question and uses well-tested defaults for the test. This will be what you are presented with when you run rocketpool service config for the first time.
  • Via the Settings Manager UI - this gives you access to all of the Smartnode's settings so you can customize everything as much as you want.
  • Headlessly via the Command Line - this is an option for people who run the Smartnode in a headless (non-interactive) environment and need to configure it automatically.

Choose which mode you'd like to learn more about from the list above, or simply scroll through each option below.

# Configuring via the Wizard

To start the configuration process, run the following command:

rocketpool service config

This will launch a terminal-based UI that will allow you to quickly and easily configure your node, as well as provide optional fine-grained control over every setting for advanced customization.

NOTE

If you've already configured the Smartnode, you will instead be greeted with the Settings Manager. You can choose to re-open the Wizard from there if you prefer it, and all of your existing settings will be pre-selected for you.

When you run the config UI for the first time (or if you choose to run the Wizard again later), you will be presented with a screen that looks like this:

TIP

To use the Wizard, press the Arrow Keys (up/down/left/right) to navigate between things such as buttons (choices) or text boxes. You can also use Tab and Shift+Tab if you prefer - it will do the same thing.

For buttons, the one that's currently selected will be highlighted in green. The ones in black are not selected. In the screenshot above, Next is currently selected and Quit is not.

Press Enter or Space to select a button, analogous to clicking on it with the mouse.

Press Escape to go back to the previous dialog if you changed your mind about something. This will come in handy as you progress through the various Wizard pages.

Hold Ctrl and press C at any time to exit the Wizard without saving anything.

For example, on the screen above, you could press the left and right arrow keys to move between the Next and Quit buttons.

Pressing Enter while Next is selected will proceeed to the next screen. Pressing Enter while Quit is selected will quit the Wizard without saving.

When you're ready to begin, press Next.

# Choosing a Network

In the next screen, you will be asked to choose which network you want to use:

You can highlight the different choices with the Up and Down arrow keys (or Tab and Shift+Tab). When you change choices, the Description box on the right will show you a brief description of each option. This is true for all choice-based pages in the Wizard, not just the network selection, so you will see this style of page frequently.

If you want to practice running a Rocket Pool node on the Prater test network with fake ETH and RPL you can get for free, select Prater Testnet.

If you're ready to create a real Rocket Pool node on Mainnet to earn real rewards, select Mainnet.

# Execution Client Setup

The next screen will ask you how you would like to manage your Execution Client:

There are two options here.

Locally Managed (formerly called "Docker Mode") is the default choice. Use it if you don't already have an Execution client and you want the Smartnode to manage one for you. By choosing this, the Smartnode will add an Execution client as a Docker container to its stack that it can control. Don't worry, you'll get to choose which client you want to run next.

Externally Managed (formerly called "Hybrid Mode") is a convenient choice for users that already have an Execution client running elsewhere that they manage manually. By choosing this, the Smartnode will simply connect to your existing client and will not run one of its own. For example, users can use this to plug into an Execution client that they currently use for solo staking; that way, they don't need to have two separate copies of an Execution client.

NOTE

As the Smartnode cannot manage external Execution clients, you will still be responsible for regularly updating yours and diagnosing any issues it may encounter (as you currently do with it today).

Choose which mode you'd like to use for managing your Execution client and follow the steps in the corresponding tab below:

And with that, your Execution client is all set!

# Fallback Execution Client Setup

The next thing to configure is an optional fallback Execution client:

Think of this like a "spare" Execution client your node can use in case the primary one you selected in the previous step ever goes down for maintenance (which will almost certainly happen at some point).

Choose None if you don't want to use a fallback client. This isn't recommended, but you have the option if you have a reason not to use one.

Infura and Pocket behave the same way here as they do in regular Execution client operation; they will just stay idle until your primary Execution client fails, at which point they will take over until it's online again. Note that if you selected one of these for your primary Execution client earlier, you should choose a different one for your fallback Execution client.

External a good choice if you already have a secondary Execution client that you maintain yourself elsewhere (such as on a second machine, outside of the Smartnode stack) and want to use that as your fallback client. If this is selected, the Smartnode will simply switch to that if your primary client fails until it resumes operation.

To learn more about configuring these options, click on the appropriate tab below:

When you're happy with your fallback Execution client choices, proceed to the next step.

# Consensus Client Setup

Now that you have an Execution and optional fallback Execution client ready, the next task is to set up the Consensus client. The first thing to do is determine which management mode you'd like to use for it, just like you did for the Execution client earlier:

As with the Execution client management mode, there are two options here.

Locally Managed (formerly called "Docker Mode") is the default choice. Use it if you don't already have a Consensus client and you want the Smartnode to manage one for you. By choosing this, the Smartnode will add both a Beacon Node (the process used to communicate with the Beacon Chain) and a Validator Client (the process used by minipools to validate on the Beacon Chain and earn rewards) as Docker containers that it can control to its stack. Don't worry, you'll get to choose which client you want to run next.

Externally Managed (formerly called "Hybrid Mode") is a convenient choice for users that already have a Consensus client running elsewhere that they manage manually. By choosing this, the Smartnode will simply connect to your existing Beacon Node and will not run one of its own. However, it will run its own Validator Client so it can manage its own validator keys.

For example, users can use this to plug into a Beacon Node that they currently use for solo staking; that way, they don't need to have two separate copies of a Beacon Node.

NOTE

As the Smartnode cannot manage external Consensus clients, you will still be responsible for regularly updating yours and diagnosing any issues it may encounter (as you currently do with it today).

Choose which mode you'd like to use for managing your Consensus client and follow the steps in the corresponding tab below:

# Beacon Chain Checkpoint Syncing with Infura

Checkpoint syncing is a very useful technique that some Beacon Chain clients support. It allows your Beacon client to instantly sync the entire Beacon chain without having to start from the beginning and catch up on every block. This means instead of taking days, your Beacon client can be ready in a matter of minutes. All it needs is access to an existing Beacon client that you trust.

Currently, Lighthouse, Nimbus, and Teku support checkpoint syncing.

You can use any Beacon node that provides access to its HTTP API. In this example, we will show you how to use the free Infura service to do it. Both the Prater Testnet and Mainnet are supported.

If you don't have an account already, start by heading to https://infura.io/register (opens new window) to create one. You can use the free tier for checkpoint syncing, so all you will need to provide is an email address.

Once you are logged in, head to the ETH2 project page (opens new window):

Create a new project here using the Create New Project button. It can be named anything you want (for example, "RP Checkpoint Sync").

NOTE

Make sure you have the ETH2 project selected, because that's what your Consensus client needs! This is different from the Ethereum project you may have used for your fallback Execution client!

Now, go to the ETH2 project and click on the Settings button:

Here, there is a section called Keys. In this section, first select Mainnet or Prater from the Endpoints dropdown, depending on whether you're using the Prater Testnet or Mainnet.

Next, click on the small clipboard icon to the right of the long https://... string:

This is your personal, private access string for Infura's Beacon node. Clicking on the clipboard icon will copy it to your clipboard. You can then paste this in the terminal during rocketpool service config when it prompts you for a Checkpoint Sync Provider.

After that, your Beacon node will be configured to connect to Infura when it first starts up and instantly pull down the latest state of the chain!

# Metrics Configuration

Rocket Pool comes with the ability to display a detailed dashboard showing metrics about your node's hardware health, system updates, your validator performance, your rewards, information about the overall Rocket Pool network, and more:

The next question in the Wizard will ask you if you want to enable this:

If you choose to enable it, you will learn more about setting it up and how to use it in the Setting up the Grafana Dashboard section later in the process.

NOTE

All of the data collected by this system stays on your machine. Rocket Pool does not collect any of the telemetry or send it to a separate service. It's purely there for you to use so you can monitor your own node!

After this question, you've finished setting up the Smartnode! You will see the following dialog:

If you're happy with your setup and are ready to start the Smartnode, click Save and Exit here and go to the Securing your Node section next.

If you would like to review all of the settings and customize many additional settings that weren't included in the Wizard, click Review All Settings and go to the next section.

# Configuring via the Settings Manager

If you've already run rocketpool service config, instead of being greeted by the Wizard, you will see the Settings Manager screen:

There are three main features of this screen:

  1. The Category List, which lets you drill down into the settings for each category of the Smartnode stack
  2. The Review Changes and Save button, which you can use when you're ready to see what settings you've changed and save the updated configuration
  3. The Open the Config Wizard button, which will bring you to the Setup Wizard if you prefer that interface instead

TIP

To use the Settings Manager, press the Arrow Keys (up/down/left/right) to navigate between options in the home page.

Press Tab to go between the category list (1) and the buttons (2 and 3) at the bottom of the screen. The button that's currently selected will be highlighted in green.

Press Enter or Space to select a button, analogous to clicking on it with the mouse.

Hold Ctrl and press C at any time to exit the Settings Manager without saving anything.

As you scroll through the categories list, each option will have a helpful description appear in the Description Box to the right of the screen. Feel free to explore them; nothing you do will be saved until you go through the Review dialog via the Review Changes and Save button, and you can press Ctrl+C at any time to exit without saving, so you won't accidentally mess something up by playing with the settings here.

# Configuring the Settings

From the home screen, select any one of the categories with the Enter key to view the settings for that category. For example, here is the screen for the Smartnode and TX Fees category:

Use the Arrow Keys to move up and down between the settings. The currently selected one will have a white square at the end of it (if it's a text box or a check box), or will be highlighted in white (if it's a drop down).

Press Escape to go back to the home screen of the Settings Manager when you're done.

As you scroll through the settings, each one will show a brief description of what it does in the Description Box on the right. It will also show the default value there in case you want to revert it to its stock setting.

In this example, the RPL Claim Gas Threshold setting is currently selected (highlighted with a green box on the left-hand side of the screen). It has been changed to 40, but you can see that it has a default of 150 in the top-right corner (the top of the Description Box).

TIP

As a reminder, nothing will be saved to disk until you go through the Review dialog via the Review Changes and Save button. You are encouraged to explore all of the settings to learn about them and see what your Smartnode can do!

# The Setting Types and How to Use Them

The settings manager uses the following setting types and UI elements:

# Text Boxes

Text boxes are used to enter arbitrary strings of text or numbers. They look like this:

Enter your desired values into them, then press Enter or use the Arrow Keys to navigate to a different setting in order to preserve your changes. If you don't, the Settings Manager will assume you're still updating that setting and won't mark it as changed yet.

Drop downs are used to select an option from a list of choices. They look like this (when they're open):

The green item is the one that is currently selected. Use the Arrow Keys to change options - as you do, the Description Box on the right will update to tell you more about the currently selected option. When you're happy with your choice, press Enter to choose the selected option and the drop down will close, revealing the option that is currently selected:

# Check Boxes

Check boxes are used for simple Yes/No questions. They look like this:

When they are checked, they will have an X in the middle as you see above. When they are unchecked, they will simply be blank like this:

To change the setting, simply select it and press Enter.

# Saving Changes

When you're happy with your changes and you'd like to review them before saving, press the Review Changes and Save button on the home screen. As a reminder, to get to it, press the Tab key.

You will be presented with a view that looks like this:

The Review Box here will present all of the settings you've changed, showing the old values and the new ones. For example, the first line here shows that the RPL Claim Gas Threshold used to be 150, and it's been changed to 40.

It will also show you which containers are affected by the settings you've modified and will offer to restart them for you after you've saved your changes.

NOTE

At this point, your changes still haven't been saved yet. If you want to go back and modify something, press Escape to return to the home screen.

When you are satisfied with the changes, press Enter to save the new configuration to disk. You will then exit the Terminal UI and be presented with something like this message:

Your changes have been saved!
The following containers must be restarted for the changes to take effect:
	rocketpool_watchtower
	rocketpool_validator
	rocketpool_eth2
	rocketpool_node
Would you like to restart them automatically now? [y/n]

Press y and Enter if you want to automatically apply your new configuration changes and restart the affected containers.

Press n and Enter if you have other things you want to do before restarting them, and will do it manually later.

In either case, your configuration is done!

# Configuring via the Command Line

If you use the Smartnode in a headless environment where you can't interact with the Terminal UI, you can configure your node via the command line instead.

The rocketpool service config command accepts, as arguments, every setting that can normally be configured via the Terminal UI. Run the following command to see a list of them (note that it's quite long):

rocketpool service config --help

The output will look like this:

NAME:
   rocketpool service config - Configure the Rocket Pool service

USAGE:
   rocketpool service config

OPTIONS:
   --executionClientMode value  Choose which mode to use for your Execution client - locally managed (Docker Mode), or externally managed (Hybrid Mode).
                                Type: choice
                                Options: local, external
 (default: "local")
   --executionClient value  Select which Execution client you would like to run.
                            Type: choice
                            Options: geth, infura, pocket
 (default: "geth")
   --useFallbackExecutionClient         Enable this if you would like to specify a fallback Execution client, which will temporarily be used by the Smartnode and your Consensus client if your primary Execution client ever goes offline.
                                        Type: bool

...

Each option will have its name, its type, its default value, and (if it's a choice parameter) its options. Using this text, you can find the option(s) you want to set and specify them via the appropriate arguments.

NOTE

This command builds on top of your existing configuration, so if you have some settings already saved and just want to modify others, you don't need to repeat them. It will only update settings that you include as arguments to this command.

# Next Steps

Once you've configured your node just the way you want it, you're ready to secure your operating system to protect your node. Move on to the Securing your Node section next.