From 563b7c358acdc98db75c1f39836485500335634b Mon Sep 17 00:00:00 2001 From: Adam Leskis Date: Mon, 22 Apr 2024 14:52:47 +0100 Subject: [PATCH 1/4] add in port access information to install docs This refers to issue https://gitlab.com/veilid/veilid/-/issues/375 --- INSTALL.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index b6aba7cb..2dfa321f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -109,3 +109,7 @@ To start your headless Veilid node without systemd, run: ```shell sudo -u veilid veilid-server ``` + +## Post Install + +To let veilid access other nodes, you'll need to open up access to port 5150 for both tcp and udp. You can additionally open port 5151 as well, though if 5150 is open, that should be enough. From 3dc015fe245640d91ee10faf958318f65b33f389 Mon Sep 17 00:00:00 2001 From: Adam Leskis Date: Tue, 7 May 2024 11:41:17 +0100 Subject: [PATCH 2/4] update details of "why" we need port 5150 and what veilid nodes expect --- INSTALL.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 2dfa321f..c8cdc51d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -112,4 +112,8 @@ sudo -u veilid veilid-server ## Post Install -To let veilid access other nodes, you'll need to open up access to port 5150 for both tcp and udp. You can additionally open port 5151 as well, though if 5150 is open, that should be enough. +To let veilid access other nodes in the wider network, you'll need to open up access to port 5150 for both tcp and udp. This is the port that the process uses by default. + +If something is already using port 5150, then veilid will attempt the next port up (ie, 5151). Veilid-server typically only has a single instance running on a machine. However, machines can run several different processes which include veilid-core. These additional processes will try to use ports 5151, 5152, and so on. + +In the event the listening port is not opened in the firewall, an application will still operate, though in a fairly degraded mode that relies on another node to relay incoming RPC messages to them. From 5a1b72d2188993a234a65054316a4a9dc2ad1ecf Mon Sep 17 00:00:00 2001 From: Adam Leskis Date: Wed, 22 May 2024 22:22:46 +0100 Subject: [PATCH 3/4] update section title and add minor details - briefly touch on the fact that headless nodes need to be internet facing or behind a firewall with port 5150 open - update the title of the section to be "Network Considerations" - add a link to the Developer Book for a more in-depth discussion --- INSTALL.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index c8cdc51d..5e933c70 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -110,9 +110,11 @@ To start your headless Veilid node without systemd, run: sudo -u veilid veilid-server ``` -## Post Install +## Network Considerations -To let veilid access other nodes in the wider network, you'll need to open up access to port 5150 for both tcp and udp. This is the port that the process uses by default. +> **note:** if you're interested in using a veilid-server node for local development, you're better off reading the [Developer Book](https://veilid.gitlab.io/developer-book/), though the implementation to enable local development using a veilid-server node is still forthcoming. + +Veilid nodes need to be internet facing or behind a firewall that allows inbound connections via port 5150 for both TCP and UDP. This will allow veilid-server to access other nodes in the wider network since 5150 is the port that the process uses by default. If something is already using port 5150, then veilid will attempt the next port up (ie, 5151). Veilid-server typically only has a single instance running on a machine. However, machines can run several different processes which include veilid-core. These additional processes will try to use ports 5151, 5152, and so on. From 8ace86f81503428fd1175e3755f68eefe2fc3f56 Mon Sep 17 00:00:00 2001 From: Adam Leskis Date: Thu, 6 Jun 2024 10:25:56 +0100 Subject: [PATCH 4/4] remove note referring to incrementing ports, since veilid-server does not do this anymore --- INSTALL.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 5e933c70..56f9f983 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -114,8 +114,6 @@ sudo -u veilid veilid-server > **note:** if you're interested in using a veilid-server node for local development, you're better off reading the [Developer Book](https://veilid.gitlab.io/developer-book/), though the implementation to enable local development using a veilid-server node is still forthcoming. -Veilid nodes need to be internet facing or behind a firewall that allows inbound connections via port 5150 for both TCP and UDP. This will allow veilid-server to access other nodes in the wider network since 5150 is the port that the process uses by default. +Veilid nodes need to be internet facing or behind a firewall that allows inbound connections via port 5150 for both TCP and UDP. This will allow veilid-server to access other nodes in the wider network since 5150 is the port that the process uses by default. If the port is not available, veilid-server will wait for it to become available. -If something is already using port 5150, then veilid will attempt the next port up (ie, 5151). Veilid-server typically only has a single instance running on a machine. However, machines can run several different processes which include veilid-core. These additional processes will try to use ports 5151, 5152, and so on. - -In the event the listening port is not opened in the firewall, an application will still operate, though in a fairly degraded mode that relies on another node to relay incoming RPC messages to them. +In the event the listening port is not opened in the firewall, an application may still operate, though in a fairly degraded mode that relies on another node to relay incoming RPC messages to them.