RESTAPI:Migrating Cryptshare
Applies to:
Purpose:
This article guides you through a Cryptshare Server migration.
Solution:
Be sure that your Cryptshare Server is running at least version 4.3.0 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
According to our Quick Start Guide Step 2:
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 address
In general, you need a public, static IP address for your Cryptshare Server. In case you have already such an address in use, you'll need only a temporary address as long both servers are needed (the actual one & the new one)
SSL certificate
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
It is mandatory to configure the email address of a user or a user group as administrators of the Cryptshare Server. Cryptshare Server will send notifications to this email address in case of available updates, warnings or errors. Without an administrator email address, the configuration cannot be completed. Decide which email 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
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
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
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 using the instruction Extending available disk space To configure the Temp directory refer to System Startup Settings - Temporary Folder
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 "vm.arg.1=-Djava.io.tmpdir=/var/opt/cryptshare-3/tmp" >> /opt/cryptshare-3/launcher.ini
- 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)/cs3-MovingBackup.zip 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
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
4.3.0
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!
- unpack the backup from the old server into the folder /root/tmp
unzip /opt/cryptshare-3/backup/cs3-MovingBackup.zip -d /root/tmp
- change into new directory
cd /root/tmp/cs3-MovingBackup
- unpack the database
unzip database/db-cs3-Moving.zip -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)