cronbackup
v0.3.0
Published
Nuxeo Content Management System cron backup application
Downloads
5
Maintainers
Readme
Nuxeo Cron Backup
This is a node.js application I have developed to backup Nuxeo 5.5 open source Enterprise Content Management system. At the moment the target system is Windows but adapting it to Linux or OSX should be an easy task.
The application periodically commits all Nuxeo data to a local Git repository and is able to restore a specific revision to the disk without having to restart Nuxeo server (at least it may be necessary that you disconnect to refresh the application cache). All you have to do is to click on the "Restore" button.
Install
Install Node 0.6.X then:
npm install cronbackup
You also need to download and install Git for Windows.
If it's installed in the default folder (C:\Program Files (x86)\Git), the
application will manage to find it itself, otherwise you will have to enter the
full path to cmd/git.cmd
in the settings.json
configuration file (search
git.cmd
field).
Usage
If you accepted all the default settings when you installed Nuxeo, all you have to do is to run the Express application:
node app
If all goes well, you're ready to visit your backup application at:
http://localhost:3000
The Web interface is pretty simple. It shows a list of the different backup versions available. You can click on an item to see some more details and to restore it to the disk.
Configuration
All available configuration options can be found in settings.json
:
cron.data
-- cron time pattern for Nuxeo data backupcron.program
-- cron time pattern for Nuxeo program backupport
-- Bind the app server to the given portauth
-- HTTP basic authentication user name and passwordgit.cmd
-- Command to use in order to launch the stupid content trackergit.dir
-- Base path to the repositoriesgit.config
-- Git repository optionsnuxeo.regkey
-- Windows registry key where to read Nuxeo configuration valuesnuxeo.configfile
-- Path to nuxeo.conf filenuxeo.vardir
-- Path to Nuxeo Program Datanuxeo.path
-- Path to Nuxeo programnuxeo.datadir
-- Path to Nuxeo data foldernuxeo.logdir
-- Path to Nuxeo logs foldernuxeo.requiredParam
-- A config error is thrown if this array values are not set in nuxeo.confnuxeo.dumpfile
-- Path to database dump file (must be somewhere in Nuxeo Program Data folder)db.regkey
-- Windows registry key where to read Postgresql configuration valuesdb.dump
-- Command to use in order to launch the pg_dump utilitydb.restore
-- Command to use in order to launch the pg_restore utilitydb.host
-- Nuxeo database host URLdb.port
-- Nuxeo database host portdb.name
-- Nuxeo database namedb.user
-- Nuxeo database user namedb.password
-- Nuxeo database passworddb.pgpass
-- Path to database password filelog
-- Logging configuration (see log4js documentation).
To customize the Cron Patterns, see this documentation.
(00 30 22 * * 2-6
means that a backup will run from Monday through Friday at 22:30:00).
Testing
To come.
License
(The MIT License)
Copyright (c) 2012 F. Viaud-Murat <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.