This page describes the method to use the auto-deploy technology for creating a new empty DMS environment, and for restoring a new DMS environment from a backup.
Git repositories involved in the process are (PI internal links only):
i) Deploy script: This contains the script logic.
http://172.20.32.20:7990/projects/DMSCLIENT/repos/deploy_script/browse/
ii) Default template: This contains a template for the client-specific configuration repository.
http://172.20.32.20:7990/projects/DMSCLIENT/repos/default_config/browse
iii) Client repository: This will contain the client specific repo.
http://172.20.32.20:7990/projects/DMSCLIENT/repos/<clientname>/browse
vi) Restore script repository: This contains the script and service files to create new document repository.
http://172.20.32.20:7990/projects/DMSCLIENT/repos/restore_script/browse
Common deployment steps:
- Fork Default template to client specific repository with <clientname>;
- Edit configuration files in client specific git repository as required for specific client’s DMS environment. Most of the times, only changes to
containers.conf, dms.conf,
and, if applicable,postfix-config.sh
will need to be made. Edits to the remaining files (e.g.commands.conf
) will be rare and only required in special situations, such as, for example, if proxy setups need to be catered for. They should only be made if you are sure you understand what you are doing. Make sure changes are pushed back to repository;
Please make sure to change the standard NUXEO_PASSWORD in the dms.conf. Clone client specific repository to
~/deploy/config/
to store configuration files (be sure to change${clientname}
variable to match the client specific repo name):git clone ssh://git@edmssupport.pace-ip.com:7999/dmsclient/${clientname}.git ~/deploy/config
Clone deploy script repository to
~/deploy/deploy_script/
to store deploy script logic files - if you start out from the preconfigured DMS VM images, this step can be skipped:git clone ssh://git@edmssupport.pace-ip.com:7999/dmsclient/deploy_script.git ~/deploy/deploy_script
Clone restore script repository to
~/deploy/restore_script/
to store restore script logic files - if you start out from the preconfigured DMS VM images, this step can be skipped:git clone ssh://git@edmssupport.pace-ip.com:7999/dmsclient/restore_script.git ~/deploy/restore_script
- Update the deploy and restore scripts as per below instructions.
- Create an empty nuxeo repository or restore from a backup of a DMS (see below);
- Copy any fonts you intend using to
/storage/nuxeo/fonts/
(unless you are using a different storage location; if so, adapt accordingly); - Deploy and startup the DMS containers by cd'ing into
~/deploy/deploy_script/
folder and running "./deploy.sh
" with necessary options. For options and further instructions, see here.
Steps to update the deploy and restore scripts:
From within the ~/deploy/restore_script/
directory as well as the ~/deploy/deploy_script/
run:
git.sh -i /root/.ssh/git_id_rsa pull
Steps to create empty nuxeo repository:
Go to the ~/deploy/restore_script/
and run "./create.sh
" script.
After successful finish of the script you will have an empty nuxeo repository with Patricia workspace created with proper permissions and a settings.xml template for client environment specific modification.
Steps to restore from DMS backup (Transfer from non-zc to zc):
Go to ~/deploy/restore_script/
to modify config.sh
configuration file to specify the paths to the backup files, and run "./create.sh
" script.
After successful finish of the script you will have a DMS restored from the backup.