Skip to main content
There are three ways to get to a running Voyant, depending on how much of it you want to operate yourself.

Use Voyant

Nothing to install. Sign up and your deployment is provisioned for you.

Run the container

Self-host Voyant OSS from the published image. The fastest way to run it yourself.

Generate a project

Scaffold a codebase you own and extend, with the platform as dependencies.

​
Use Voyant

Sign up at voyant.travel. Your deployment, database, admin, and booking surface are provisioned for you, and upgrades and scaling are handled from there on. You get an admin URL and an API token, and nothing to run. It is also the only way to get Max, the app marketplace, and the services — messaging, vault, browser, video, realtime, and search. Connect and Data are hosted products you consume over their APIs, so they work with a self-hosted deployment too. A deployment can be exported to Voyant OSS at any time, so this is not a one-way door.

​
Run the Voyant OSS container

Voyant OSS is the whole platform under Apache-2.0, published as a container image. You need a PostgreSQL database and a set of secrets.
1

Pull the image

Pin a version in production. Every push to main publishes an immutable sha-<git-sha> tag; deliberate releases publish a bare semver tag, and latest is promoted from an already-verified release digest. A sha- tag records which commit was built, not which version was released — pin a semver tag or a digest.
2

Write an env file

The server needs a Postgres URL plus auth, session, and integration secrets. apps/operator/.env.example in the Voyant OSS repository is the authoritative key list.
operator.env
Generate the two auth secrets separately. They protect different session realms, and reusing one for both collapses that boundary.
3

Run it

The server listens on PORT, which defaults to 8080, and exposes /healthz for container probes.

​
Generate a project

Use the CLI when you want a codebase you own and extend, rather than a container you configure. The platform arrives as dependencies; your repository holds your modules, routes, and UI.
1

Install the CLI

Requires Node.js 20 or newer and a package manager. The generated project uses pnpm.
2

Create the project

3

Configure it

Set DATABASE_URL and the auth secrets. Any PostgreSQL works for local development.
4

Migrate and run

Local development serves on port 3300 by default. Open it and sign in with the seeded credentials from the project README.

​
What you just ran

A deployable travel operations platform, not a demo: a normalized data model on Postgres, the domain modules for catalog, commerce, inventory, operations, bookings, finance and the rest, an API layer over all of them, an admin, and a public booking surface. Voyant runs as a resident Node process against Postgres. The modules are assembled through the resolved deployment graph and booted together into one application — they are components of one deployable, not separately deployed services.

​
Next steps

Understand the architecture

How modules, links, jobs, subscribers, and surfaces fit together.

Browse the modules

What each domain module owns.

Extend the platform

Swap a provider, or build an app that runs outside the deployment.

Connect supplier inventory

Sell cruises, hotels, and flights from third-party suppliers.
Need help? Reach out at hi@voyant.travel.