Upgrade Installation - techtalk/SpecLog-Resources GitHub Wiki

SpecLog automatically upgrades data from previous versions.

When upgrading SpecLog from version 1.18 or later, your configuration files (.config extension) are not overwritten when upgrading to a new version. The default configuration files in the installer are copied to your installation with the .sample extension. If you want to use the default configuration file, simply rename it to the .config extension.

Note that the structure of the .config files may change between versions. If this is the case, it will be mentioned in the release notes, and you will need to update your .config files after upgrading.

To upgrade the client, simply run the installer.

When opening a repository file created in an older version of SpecLog, the client offers to upgrade the repository file. A backup of the original repository file is saved in the same directory with the .bak extension.

Stand alone repositories are upgraded by the client. In the case of shared repositories, the client attempts to download a new version of the repository from the server. If the server is unreachable or does not match the client version, the shared repository file cannot be upgraded and cannot be opened on the client.

When upgrading the server:

1. Synchronise outstanding changes on the clients: Ensure that all outstanding changes are synchronized from the clients to the server before upgrading the server, as you may not be able to synchronise them after upgrading the server.

2. Create a backup of the following:

• The server's database
• The .config files from the server directory (optional when upgrading from 1.18 or later, as these files are no longer overwritten)
• The admin.sltoken from the server directory
• Any other files you have added to the server directory (and its sub-directories) you want to keep
• Local repository files used by plugins (e.g. TFS synchronization). By default, these are located in %ALLUSERSPROFILE%\TechTalk\SpecLog

1. Install the new SpecLog version:

• Stop the server service.
• Install the new SpecLog release on the server. (If you have installed the release on another machine, you can also copy the contents of the server directory from there to the appropriate directory on the server. In this case, delete all content from the target directory before copying the files.)

1. Update the .config files if necessary:

• When updating from a version prior to 1.18: In most cases, you can simply copy your old .config files (backed up earlier) back to the server directory. However if the file structure has changed, you will need to update the new .config file with your previous settings (database connection string, server URL).
• When updating from a version 1.18 or higher: Your existing files are not overwritten, and in most cases you do not need to do anything. However if the file structure has changed, you will need to update your .config file accordingly. Use the .sample files as the basis for updating your .config files.

1. Migrate the database:

• Use SpecLog.ServerManager to upgrade the server database to the schema of the new SpecLog release: >SpecLog.ServerManager.exe upgrade
• The upgrade also migrates any local repository files used by server plugins located in the configured directory (default:%ALLUSERSPROFILE%\TechTalk\SpecLog)

1. You also need to upgrade all your SpecLog clients before connecting to the upgraded server (see above).