7.2 Custom Node Name

To personalize your node's appearance, you can assign a custom name thats publically displayed on the execution status panel.

info

The following steps are performed on your 📟 node server.

1. Stop Node Operation

Depending on your setup method, there are different ways to stop your node before setting a custom name.

LUKSO CLI

cd <lukso-working-directory>
lukso stop

info

Exchange <lukso-working-directory> with the path of the node folder.

Service Automation

sudo systemctl stop lukso-validator

Force Client Shutdown

Geth

sudo pkill geth

Erigon

sudo pkill erigon

Nethermind

sudo pkill nethermind

Besu

sudo pkill besu

Teku

sudo pkill teku

Nimbus-Eth2

sudo pkill nimbus_beacon_node
sudo pkill nimbus_validator_client

Lighthouse

sudo pkill lighthouse

tip

The Lighthouse client uses a single binary for both the consensus and validator processes.

Prysm

sudo pkill prysm
sudo pkill validator

2. Add Node Name

You can either set the node name via startup flags or persistently within the configuration files of your execution client. If you want to set a temporary name, using the flag is recommended, as it will only persist until the next restart of the node.

Setting a Startup Flag

Depending on your setup method, there are different ways to pass down the name flag using the LUKSO CLI.

LUKSO CLI Node

Every execution client has a individual flag to set the node name during startup.

Geth

cd <lukso-working-directory>

# Start the Mainnet Node with Custom Name
lukso start --checkpoint-sync --geth-identity "<your-node-name>"

# Start the Testnet Node with Custom Name
lukso start --testnet --checkpoint-sync --geth-identity "<your-node-name>"

Erigon

cd <lukso-working-directory>

# Start the Mainnet Node with Custom Name
lukso start --checkpoint-sync --erigon-identity "<your-node-name>"

# Start the Testnet Node with Custom Name
lukso start --testnet --checkpoint-sync --erigon-identity "<your-node-name>"

Nethermind

cd <lukso-working-directory>

# Start the Mainnet Node with Custom Name
lukso start --checkpoint-sync --nethermind-ethstats-name "<your-node-name>"

# Start the Testnet Node with Custom Name
lukso start --testnet --checkpoint-sync --nethermind-ethstats-name "<your-node-name>"

Besu

cd <lukso-working-directory>

# Start the Mainnet Node with Custom Name
lukso start --checkpoint-sync --besu-ethstats="<your-node-name>:<ethstats-secret>@<ethstats-server-url>"

# Start the Testnet Node with Custom Name
lukso start --testnet --checkpoint-sync --besu-ethstats="<your-node-name>:<ethstats-secret>@<ethstats-server-url>"

warning

The Besu client embeds the node name directly within the Eth-Stats connection string, meaning you must also exchange and provide the <ethstats-secret> and <ethstats-server-url> as a flag. Other execution clients have those set separately within their config files.

info

The following properties need to be exchanged:

• <lukso-working-directory> with the path of the node folder
• <your-node-name> with the custom description or name of the node

After the clients were started, verify that their services are still up.

sudo lukso status

LUKSO CLI Validator

Every execution client has a individual flag to set the node name during startup.

Geth

cd <lukso-working-directory>

# Start the Mainnet Validator Node with Custom Name
lukso start --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --geth-identity "<your-node-name>"

# Start the Testnet Validator Node with Custom Name
lukso start --testnet --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync  --geth-identity "<your-node-name>"

Erigon

cd <lukso-working-directory>

# Start the Mainnet Validator Node with Custom Name
lukso start --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --erigon-identity "<your-node-name>"

# Start the Testnet Validator Node with Custom Name
lukso start --testnet --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --erigon-identity "<your-node-name>"

Nethermind

cd <lukso-working-directory>

# Start the Mainnet Validator Node with Custom Name
lukso start --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --nethermind-ethstats-name "<your-node-name>"

# Start the Testnet Validator Node with Custom Name
lukso start --testnet --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --nethermind-ethstats-name "<your-node-name>"

Besu

cd <lukso-working-directory>

# Start the Mainnet Validator Node with Custom Name
lukso start --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --besu-ethstats="<your-node-name>:<ethstats-secret>@<ethstats-server-url>"

# Start the Testnet Validator Node with Custom Name
lukso start --testnet --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync --besu-ethstats="<your-node-name>:<ethstats-secret>@<ethstats-server-url>"

warning

The Besu client embeds the node name directly within the Eth-Stats connection string, meaning you must also exchange and provide the <ethstats-secret> and <ethstats-server-url> as a flag. Other execution clients have those set separately within their config files.

info

The following properties need to be exchanged:

• <lukso-working-directory> with the path of the node folder
• <your-fee-recipient-address> with the wallet address receiving staking profits
• <your-node-name> with the custom description or name of the node

