Skip to content

Commit 58c117c

Browse files
authored
DOCS-4186: Add port opening info etc (#4478)
1 parent 3bdb631 commit 58c117c

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/manage/fleet/system-settings.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,16 @@ To configure your machine to disable TLS on the hosted HTTP server, you must spe
114114
}
115115
```
116116

117+
## Configure bind address and port
118+
119+
To configure your machine to bind to a different port, set the `bind_address` in your machine settings:
120+
121+
```json {class="line-numbers linkable-line-numbers"}
122+
"network": {
123+
"bind_address": "localhost:8081"
124+
}
125+
```
126+
117127
## Configure operating system logging
118128

119129
By default, the maximum disk space `journald` will use for `viam-server` logs is 512MB.

docs/operate/reference/architecture/machine-to-machine-comms.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ RDK Part 2 will be unaware of the actual plan and instead will only receive dist
9999

100100
<li>RDK Part 1 returns an acknowledgement of the Motion Move request to the SDK application.</li>
101101
</ol>
102+
<br>
102103

103104
## Low-level inter-robot/SDK communication
104105

@@ -116,3 +117,13 @@ In addition to gRPC, the RDK uses [WebRTC](https://webrtcforthecurious.com/) vid
116117

117118
An outline of how WebRTC is used lives on [Go.dev](https://pkg.go.dev/go.viam.com/[email protected]/rpc#hdr-Connection), but in short, an RDK is always waiting on [app.viam.com](https://app.viam.com) to inform it of a connection requesting to be made to it whereby it sends details about itself and how to connect on a per connection basis.
118119
Once a connection is made, [app.viam.com](https://app.viam.com) is no longer involved in any packet transport and leaves it up to the two peers to communicate with each other.
120+
121+
### Security implications
122+
123+
Generally you do not need to open any ports or change your network configuration, if:
124+
125+
- machines are on the internet and can successfully talk with `app.viam.com` and WebRTC works or
126+
- machines are on the same local network and mDNS and WebRTC are working
127+
128+
If WebRTC is not available, you can communicate with `viam-server` over a gRPC connection.
129+
The default port is 8080 but you can configure another port in the [network settings](/manage/fleet/system-settings/#configure-bind-address-and-port).

0 commit comments

Comments
 (0)