Migratehelper

Languages:

English  • français

migratehelper

migratehelper logo
Maintainer	[[user:Jean-Philippe Pialasse|Jean-Philippe Pialasse]]
Url	https://wiki.contribs.org
Licence	GPL
Category	Category you want
Tags	backup, restore, contribs

	Work in Progress:
	this is a work in progress, contrib is currently in development. Please follow the bug list at the end of the page. has marked this page as a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.

Maintainer

Jean-Philippe Pialasse

Version

Contrib 10:

1.0-10

smeserver-migratehelper

The latest version of smeserver-migratehelper is available in the SME repository, click on the version number(s) for more information.

Description

This is a suite of script intended to help backup and restore when migrating to another box with same SME version or more recent.

It will create an archive similar to the console usb backup, hence allowing console restore at startup directly after install.

It will backup all the already known by the script locations for every installed contribs.

It will also backup some user space known to have potential manually added files.

It will create a list of rpm currently installed and break them down to ease the install later.

A WIP will be to download the rpms from the repos to allow quick reinstall. A script will be used later to allow download from a more recent version.

There is also an exclusion list. By default /home/e-smith/files is in this exclusion list So you can have a server backup and restore faster, It assumes you backup those files separately and restore them manually latter (or have them on a separate mount point you can easily remount latter), as the server can boot without them on install.

Installation

For SME 10For SME 9

yum --enablerepo=smecontribs install smeserver-migratehelper

wget https://viewvc.koozali.org/smecontribs/rpms/smeserver-migratehelper/contribs10/migratehelper.sh -O /usr/bin/migratehelper.sh

Usage and behaviour

You must first create the mount point and mount your external disk already formatted and with sufficient place to receive the archive:

mkdir /mnt/backup
mount /dev/mydisk /mnt/backup

You can then edit the script and Add you directories or files to include in the dir.list section, your exclusion in exclude.list section. Then check all your contribs are listed, and the associated destination are correct.

vim /usr/bin/migratehelper.sh

Then run the script

	Warning:
	When starting this script : it will create the list of files to backup, then it will stop services that could modify your backup qmail.service qpsmtpd.service sqpsmtpd.service ejabberd.service smb.service smbd.service nmbd.service httpd-e-smith.service Do a pre-backup event and then create the tar file in /mnt/backup/smeserver.tgz

/usr/bin/migratehelper.sh

It will then process all the files to backup and display the progress on screen. After creating the definitive list depending on installed rpms, it will then Create a list of rpm installed and breakdown them in two easy to restore lists :

files	description
/root/newrpms	output of /sbin/e-smith/auditiools/newrpms
/root/contribs	previous output filtered for smeserver-* rpms
/root/rpmsextra	all other non base distro rpms.

Default backup list

note : we are excluding /home/e-smith/{files,shares} and /home/e-smith/db/mysql*/{daily,hourly}

/etc/e-smith/templates-custom
/etc/e-smith/templates-user-custom
/etc/group
/etc/gshadow
/etc/passwd
/etc/samba/secrets.tdb
/etc/samba/smbpasswd
/etc/shadow
/etc/smbpasswd
/etc/ssh
/etc/sudoers
/root
/home/e-smith/Maildir
/home/e-smith/home
/home/e-smith/ssl.crt
/home/e-smith/ssl.key
/home/e-smith/dkim_keys
/home/e-smith/db
/var/lib/dhcpd/dhcpd.leases
/var/log/qpsmtpd
/var/log/sqpsmtpd
/var/log/qmail
/var/log/httpd/
/var/log/dovecot/
/var/log/squid
/var/log/iptables/
/var/spool/mail/
/var/spool/spamd/
/var/log/samba/samba_audit
/var/service/qpsmtpd/config/dkimkeys/

also we add any non rpm owned files in

/usr/local/bin/
/etc/cron.*
/etc/udev/rules.d/

Default exclusions

	Warning:
	When starting this script : /home/e-smith/files /home/e-smith/shares are EXCLUDED by default, because we expect a huge amount of user data that you could rsync later after having your new server up and running, and kept the old one up. This will allow you to be up and running faster than waiting to gzip gigabyte of data, transfer them and ungzip them.

