This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installation and Update

This article shows how to install and update WikiTraccs.

    Downloading and running WikiTraccs for the first time

    Downloading and running WikiTraccs for the first time is covered in the Getting started guide, in section STEP ONE: Download WikiTraccs.

    It boils down to downloading and extracting a zip file. No installation needed.

    Updating WikiTraccs

    Find new WikiTraccs Releases in on GitHub: WikiTraccs Releases.

    Update Steps

    1. Download the latest WikiTraccs release zip file from the WikiTraccs GitHub
    2. Unzip the WikiTraccs release zip file into a new folder
      • Note: If you need more details, refer to the Getting started guide, section “STEP ONE: Download WikiTraccs”
    3. Optional: Copy appsettings.json from the previous WikiTraccs installation location (note: only if you use appsettings.json)
      • Note: appsettings.json is probably stored in the WikiTraccs.GUI folder, but can also exist in the WikiTraccs.Console folder; handle both
    4. Optional: Copy macro transformation templates from the previous WikiTraccs installation (note: only if you use macro transformation templates)
    5. Run WikiTraccs from the new folder

    You are now running the new version of WikiTraccs.

    Additional Information

    You might want to keep the old WikiTraccs release around in case you need to switch back to the old version or have a look at old log files.

    The settings configured via the WikiTraccs.GUI “blue window” are preserved automatically across updates, not need to copy anything manually. Those settings are stored in the current Windows user’s app directory. For details about the location, see File Storage. Note that this is not the same as appsettings.json, but a settings file WikiTraccs uses to store settings you configure in the blue WikiTraccs.GUI window. You can back up and restore this settings file.