Regify provider appliance update guide

From regify WIKI
Jump to navigation Jump to search

Simple update

We recommend to make a backup or snapshot as a fall-back option. See next major topic below!

In order to update your regify provider appliance, please follow these steps:

  1. Login to your regify provider appliance using SSH (PuTTY is the recommended tool).
    1. If you login as root, you need to type "providerConfig" to open the appliance menu.
    2. If you login as regify, the appliance menu opens up automatically.
  2. Select the "Check for updates" option.
  3. Verify the updates found. Select OK or YES to do the update.
  4. Select the "Check for updates" option and repeat as long as no more updates are found.


  • The provider will be unreachable for a few minutes during update.
  • After updating, always login to your provider administration (https://yourUrl/ADMINISTRATION/) and check if there is something to do.
  • It is possible that the error log gets some entries during update. In most cases you can ignore them.
    If you are unsure about them, please send them to support (at) and ask for verification.

Update with fall-back option

If you do not trust in our update mechanisms, you should follow this scenario:

  1. Make a snapshot of your VM of the provider appliance.
  2. Login to your regify provider appliance using SSH (PuTTY is the recommended tool).
  3. Select the "Check for updates" option.
  4. Verify the updates found. Select OK to do the update.
  5. Select the "Check for updates" option and repeat as long as no more updates are found.
  6. Make your tests!
    • If everything is ok, please delete the VM snapshot!
    • If you find the need to revert, please follow the steps below.
  7. Note the notes for "Simple update" in first chapter here.

How to safely revert to a previously done VM snapshot

  1. Enter provider administration (https://yourUrl/ADMINISTRATION/)
  2. Delete all users that have been created since the last snapshot and respect the following:
    • If there are unknown users since the update, please note their name and e-mail address!
    • This allows you to contact them and let them re-register after going back.
    • Please note that transaction history during this period is not able to get restored.
  3. Revert your VM to your previous snapshot.
  4. Re-create the users you previously noted. You may invite them or ask them to re-register.
  5. Contact and tell about your experience.

Important notes about restoring VM snapshots and backups

In order to understand the complexity of VM roll-backs, you need to consider the following:

  • If someone registers at your regify provider, his email address is registered in the regify clearing service (anonymized as fingerprint).
  • During registration, every regify provider first checks the clearing if the e-mail address is not already registered at any regify provider. If it is, the registration is denied!
  • Thus, if you register a new user at a regify provider and reset the database later (eg revert to VM snapshot or a VM backup), the e-mail address is still registered in the clearing. As it is no longer in your provider database you can not even delete this registration. The user is blocked to register forever.
  • If you register transactions, they are registered in the clearing and in the users regify provider. If you revert the provider database later (eg revert to VM snapshot), the transaction entries in your provider are missing. The transactions still can get opened (clearing delivers the key) but your provider is no longer able to assign the notifications to an existing entry in his database. Therefore, the sender will not get a receipt notification at all. The transaction is no longer listed in users history. The provider might trigger an error in his logs because of an unknown transaction ID.