Full Development Docker Compose

This Docker Compose is intended for running a full development environment for Rivet.

Prerequisites

• Docker
• Docker Compose

Required ports

The following ports need to be open before running Rivet:

Operation

Start

Start the cluster with:

docker compose -f docker/dev-full/docker-compose.yml up -d

This will start the cluster in detached mode. Once complete, visit the dashboard at http://localhost:8080.

To test creating an actor end-to-end, run:

./scripts/manual_tests/actors_e2e_js.ts

You should see an actor in the actor list in the dashboard.

Stop

To shut down the Rivet cluster, run:

docker compose -f docker/dev-full/docker-compose.yml down

When you start the cluster again, your data will still be there.

Nuke from orbit

To destroy all containers & volumes immediately, run:

docker compose -f docker/dev-full/docker-compose.yml down -v -t 0

Development

Rebuilding

To rebuild all services, run:

docker compose -f docker/dev-full/docker-compose.yml up -d --build

To rebuild just the server, run:

docker compose -f docker/dev-full/docker-compose.yml up -d --build rivet-server

Logs

To fetch logs for a service, run:

docker compose -f docker/dev-full/docker-compose.yml logs {name}

Following

To follow logs, run:

docker compose -f docker/dev-full/docker-compose.yml logs -f {name}

Grep

It's common to use grep (or the more modern ripgrep) to filter logs.

For example, to find all errors in rivet-server with the 10 preceding lines, run:

docker compose -f docker/dev-full/docker-compose.yml logs rivet-server | grep -B 10 level=error

Logs for rivet-server and rivet-client can also be configured via the environment. See here for more information.

Caveats

The docker compose currently only supports host networking and host ports.

Read more about host networking and ports here.

Troubleshooting

Have you tried turning it off and on again?

If something gets really screwed up, you can destroy the entire cluster with:

docker compose -f docker/dev-full/docker-compose.yml down -v -t 0

This will destroy all containers & volumes immediately.