Skip to content

1. Get started

tl;dr

Download Conveyor

  • conveyor generate electron com.example.my-project
  • cd my-project
  • npm install
  • conveyor make site
  • Install CMake and the compiler toolchain for each platform you will target.
  • conveyor generate cmake com.example.my-project
  • cd my-project
  • Read the README to learn how to compile the project.
  • conveyor make site.
  • Install a JDK 17 or higher from any vendor e.g. Amazon Corretto is a good choice.
  • conveyor generate compose com.example.my-project
    or
    conveyor generate javafx com.example.my-project
  • cd my-project
  • ./gradlew jar - this step will download Gradle if you don't already have it.
  • conveyor make site

Now set where clients will look for updates. 

# Set the update repository URL.
echo 'app.site.base-url = downloads.your-site.org' >>conveyor.conf

# Set an upload URL if your web server is accessible with SFTP.
echo 'app.site.copy-to = "sftp://user@your-site/var/www/downloads"' >>conveyor.conf

# Rebuild and upload (use `make site` if not using sftp).
conveyor make copied-site

Welcome!

Tip

You can tick the checkmarks on these pages to mark your progress. Their state is stored in a cookie.

In this tutorial you will learn:

  • How to package a generated or pre-existing app.
  • How to configure and run Conveyor to build packages and download/update sites.

You will get a directory that contains:

  • Windows, Mac and Linux packages.
  • Update repository metadata.
  • Scripts that users can pipe to a shell to launch from the command line.
  • A download.html page that gives your users a big green download button:

At the end you'll learn how to do code signing, and how Conveyor helps you obtain certificates if needed.

This tutorial doesn't cover all the features Conveyor has. Read through the rest of this guidebook to learn about the full range of possibilities.