IntenseWebs/veilid
3
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-12-23 14:40:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/add_port_number_to_installation' into 'main'

Browse Source 
add in port access information to install docs

See merge request veilid/veilid!273
This commit is contained in:
Christien Rioux 2024-06-06 17:17:13 +00:00
commit e638c02465
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
INSTALL.md
View File

@ -109,3 +109,11 @@ To start your headless Veilid node without systemd, run:
```shell
sudo -u veilid veilid-server
```
## Network Considerations
> **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 the port is not available, veilid-server will wait for it to become available.
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.