Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add external address to full node setup #5117

Merged
merged 4 commits into from
Feb 5, 2025
Merged

Add external address to full node setup #5117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfd74f3
fix(docs): mention required ports for fullnode in docs
Dr-Electron Jan 27, 2025
62c3605
Update text
Dr-Electron Jan 31, 2025
fe97d4d
Add note about external-address
Dr-Electron Jan 31, 2025
fe276a0
Update README.md
Dr-Electron Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/iota-config/data/fullnode-template-with-path.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ metrics-address: "0.0.0.0:9184"
json-rpc-address: "0.0.0.0:9000"
enable-event-processing: true

p2p-config:
external-address: /dns/$HOSTNAME/udp/8084 # UPDATE THIS

genesis:
# Update this to the location of where the genesis file is stored
genesis-file-location: "genesis.blob"
Expand Down
3 changes: 3 additions & 0 deletions crates/iota-config/data/fullnode-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ metrics-address: "0.0.0.0:9184"
json-rpc-address: "0.0.0.0:9000"
enable-event-processing: true

p2p-config:
external-address: /dns/$HOSTNAME/udp/8084 # UPDATE THIS

genesis:
# Update this to the location of where the genesis file is stored
genesis-file-location: /opt/iota/config/genesis.blob
Expand Down
11 changes: 11 additions & 0 deletions docs/content/_snippets/operator/ports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
:::info Firewall Ports Information

The following table lists default ports used by the node software. Make sure to open these ports in your firewall configuration.

| Port | Protocol | Description |
|------|----------|-------------------------------------------------------------|
| 8084 | UDP | The external address other nodes can use to reach this node |
| 9000 | TCP | RPC endpoint (optional) |
| 9184 | TCP | The port for Prometheus metrics (optional) |

:::
3 changes: 3 additions & 0 deletions docs/content/operator/iota-full-node/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ import questions from '/json/node-operators/iota-full-node/node-setup.json';
import Docker from './../../../../setups/fullnode/docker/README.md';
import WarningAdvanced from './../../_snippets/warning-advanced-instructions-node-setup.mdx'
import NodeHardwareRequirements from './../../_snippets/node-hardware-requirements.mdx'
import Ports from './../../_snippets/operator/ports.mdx'

# Set Up a Full Node With Docker

<WarningAdvanced/>

<NodeHardwareRequirements/ >

<Ports/>

<Docker />

<Quiz questions={questions} />
2 changes: 2 additions & 0 deletions docs/content/operator/iota-full-node/source.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {Networks} from '@site/src/components/constant'

<NodeHardwareRequirements/ >

<Ports/>

## Software requirements

IOTA recommends running IOTA full nodes on Linux. IOTA supports the Ubuntu and Debian distributions. You can also run an IOTA full node on macOS.
Expand Down
3 changes: 1 addition & 2 deletions setups/fullnode/docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ wget https://github.com/iotaledger/iota/raw/develop/crates/iota-config/data/full

### Add Peers

For `Testnet` or `Devnet` nodes, edit the `fullnode.yaml` file to include peer nodes for state synchronization. Append
the following to the end of the current configuration:
For `Testnet` or `Devnet` nodes, edit the `fullnode.yaml` file to include peer nodes for state synchronization. Add the following to the `p2p-config` section in the configuration:

#### Devnet

Expand Down
Loading