restoreacct — Command Reference
Restore a full Eenos account or selected content from an account backup.
Restore a full Eenos account or selected content from an account backup.
Requirements
Run as root on the Eenos server. A trusted compatible backup, /usr/bin/rsync, working storage and the destination services needed by the backup. Resolve identity, domain, ownership and IP conflicts before restoring.
Usage
The following example uses the operation described below; replace example identities and paths before use:
/usr/local/eenos/scripts/restoreacct /backup/eenosbkp-exampleuser.tar.gz --logArguments and options
| Argument / option | Usage and meaning |
|---|---|
PATH_TO_BACKUP | Positional argument. Full path to Eenos backup |
--log | Flag. Create a custom log file |
--full | Flag. Restore full account. This is default option |
--home | Flag. Restore home directory |
--domain | Value: DOMAIN. Restore a website content |
--email | Value: EMAIL. Restore an email account |
--mysqldb | Value: MYSQLDB. Restore a MySQL database |
--pgsqldb | Value: PGSQLDB. Restore a PgSQL database |
--mongodb | Value: MONGODB. Restore a MongoDB database |
--file | Value: FILE. Restore a single file. The file path need to be relative to homedir Example : public_html/foo/fun.php |
--dir | Value: DIR. Restore a folder. The directory path need to be relative to homedir Example : public_html/foo |
--disk_mount | Value: DISK_MOUNT. The disk mount point to create home directory. By default use the home directory from backup. (Example : /home2) |
--ipv4 | Value: IPV4. Assign a dedicated IPv4 address. By default use the main shared IP address or the IP address from the backup, if exists |
--newname | Value: NEWNAME. Restore backup into new eenos user name This will rename the home directory and database names. WARNING !!! : The websites may stop working due to the change in storage path and database names |
--skipname | Flag. Use the same user name from the backup By default enabled |
--force | Flag. Force restore if account exist in server. This will replace the data only. |
--skipmysql | Flag. Exclude MySQL database(s) restore |
--skiphome | Flag. Exclude Homedir restore |
--skiplets | Flag. Exclude Lets encrypt auto ssl restore |
--skippgsql | Flag. Exclude PgSQL database(s) restore |
--skipmongodb | Flag. Skip Mongodb database(s) restore |
--skipmailman | Flag. Exclude Mailman3 mailing list backups |
--skipemail | Flag. Exclude email accounts restore |
--skipbwdata | Flag. Exclude bandwidth usage history |
--skipdiskusage | Flag. Exclude disk usage history |
--skippublichtml | Flag. Exclude public_html folder restore |
--skipreseller | Flag. Exclude reseller privileges |
-h, --help displays this parser's help. Selectors in the same mutually exclusive group cannot be combined. The installed version remains authoritative for available options.
Operational effects
Writes account data and may create or replace files, databases and configuration. Full restore is the default; choose at most one restore scope. --force can replace existing account data. --newname changes home/database names and can break application references.
File and directory paths are relative to the account home. Full-account skip flags apply to their respective components; they are not substitutes for selecting a restore scope. See migration restore preparation and verification.
Verify the result
Inspect the reported /var/log/backup/restore/ log and verify each restored service. Component handlers do not all provide equally detailed exit-status reporting; inspect results even after a zero exit.
Check operation output and the relevant service/application state. Several legacy wrappers exit successfully after logging a handler failure, so a zero shell exit status alone is not proof of completion.