After the clients were started, verify that their services are still up.

sudo lukso status

Service Automation

Open the startup script within your node directory with your preferred text editor.

Vim

sudo vim <lukso-working-directory>/static/lukso_startup.sh

Nano

sudo nano <lukso-working-directory>/static/lukso_startup.sh

info

Exchange <lukso-working-directory> with the path to the node folder.

Add the name flag new line to the start command, then save and exit the file.

Geth

exec /usr/local/bin/lukso start \
        --validator \
        --validator-wallet-password ./static/<your-generic-password-file> \
        --transaction-fee-recipient "<your-fee-recipient-address>" \
        --checkpoint-sync \
        --geth-identity "<your-node-name>"

Erigon

exec /usr/local/bin/lukso start \
        --validator \
        --validator-wallet-password ./static/<your-generic-password-file> \
        --transaction-fee-recipient "<your-fee-recipient-address>" \
        --checkpoint-sync \
        --erigon-identity "<your-node-name>"

Nethermind

exec /usr/local/bin/lukso start \
        --validator \
        --validator-wallet-password ./static/<your-generic-password-file> \
        --transaction-fee-recipient "<your-fee-recipient-address>" \
        --checkpoint-sync \
        --nethermind-ethstats-name "<your-node-name>"

Besu

exec /usr/local/bin/lukso start \
        --validator \
        --validator-wallet-password ./static/<your-generic-password-file> \
        --transaction-fee-recipient "<your-fee-recipient-address>" \
        --checkpoint-sync \
        --besu-ethstats="<your-node-name>:<ethstats-secret>@<ethstats-server-url>"

warning

The Besu client embeds the node name directly within the Eth-Stats connection string, meaning you must also exchange and provide the <ethstats-secret> and <ethstats-server-url> as a flag. Other execution clients have those set separately within their config files.

After the startup script was updated, you can restart the node by executing the related service.

sudo systemctl start lukso-validator

Modifying the Client Configuration

Depending on your execution client, the name can be set with different properties.

Geth

Open the configuration file using your preferred text editor.

Vim

cd <lukso-working-directory>/configs/<network>/geth/
vim geth.toml

Nano

cd <lukso-working-directory>/configs/<network>/geth/
nano geth.toml

Erigon

Open the configuration file using your preferred text editor.

Vim

cd <lukso-working-directory>/configs/<network>/erigon/
vim erigon.toml

Nano

cd <lukso-working-directory>/configs/<network>/erigon/
nano erigon.toml

Nethermind

Open the configuration file using your preferred text editor.

Vim

cd <lukso-working-directory>/configs/<network>/nethermind/
vim nethermind.cfg

Nano

cd <lukso-working-directory>/configs/<network>/nethermind/
nano nethermind.cfg

Besu

Open the configuration file using your preferred text editor.

Vim

cd <lukso-working-directory>/configs/<network>/besu/
vim besu.toml

Nano

cd <lukso-working-directory>/configs/<network>/besu/
nano besu.toml

info

The following properties need to be exchanged:

• <lukso-working-directory> with the path to the node folder.
• <network> with the name of your node's network.

Add the node name as a new line within the settings, then save and exit the file.

Geth

Search for the Node section and add the UserIdent property under it.

[Node]
UserIdent = "<your-node-name>"

Erigon

Set the identity property at the end of the file.

"identity" = "<your-node-name>"

Nethermind

Set the EthStats object and Name property at the ending bracket of the Network object.

"EthStats": {
  "Name": "<your-node-name>"
}

Besu

Set the ethstats property at the end of the file.

'ethstats'='<your-node-name>:<secret>@<server-url>'

warning

The Besu client embeds the node name directly within the Eth-Stats connection string, meaning you must also exchange and provide the <ethstats-secret> and <ethstats-server-url> as a flag. Other execution clients have those set separately within their config files.

info

Exchange <your-node-name> with the custom description or name of the node

warning

Ensure there are no missing spaces, characters or unintended linebreaks before saving the configuration file.

Depending on your setup method, there are different ways to start your node after setting the node name.

LUKSO CLI Node

cd <lukso-working-directory>
lukso start --checkpoint-sync

info

Exchange <lukso-working-directory> with the path of the node folder.

LUKSO CLI Validator

cd <lukso-working-directory>
lukso start --validator --transaction-fee-recipient "<your-fee-recipient-address>" --checkpoint-sync

info

The following properties need to be exchanged:

• <lukso-working-directory> with the path of the node folder
• <your-fee-recipient-address> with the wallet address receiving staking profits

Service Automation

sudo systemctl start lukso-validator

After the clients were started, verify that their services are still up.

sudo lukso status