Skip to content

docs: document game server use case #2298

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

Closed
wants to merge 1 commit into from
Closed

docs: document game server use case #2298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 3 additions & 11 deletions site/src/content/docs/local-development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,14 @@
<Step title="Start Rivet locally">
<Tabs>
<Tab title="Recommended">

Run Rivet with:

```sh
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
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
```

</Tab>
<Tab title="Limited Networking">

If you have port conflicts for the TCP or UDP port ranges, you can run Rivet with only HTTP support:

<Tab title="With Host Networking & TCP & UDP">
```sh
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
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
```

</Tab>
</Tabs>
</Step>
Expand Down
16 changes: 9 additions & 7 deletions site/src/content/docs/networking.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ app.listen(port, () => {

### TCP Game Server Example

_TCP is only available on enterprise & self-hosted._

#### Client (Creating the Actor)

```javascript
Expand Down Expand Up @@ -144,13 +146,13 @@ server.listen(port, () => {

Rivet supports the following protocols for actor ports:

| Protocol | Description | Recommendation |
| -------- | ----------- | -------------- |
| `https` | HTTPS and secure WebSocket traffic | Recommended for web applications |
| `http` | Insecure HTTP or WebSocket traffic | Not recommended (use https instead) |
| `tcp_tls` | Secure TCP sockets | Recommended for TCP connections |
| `tcp` | TCP sockets | Not recommended (use tcp_tls instead) |
| `udp` | UDP sockets | Use for real-time applications requiring UDP |
| Protocol | Description | Recommendation | Enterprise & Self-Hosted Only |
| -------- | ----------- | -------------- | --- |
| `https` | HTTPS and secure WebSocket traffic | Recommended for web applications | --- |
| `http` | Insecure HTTP or WebSocket traffic | Not recommended (use https instead) | --- |
| `tcp_tls` | Secure TCP sockets | Recommended for TCP connections | --- |
| `tcp` | TCP sockets | Not recommended (use tcp_tls instead) | X |
| `udp` | UDP sockets | Use for real-time applications requiring UDP | X |


## SSL and TLS
Expand Down
18 changes: 3 additions & 15 deletions site/src/content/docs/self-hosting/single-container.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,14 @@ Start a Rivet cluster:

<Tabs>
<Tab title="Recommended">

Run Rivet with:

```sh
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
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
```

This runs Rivet with HTTP, TCP, and UDP networking support.

</Tab>
<Tab title="Limited Networking">

If you don't need TCP & UDP support (which is common), you can run Rivet with just HTTP support:

<Tab title="With Host Networking & TCP & UDP">
```sh
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
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
```

This is sometimes needed if the port ranges required above have port conflicts with other software on your computer.

</Tab>
</Tabs>

Expand Down
Loading
Loading