File tree Expand file tree Collapse file tree 6 files changed +905
-33
lines changed Expand file tree Collapse file tree 6 files changed +905
-33
lines changed Original file line number Diff line number Diff line change 44 <Step title = " Start Rivet locally" >
55 <Tabs >
66 <Tab title = " Recommended" >
7-
8- Run Rivet with:
9-
107 ``` sh
11- docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 -p 7500-7599:7500-7599 -p 7600-7699:7600-7699 - -platform linux/amd64 rivetgg/rivet
8+ docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 --platform linux/amd64 rivetgg/rivet
129 ```
13-
1410 </Tab >
15- <Tab title = " Limited Networking" >
16-
17- If you have port conflicts for the TCP or UDP port ranges, you can run Rivet with only HTTP support:
18-
11+ <Tab title = " With Host Networking & TCP & UDP" >
1912 ``` sh
20- docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 --platform linux/amd64 rivetgg/rivet
13+ docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 -p 7500-7599:7500-7599 -p 7600-7699:7600-7699 - -platform linux/amd64 rivetgg/rivet
2114 ```
22-
2315 </Tab >
2416 </Tabs >
2517 </Step >
Original file line number Diff line number Diff line change @@ -103,6 +103,8 @@ app.listen(port, () => {
103103
104104### TCP Game Server Example
105105
106+ _ TCP is only available on enterprise & self-hosted._
107+
106108#### Client (Creating the Actor)
107109
108110``` javascript
@@ -144,13 +146,13 @@ server.listen(port, () => {
144146
145147Rivet supports the following protocols for actor ports:
146148
147- | Protocol | Description | Recommendation |
148- | -------- | ----------- | -------------- |
149- | ` https ` | HTTPS and secure WebSocket traffic | Recommended for web applications |
150- | ` http ` | Insecure HTTP or WebSocket traffic | Not recommended (use https instead) |
151- | ` tcp_tls ` | Secure TCP sockets | Recommended for TCP connections |
152- | ` tcp ` | TCP sockets | Not recommended (use tcp_tls instead) |
153- | ` udp ` | UDP sockets | Use for real-time applications requiring UDP |
149+ | Protocol | Description | Recommendation | Enterprise & Self-Hosted Only |
150+ | -------- | ----------- | -------------- | --- |
151+ | ` https ` | HTTPS and secure WebSocket traffic | Recommended for web applications | --- |
152+ | ` http ` | Insecure HTTP or WebSocket traffic | Not recommended (use https instead) | --- |
153+ | ` tcp_tls ` | Secure TCP sockets | Recommended for TCP connections | --- |
154+ | ` tcp ` | TCP sockets | Not recommended (use tcp_tls instead) | X |
155+ | ` udp ` | UDP sockets | Use for real-time applications requiring UDP | X |
154156
155157
156158## SSL and TLS
Original file line number Diff line number Diff line change @@ -22,26 +22,14 @@ Start a Rivet cluster:
2222
2323<Tabs >
2424<Tab title = " Recommended" >
25-
26- Run Rivet with:
27-
2825``` sh
29- docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 -p 7500-7599:7500-7599 -p 7600-7699:7600-7699 - -platform linux/amd64 rivetgg/rivet
26+ docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 --platform linux/amd64 rivetgg/rivet
3027```
31-
32- This runs Rivet with HTTP, TCP, and UDP networking support.
33-
3428</Tab >
35- <Tab title = " Limited Networking" >
36-
37- If you don't need TCP & UDP support (which is common), you can run Rivet with just HTTP support:
38-
29+ <Tab title = " With Host Networking & TCP & UDP" >
3930``` sh
40- docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 --platform linux/amd64 rivetgg/rivet
31+ docker run --name rivet -v " $( pwd) /rivet-data:/data" -p 8080:8080 -p 9000:9000 -p 7080:7080 -p 7443:7443 -p 7500-7599:7500-7599 -p 7600-7699:7600-7699 - -platform linux/amd64 rivetgg/rivet
4132```
42-
43- This is sometimes needed if the port ranges required above have port conflicts with other software on your computer.
44-
4533</Tab >
4634</Tabs >
4735
You can’t perform that action at this time.
0 commit comments