Documentation menu

Add a "Deploy to Light Cloud" button to a README so anyone can deploy their own copy of a public GitHub repository in one click.

Deploy button

Deploy to Light Cloud

A link to the Create page with a repository attached. Whoever clicks it lands on Create with that repository already read: framework detected, build settings filled in, one click to deploy.

Add it to your README#

Replace OWNER/REPO with your repository:

[![Deploy to Light Cloud](https://light-cloud.com/button.svg)](https://console.light-cloud.com/new?repo=https://github.com/OWNER/REPO)

Or in HTML:

<!-- prettier-ignore -->
<a href="https://console.light-cloud.com/new?repo=https://github.com/OWNER/REPO"><img src="https://light-cloud.com/button.svg" alt="Deploy to Light Cloud" /></a>

Each app's Settings tab shows this snippet for its own repository, ready to copy. The repository has to be public for other people to use the button.

What happens when someone clicks it#

  1. Signed out, they sign in or sign up first and come back to the same link.
  2. The repository is read the same way as any repository on the Create page. In a monorepo whose root has no build script, the app folders are listed and the first one is picked; any other is one click away.
  3. Variables the repository lists in .env.example (or .env.sample, .env.template) appear in Environment variables. Defaults are filled in; names that look like secrets (KEY, SECRET, TOKEN, PASSWORD) are left for the person to fill. Deploying with any of them still empty asks for confirmation first, since the app may not start without them.
  4. On deploy:
    • GitHub connected: the repository is copied into their account, so they own the code and their pushes deploy it (Git automation). A repository marked as a template on GitHub becomes a private copy; any other is forked.
    • No GitHub connected: the app deploys read-only from the original repository, without automatic deploys on push. Connecting GitHub later and pointing the app at a fork turns them on.

Light Cloud's own templates work the same way: a button pointing at a light-cloud-com/starter-* repository opens that template, stacks included.