Documentation

Your first deploy

Two routes to a live URL. Pick git if your code is on GitHub, or the CLI if you want to deploy from a folder.

From GitHub

  1. Sign in

    Open the dashboard and sign in with GitHub or with email and password. Signing in with GitHub is what lets Vantrex see the repositories you install it on.

  2. Install the GitHub App

    Choose New project, then Install next to your GitHub account or organization. Pick the repositories you want to allow, or all of them. You are sent back to Vantrex when you finish.

  3. Import a repository

    Select the repository. Vantrex guesses the framework and the build settings; adjust them if needed and confirm. The first deployment starts immediately.

  4. Watch it build

    The deployment page streams the build log. When the status reads Ready, open the address shown.

From now on, a push to any branch creates a preview deployment, and a push to your production branch updates production. See Git deployments.

From the CLI

  1. Install the CLI

    Download the archive for your system from releases.vantrex.cloud, extract vtx and put it on your PATH. Check it works:

    $ vtx version

  2. Sign in

    $ vtx login

    The CLI prints an address and a short code. Open the address in a browser, check the code matches, and approve. The CLI saves an access token and exits.

  3. Link the folder to a project

    $ cd my-site
$ vtx link

    This creates a project named after the folder (use --name to pick another) and remembers it in .vantrex/project.json.

  4. Deploy

    $ vtx deploy

    The source is uploaded, built remotely and the log is streamed back. The last line is your preview address. Add --prod to deploy to production.

What next