Getting Started
This path takes a new self-hoster from an empty host to a verified, private Riviamigo installation. Work through it in order for a first installation. Ongoing ownership moves to the Using Riviamigo and Operations sections.
Before you begin
Plan for three phases:
- Prepare: confirm the host, Docker, persistent storage, network boundary, and required secrets.
- Install: configure the Compose environment, start the stack, create the first owner, and connect Rivian.
- Verify: confirm runtime health, application access, ownership, and telemetry.
Riviamigo is designed to stay private. Its standard Compose origin publishes port 8080, so use host firewall rules and an authenticated HTTPS gateway for remote access; never expose the application port directly to the public internet.
Installation path
- Prerequisites — confirm host, Docker, storage, browser, and network expectations.
- Install Riviamigo — clone the repository, prepare the environment, and start the production stack.
- Configuration — understand required secrets and optional production settings.
- Rivian account setup — connect the vehicle account and handle MFA or login repair.
- Verify the installation — check container health, application access, ownership, and telemetry.
After verification, continue to Using Riviamigo for dashboards and external services or Operations for deployment, security, updates, and recovery.
When something fails
- A container will not become healthy: start with Verify the installation and the Operations troubleshooting path.
- Rivian login or MFA fails: use Rivian account setup.
- The public address cannot connect or WebSockets fail: review Operations.
- A provider cannot connect: use Using Riviamigo.
- Recovery or backup validation fails: use Operations and the linked maintainer runbook.
For implementation details, continue to Development. For exact data contracts, use Reference.