Backups
What needs to be backed up?
- Database and transaction logs
- File Repository (Everything under PT_Repo)
- SSL Certificate : conf/keystore (If configured)
- Encryption Keys : e.g. conf/keys.* If File store encryption is configured
- Indexes : Only for very large installations where an index rebuild is too time-consuming
How to backup?
To backup in PostgreSQL
cd "C:\Program Files"
cd PostgreSQL\9.2\bin
pg_dump -U postgres -h localhost {postgresdb} > "C:\{location}\{location}{backupname}.sql"
psql -U postgres -h localhost {pt8} > C:\{location}\{location}{backupname}.restore.sql
To backup in MySQL
cd MySQL\MySQL Server 5.1\bin
C:\ProgramFiles\MySQL\MySQL Server 5.1\bin>mysql -u {username} -p {password} {MYSQL db} < "e:\database.sql"
Backups in MSSQL can be done from the management console.
Schedule Database Backups using PaperTrail
Papertrail can automatically backup databases on schedule configured under Services → Properties → Backup → DB Schedule (db.backup.schedule).
PaperTrail will run the pgdump, mysql_dump or SQL Server Backup Database command and store the result in the file repository.
Note: Backups can only be made of local database
By default, daily backups are kept on a rotation of 14 days, monthly backups for 3 months. To change these defaults, add the below to the properties file and restart PT
db.backup.daily.rotation=14
db.backup.monthly.rotation=3
Configuring cloud backups
Cloud backups lets you back up the PaperTrail file repository (and optionally the PaperTrail database) in near real time to the Amazon S3 cloud.
If you set up the Amazon S3 account, use the information from that account to configure cloud backups. For Egis managed backups, Egis will supply the information to you.
- From Services → Tasks → Wizards, select Configure cloud backups. Enter the values of the Amazon S3 account in these fields:\
- Bucket The Amazon S3 bucket to use, for example: acme.papertrail\
- Access key An access key that has read and write permissions to the bucket.\
- Secret key
Configuring periodic Windows file share backups
PaperTrail creates an incremental backup ZIP file and copies the ZIP file to the specified shared folder.
Specify these options under the Backup Settings page of the installation wizard or after installation via Services → Tasks → Wizards →
Configure Windows Share backups
- Host – the hostname of the Windows or SMB/CIFS based fileserver\
- Backup Dir – The share and path location (e.g., Backups/Papertrail Relative to the file share, not relative the root director)
- Username and Password if applicable
Ad-Hoc Backup
Typically, do an ad-hoc backup before you upgrade PaperTrail or before
you migrate to a different server.
An ad-hoc backup will export all the files in the repository to a local
or windows file share location. Multiple ZIP files will be created; a
log file for each ZIP file will also be created containing the names of
the files in the corresponding ZIP file.
An ad-hoc backup can be re-run using the same destination path, the logs files will be read and only new files added will be backed up.
- Under Services → Tasks → Backups → Backup Repository
- Destination: Local or windows file share
(
smb://user@pass:host/Share/folder
) - Optional: Check verify to verify the backup once complete
- Max File Size: Enter a maximum file size. Once a backup file reaches this limit (it may not be exact depending on the size of individual files) a new backup file will start.
Restoring from backup
Select Restore from Windows File Share or Cloud from the installation wizard.
3rd Party backup
- Backup the database and applicable transaction logs.
- Backup the PT_Repo directory (defaults to C:\Data\PT_Repo).
Note: PaperTrail does not update files in the PT_Repo directory so once backed up a file does not need to backed-up again.
- For large installations the indexes can also be backed up to
decrease restore times
Under Services → Properties → Backup Specify an Index Backup Schedule & Directory
Native restore from backup
- Restore database and file repository to original locations
- Install PaperTrail
- Check new installation and enter existing database details
Migrate PaperTrail to another host
- On the current server, perform a dump of the DB. Refer to how to backup
- On the new server, install the pre-requisites (Java 8 SDK, LibreOffice, DB application) and create the DB. DO NOT install PaperTrail as yet
- Import the DB dump onto the new server. Example Postgres command:
psql -U postgres papertrail < C:\PTBackup\20170302.sql
- Run the SQL command to update the license on the new server:
update system_property set value = '[License Text]' where name ='license'
- Copy over the PT_Repo and PT_Index directories to the new server
- Complete the install of PaperTrail on the new server
- Copy the following files from the OLD PaperTrail server to the NEW PaperTrail server:
- services_x64.vmoptions
- any customer .jar files in the deploy directory
- MySQL ONLY - copy mysql-connector-{version} from libs directory