Upload real site

  • Set the app.license key to the name of your software license e.g. Apache 2, GPL-3 etc. Use SPDX codes if you aren't sure what to put here.
  • Upload your project source code to GitHub.
  • In your config set this key: app.vcs-url = "https://github.com/you/your-project". This automatically sets app.site.base-url to point at the latest GitHub Release.
  • Create a Fine Grained Personal Access Token with Read and Write access to your repository Contents.
  • Set the app.site.github.oauth-token key to the value of the token created above.
  • (optional) Set the app.site.github.pages-branch key to gh-pages.
  • Run conveyor make copied-site.

Your installs will update to whatever the latest release is.

You don't have to use GitHub. If you want to upload your site elsewhere make sure app.vcs-url is set to the URL of your source repository and set app.site.base-url to the URL where the generated site will be uploaded to.

When your app.site.base-url key is set to localhost or a domain that ends in .local Conveyor is in testing mode and you can use it for free. Once you set app.site.base-url to a real website you will be asked to pay and granted three license keys. Each key can be used with one site URL. If you want different update channels (e.g. beta, testing) then you'll need to different site URLs and one key for each.

  • Pick a site URL and set app.site.base-url to point to it, e.g. app { site.base-url = "https://downloads.example.com/myapp" }
  • Set the conveyor.billing-email key to the email address we can use to contact you for billing purposes.
  • Run conveyor make site.
  • You'll be asked to visit a payment URL where you can enter credit card data, and the conveyor.license-key key will be set to a short random code. This key is linked to your chosen download site URL.
  • Rerun conveyor make site.

To release an update you just re-upload the files to the site URL.

Learn more about download sites