Skip to Content
LYNKORIADocs

Prerequisites

The accounts, domain plan, tools and knowledge you need before bootstrapping Lynkoria's OpenTofu deployment.

OpenTofu creates the infrastructure, but it cannot sign up for accounts, pay bills or choose your domain. Have these ready before step 1. Creating the tokens and keys is part of step 2.

Accounts

AccountWhyNotes
DigitalOcean (with billing)App Platform, Droplets, managed databases, Spaces, container registryRequest a higher Droplet limit if your account cannot create dedicated-CPU (c-*) sizes
DigitalOcean Container RegistryHolds the API and scanner imagesReuse an existing registry; its plan must allow two more repositories (Basic or higher)
CloudflareDNS for the domain, proxy and TLS for the API, Access, PagesFree plan works; the domain's zone must be on Cloudflare
Cloudflare Zero Trust (recommended)Access, with MFA, in front of the console and /v1/admin; optional (enable_access)Free for small teams; needs an identity provider (Google, GitHub, Okta, …) or one-time PIN
GitHubRuns CI and deployments; holds the deployment secretsAdmin access to the repository settings
Firebase / Apple DeveloperOptional: push notifications per productOnly when a product enables push
Monitoring providerOptional: Prometheus remote write, alertingGrafana Cloud, a self-hosted Prometheus/Mimir, or any remote-write endpoint

Lynkoria sends no email; console accounts are created by operators with a CLI, so no SMTP provider is needed.

Domain plan

The hostnames are set in infra/opentofu/platform/environments/*.tfvars. The repository uses:

PurposeProductionStaging
APIapi.lynkoria.comapi-staging.lynkoria.com
Admin consoleconsole.lynkoria.comconsole-staging.lynkoria.com
Docs / landinglynkoria.comstaging.lynkoria.com
LiveKitrtc.lynkoria.comrtc-staging.lynkoria.com
TURNturn.lynkoria.comturn-staging.lynkoria.com
Scanner (private)scanner.internal.lynkoria.comscanner-staging.internal.lynkoria.com

Also list every product web origin (for example https://app.yourproduct.com) that will call the API from a browser. They go into allowed_origins and the bucket's CORS rules. Wildcards are refused.

Tools

On the machine you bootstrap from (Ubuntu shown; on macOS use Homebrew equivalents):

ToolVersion / noteCheck
Gitany recentgit --version
Node.js + pnpmNode from .nvmrc (26), pnpm 12.18.0node --version
OpenTofuthe version in infra/opentofu/.opentofu-versiontofu version
doctlDigitalOcean CLIdoctl version
AWS CLI v2S3-compatible client, to create the state bucketaws --version
jq, psql, curl, opensslused by scripts and checksjq --version
Dockeroptional: local builds and the local stackdocker version

Install OpenTofu from opentofu.org, doctl from DigitalOcean and the AWS CLI from AWS.

sudo apt-get update
sudo apt-get install -y git jq postgresql-client openssl curl

GitHub Actions installs its own OpenTofu, doctl and Wrangler; you only need these tools locally for the bootstrap, troubleshooting and the occasional manual operation.

What you do not need

You do not run the LiveKit generator, create Droplets, databases, buckets, DNS records, firewall rules or Access applications by hand, and you do not generate application secrets. OpenTofu does all of that. The full split is in status and gaps.

On this page