Deploy your first module

Plan and apply a Git module from the dashboard's /new screen. To drive the same flow over the API, see Start with a Git module.

1. Open /new

/new is the standard entry point. Paste a Git URL and it reads the module, then shows the variables and providers it needs.

You can also send users to this screen from another app.

https://takosumi.example.com/install?git=https://github.com/example/app.git&ref=v1.2.0&path=deploy/opentofu

/install only fills the form on /new. Nothing is created when the link is opened. The user reviews the result and approves it themselves.

2. Check connections and variables

Once the module is read, assign a Connection if credentials are needed, and review the variables.

3. Review the plan

Look at what the plan would change. Nothing is applied yet.

4. Apply

Approve and apply. State, outputs, and the audit record are saved.

Add a connect button to your app

To let users add your service from your own app, open an /install link from a button. Put the Git URL, ref, and module path in it, and add product with return_uri so the app is revisited when done.

https://takosumi.example.com/install
  ?git=https%3A%2F%2Fgit.example.com%2Facme%2Fnotes.git
  &ref=v1.2.3
  &path=deploy%2Fopentofu
  &product=notes-app
  &return_uri=notesapp%3A%2F%2Fconnect

When the user finishes adding it on screen, Takosumi returns to return_uri with the created host URL and run_id. See App Handoff for the details.

You can also list modules in a Store so users pick and add from the list (Store API).

Next

• Start with a Git module
• App Handoff — building /install links