Skip to content

The SSUPConfig file

Jump to bottom
Carson Shook edited this page Apr 18, 2018 · 5 revisions

The SSUPConfig is an xml document that will live in the same directory as your executable and SSUP itself. It must be named SSUPConfig.xml A typical SSUPConfig.xml file will look something like this:

<?xml version="1.0" encoding="utf-8" ?>
<Config>
  <BuildType>X64</BuildType>
  <Name>YourExecutableName</Name>
  <CheckFrequency>Daily</CheckFrequency>
  <Url>https://example.com/releases/SSUPUpdateManifest.xml</Url>
</Config>

Config

Only one <Config> node should be present in a SSUPConfig file. CheckFrequency is the only optional child node.

BuildType

<BuildType> contains a value that represents an update bundle in the SSUPUpdateManifest. This value can be used to differentiate builds such as 32/64-bit, or between betas and release versions of your software. It must adhere to xml element name rules, meaning:

  • It must start with an alpha character or an underscore
  • It must not start with the letters "XML", "xml", or some variant thereof
  • It must not contain spaces
  • It may only contain alphas, numerics, hyphens, underscores, and periods
  • It is case-sensitive

Name

<Name> contains the name of your application's executable. This value must match the executable name exactly, with the exception of the ".exe" file extension, which should be omitted. This is used to determine the File Version of your application, as well as to end any currently running instances before launching the msi.

Example: MyExecutableName.exe becomes MyExecutableName

CheckFrequency (Optional)

<CheckFrequency> is an optional value that allows you to set how frequently SSUP should check for updates whenever your application is launched. If no value is provided, or a value cannot be parsed, then SSUP will default to checking Daily.

  • Never - Prevents all update checking. Should only be used by end users who do not want to update your app for some reason.
  • EveryStart - SSUP will check for updates every time that your application is opened.
  • Daily - Check for updates only once per day.
  • Weekly - Check for updates only once per week.
  • Monthly - Check for updates only once per month.

Note: If StupidSimpleUpdater is run without the -appinv flag, then these values are ignored.

Url

<Url> contains the fully qualified and escaped address of your Update Manifest file. Don't worry too much if you forget to replace a space or similar character with percent-encoded equivalent, as SSUP will attempt to escape it in the event that the URL entered cannot be correctly parsed.

Example:

Try to do this: https://example.com/my%20releases/SSUPUpdateManifest.xml

Avoid this: https://example.com/my releases/SSUPUpdateManifest.xml

Clone this wiki locally