Skip to end of metadata
Go to start of metadata

Moving to a new virtual Appliance


If you have to answer one or more of these questions about your actual Cryptshare Installation with "yes", we recommend to move your Cryptshare Installation to a new Virtual Appliance.

  • Are you affected from the CPU-Bug with the attack vectors called "Spectre" and or "Meltdown"?
  • Do you assume issues resulting from former Administrators?
  • Do you assume or know about suboptimal former decisions concerning the Appliance? (HDD layout, directories...)
  • Do you have trouble with the HDD-space on your system drive and/or upload directories?
  • Do you want to change your Hypervisor to VMware?
  • Do you want to change your Hypervisor to Hyper-V?
  • Do you want to change from a Hardware Appliance to a Virtual Appliance ?
  • Do you want to change from a self installed Operating System to a Virtual Appliance ?
  • Do you want to change to a Virtual Appliance from a Windows Installation?
  • Do you want to have a Test-Appliance with the same data?


Be sure that your Cryptshare Server is running at least version before proceeding. If not, please update as described here: Updates

The following guide will take you step by step to the new Appliance recommended and tested by our Support staff and customers.

Collect (or better check for completeness) the data for the new appliance

 According to our Quickstartguide Step 2 (Click to expand...)

According to our Quick Start Guide Step 2:

Best Practice

Depending on size and structure of your business, different stakeholders may need to be involved in your preparations.

We strongly recommend you identify these stakeholders during your preparation and have these items completed so the installation can be carried out smoothly.

 New (temporary) IP-Adress (Click to expand...)

In general, you need a public, static IP address for your Cryptshare Server. In Case you have already such an adress in use, you'll need only a temporary adress as long both servers are needed (the actual one & the new one)

 SSL certificate (Click to expand...)

The existing certificate will be copied in the process. If you want to change the certificate please follow SSL Certificate and the related Articles there.

 Select or define the Administrators (Click to expand...)

It is mandatory to configure the e-mail address of a user or a user group as administrators of the Cryptshare Server. Cryptshare Server will send notifications to this e-mail address in case of available updates, warnings or errors. Without an administrator e-mail address, the configuration cannot be completed. Decide which e-mail address should be used and set up a user group in your mail server directory if required.

Create the new Appliance

Create the new Appliance for vSphere or download one for the Hyper-V in our VM Build Service: Cryptshare Buildservice

Create the new UI

While you are waiting for the delivery of the Cryptshare Transfer containing the Appliance, you should take a look at the new possibilities of the Web Application Design:

Create the new Design in our Web Application Designer (if not done already)

Import the delivered Appliance

Install it parallel to your old server in your DMZ

Prepare the Appliance in your Hypervisor (VMware or HyperV)

Check the Virtual Hardware

Refer to the System Requirements

Add an additional Virtual Disk

Cryptshare uses different storage locations to save

  • Temporary files
    Temporary files are created during the upload, virus check, encryption process or any other pre-processing tasks.
  • The transfer payload
    The folder where the payload of the system is stored, i.e. the encrypted files and messages that are being transferred from A to B reside in this folder until they are automatically deleted at the end of the retention time.
  • Backups
    The folder into which you can back up your system configuration, transfer meta data and the transfer data itself.

These storage locations should be sized according to your requirements and have to be configured in the Cryptshare Server.

 Sizing calculation (Click to expand...)

Sizing Calculation

To determine the correct size for your needs, add the results of the following formulas:

suggested Temp folder size = (Max allowed Transfersize * 3)

suggested retention folder size in MByte = ((expected average number of transfers per day) * (expected average transfer size in MByte) * (maximum planned retention time))

suggested backup folder size = depends on your backup strategy

Planning the Backup size requirements

If you want to backup transfer data as well, you will have multiply the space by a factor (x+1) where x is the number of backups of the transfer data you want to keep. However, it is recommended to backup data to a location outside the Cryptshare Server as otherwise, you will lose your productive data and your backup data in case of a disk failure.