/home/e-smith/db/mysql/daily
/home/e-smith/db/mysql/hourly
/home/e-smith/db/mysql55/daily
/home/e-smith/db/mysql55/hourly
/home/e-smith/db/mysql57/daily
/home/e-smith/db/mysql57/hourly
/home/e-smith/files
/home/e-smith/shares
/etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/20LoadModule80PHP
/etc/e-smith/templates-custom/etc/hosts.allow/sshd
/etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/35SSL00Listen443
/etc/e-smith/templates-custom/etc/dhcpd.conf/25DomainNameServers
/etc/e-smith/templates-custom/etc/dhcpd.conf/25LeaseTimeDefault
/etc/e-smith/templates-custom/etc/dhcpd.conf/25LeaseTimeMax
/etc/e-smith/templates-custom/etc/dhcpd.conf/25Routers

Supported contribs

this is a list of currently configured and known contribs to save in the process. Please be aware that it is not exhaustive. Check if your is in there, and check that all the needed files are indeed included.

smeserver-awstats
smeserver-BackupPC4
smeserver-BackupPC
smeserver-bandwidthd
smeserver-clamav-unofficial-sigs
smeserver-dansguardian 
smeserver-dansguardian 
smeserver-dansguardian-panel
smeserver-denyhosts
smeserver-dl 
dokuwiki
smeserver-durep
smeserver-ezmlm-web
smeserver-freepbx
smeserver-fail2ban
smeserver-grr
ipasserelle-im
smeserver-isoqlog
smeserver-jappix
smeserver-lemonldap-ng
smeserver-letsencrypt
smeserver-limesurvey
ipasserelle-listes 
smeserver-madsonic
smeserver-mailman
smeserver-nextcloud
smeserver-ntop
smeserver-openvpn-bridge
smeserver-openvpn-routed
smeserver-openvpn-s2s
phpki
phpki-ng
smeserver-phpki
smeserver-phpki-ng
pydio
smeserver-sarg 
smeserver-sme8admin 
smeserver-sme9admin
smeserver-sysmon
smeserver-tftp-server
smeserver-transmission
smeserver-unifi
smeserver-xt_geoip
smeserver-webfilter
smeserver-webshares
smeserver-zabbix-agent 
smeserver-zabbix-proxy
smeserver-zabbix-server 
smeserver-zoneminder

Contribs known that does not need any file backup

1. smeserver-bridge-interface
2. smeserver-ddclient
3. smeserver-email-management
4. smeserver-geoip
5. smeserver-kronolith
6. smeserver-lazy_admin_tools
7. smeserver-learn
8. smeserver-mailsorting
9. smeserver-mailstats
10. smeserver-mediatomb
11. smeserver-mod_dav
12. smeserver-nag
13. smeserver-php-fpm
14. smeserver-php-scl
15. smeserver-phpldapadmin.
16. smeserver-phpsysinfo
17. smeserver-qmHandle
18. smeserver-remoteuseraccess
19. smeserver-sane
20. smeserver-usbdisksmanager
21. smeserver-userpanel
22. smeserver-userpanels
23. smeserver-vacation
24. smeserver-wbl
25. smeserver-webapps-common
26. smeserver-webhosting

Uninstall

yum remove smeserver-migratehelper

Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-migratehelper component or use this link

Below is an overview of the current issues for this contrib:

No open bugs found.

Changelog

Only released version in smecontrib are listed here.

smeserver-migratehelper Changelog: SME 10 (smecontribs)

2021/12/02 Jean-Philippe Pialasse 1.0-10.sme
- remove non existing standard path /home/e-smith/home

2021/11/14 John Crisp 1.0-9.sme
- Fix JPs typo

2021/11/14 John Crisp 1.0-8.sme
- fix mangled fail2ban conf backup lines

2021/11/14 John Crisp 1.0-7.sme
- remove debug line left by mistake

2021/10/29 John Crisp 1.0-6.sme
- add check/create for a /mnt/backup dir
- Fix typos
- Fix bash syntax errors via the IDE plugin

- Add some switches for help, test, no confirm