This will provide enough space for your transfer data, for the temporary directory and also if you want to back up the system configuration and transfer meta information to this disk.

Now add the additional virtual disk with the preferred size to the appliance.

To configure the additional virtual disk as upload directory, start the following command:

  • csAdministration
  • Select option ‘3) Appliance Configuration’ in the menu displayed
  • Select option ‘5) Attach additional harddisk as upload directory for Cryptshare Version 3’ in the menu displayed

The script will attach the new disk to the system and configure it as new upload directory. Reboot of the Appliance is not necessary.

To configure the Temp directory refer to System Startup Settings - Temporary Folder

enlarge an existing disk

Please follow this guide to enlarge the harddisk if nessecary:

Freeing Disk Space on a Cryptshare Server

Next steps with the new Server

  • Start the Server
  • login via PuTTY as root and proceed with this commands:

    1. deactivate the Cryptshare service
    rccryptshare stop
    2. Set the TEMP Folder to the new disk
    echo "" >> /opt/cryptshare-3/launcher.ini
    echo "" >> /opt/cryptshare-3/launcher.ini

Proceed at the old Cryptshare Server

  • create a Backup of the database at the old system with the Name: cs3-MovingBackup
  • login via PuTTY as root and proceed with this commands:

    deactivate the Cryptshare service
    rccryptshare stop

Now start the Copyjobs to copy the data from the old Cryptshare Server to the new one

1. your actually active Transfers
scp /opt/cryptshare-3/upload (or your actually used path)/* root@CRYPTSHARE_NEW:/var/opt/cryptshare-3/uploads
2. your database Backup
scp /opt/cryptshare-3/backup (or your actually used path)/ root@CRYPTSHARE_NEW:/opt/cryptshare-3/backup
3. your actual SSL-Key
scp /opt/cryptshare-3/lib/security/keystore root@CRYPTSHARE_NEW:/opt/cryptshare-3/lib/security/
4. your actual Web-UI
scp -r /opt/cryptshare-3/resources/ui root@CRYPTSHARE_NEW:/opt/cryptshare-3/resources
 if you changed the ports or SSL-Passwords (Click here to expand...)
5. copy your Interface Config files
scp /opt/cryptshare-3/resources/WEB-INF/?i-config.xml root@CRYPTSHARE_NEW:/opt/cryptshare-3/resources/WEB-INF/

Finishing steps to activate the new Server

  • login via PuTTY as root and proceed with this commands:

    activate the new Cryptshare Server
    rccryptshare start
  • Log in the Administrative Interface and restore the DB-Backup cs3-MovingBackup

    Please note! Using this way the database can be restored if one of the following Cryptshare versions is installed on old server:

    If different versions are used, the web interface will be no more available after the restore.

    Attention! Please restore the database only! Do not restore the system data and/or transfers in this way!

    Restore database from version

    Please use the following steps, to restore the database from Cryptshare

    - unpack the backup from the old server into the folder /root/tmp
    unzip /opt/cryptshare-3/backup/ -d /root/tmp

    - change into new directory
    cd /root/tmp/cs3-MovingBackup

    - unpack the database
    unzip database/ -d cryptshare

    - stop the Cryptshare service
    systemctl stop cryptshare.service

    - replace the database folder
    mv cryptshare /opt/cryptshare-3/orientDB/databases/cryptshare

    - start the Cryptshare service
    systemctl start cryptshare.service

  • Make sure that all path names in the Administration Interface match the actual file locations:
    • Uploads: Check System Settings > Transfer Settings
    • Backups: Check Restore/Backup
    • Temp: Check System Status > Scroll down and click on Java Runtime Environment
    • Disk Space Monitoring: System Settings > System Notifications > Check if all monitored paths are valid
  • change the firewall and DNS-Settings (switch to the new IP-address)