|
|
<?xml version="1.0" encoding="utf-8" ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" /><title>Database Auto-Backup</title><style type="text/css">
/*:Author: David Goodger (goodger@python.org):Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how tocustomize this style sheet.*/
/* used to remove borders from tables and images */.borderless, table.borderless td, table.borderless th { border: 0 }
table.borderless td, table.borderless th { /* Override padding for "table.docutils td" with "! important". The right padding separates the table cells. */ padding: 0 0.5em 0 0 ! important }
.first { /* Override more specific margin styles with "! important". */ margin-top: 0 ! important }
.last, .with-subtitle { margin-bottom: 0 ! important }
.hidden { display: none }
.subscript { vertical-align: sub; font-size: smaller }
.superscript { vertical-align: super; font-size: smaller }
a.toc-backref { text-decoration: none ; color: black }
blockquote.epigraph { margin: 2em 5em ; }
dl.docutils dd { margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { overflow: hidden;}
/* Uncomment (and remove this text!) to get bold-faced definition list termsdl.docutils dt { font-weight: bold }*/
div.abstract { margin: 2em 5em }
div.abstract p.topic-title { font-weight: bold ; text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,div.hint, div.important, div.note, div.tip, div.warning { margin: 2em ; border: medium outset ; padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,div.important p.admonition-title, div.note p.admonition-title,div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,div.danger p.admonition-title, div.error p.admonition-title,div.warning p.admonition-title, .code .error { color: red ; font-weight: bold ; font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in compound paragraphs.div.compound .compound-first, div.compound .compound-middle { margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle { margin-top: 0.5em }*/
div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic }
div.dedication p.topic-title { font-weight: bold ; font-style: normal }
div.figure { margin-left: 2em ; margin-right: 2em }
div.footer, div.header { clear: both; font-size: smaller }
div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em }
div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ; margin-left: 1.5em }
div.sidebar { margin: 0 0 0.5em 1em ; border: medium outset ; padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ; clear: right }
div.sidebar p.rubric { font-family: sans-serif ; font-size: medium }
div.system-messages { margin: 5em }
div.system-messages h1 { color: red }
div.system-message { border: medium outset ; padding: 1em }
div.system-message p.system-message-title { color: red ; font-weight: bold }
div.topic { margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { margin-top: 0.4em }
h1.title { text-align: center }
h2.subtitle { text-align: center }
hr.docutils { width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left { clear: left ; float: left ; margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right { clear: right ; float: right ; margin-left: 1em }
img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto;}
table.align-center { margin-left: auto; margin-right: auto;}
.align-left { text-align: left }
.align-center { clear: both ; text-align: center }
.align-right { text-align: right }
/* reset inner alignment in figures */div.align-right { text-align: inherit }
/* div.align-center * { *//* text-align: left } */
.align-top { vertical-align: top }
.align-middle { vertical-align: middle }
.align-bottom { vertical-align: bottom }
ol.simple, ul.simple { margin-bottom: 1em }
ol.arabic { list-style: decimal }
ol.loweralpha { list-style: lower-alpha }
ol.upperalpha { list-style: upper-alpha }
ol.lowerroman { list-style: lower-roman }
ol.upperroman { list-style: upper-roman }
p.attribution { text-align: right ; margin-left: 50% }
p.caption { font-style: italic }
p.credits { font-style: italic ; font-size: smaller }
p.label { white-space: nowrap }
p.rubric { font-weight: bold ; font-size: larger ; color: maroon ; text-align: center }
p.sidebar-title { font-family: sans-serif ; font-weight: bold ; font-size: larger }
p.sidebar-subtitle { font-family: sans-serif ; font-weight: bold }
p.topic-title { font-weight: bold }
pre.address { margin-bottom: 0 ; margin-top: 0 ; font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */pre.code, code { background-color: #eeeeee }pre.code .comment, code .comment { color: #5C6576 }pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }pre.code .literal.string, code .literal.string { color: #0C5404 }pre.code .name.builtin, code .name.builtin { color: #352B84 }pre.code .deleted, code .deleted { background-color: #DEB0A1}pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier { font-family: sans-serif ; font-style: oblique }
span.classifier-delimiter { font-family: sans-serif ; font-weight: bold }
span.interpreted { font-family: sans-serif }
span.option { white-space: nowrap }
span.pre { white-space: pre }
span.problematic { color: red }
span.section-subtitle { /* font-size relative to parent (h1..h6 element) */ font-size: 80% }
table.citation { border-left: solid 1px gray; margin-left: 1px }
table.docinfo { margin: 2em 4em }
table.docutils { margin-top: 0.5em ; margin-bottom: 0.5em }
table.footnote { border-left: solid 1px black; margin-left: 1px }
table.docutils td, table.docutils th,table.docinfo td, table.docinfo th { padding-left: 0.5em ; padding-right: 0.5em ; vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name { font-weight: bold ; text-align: left ; white-space: nowrap ; padding-left: 0 }
/* "booktabs" style (no vertical lines) */table.docutils.booktabs { border: 0px; border-top: 2px solid; border-bottom: 2px solid; border-collapse: collapse;}table.docutils.booktabs * { border: 0px;}table.docutils.booktabs th { border-bottom: thin solid; text-align: left;}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { font-size: 100% }
ul.auto-toc { list-style-type: none }
</style></head><body><div class="document" id="database-auto-backup"><h1 class="title">Database Auto-Backup</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!!! changes will be overwritten. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --><p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/auto_backup"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-auto_backup"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p><p>A tool for all your back-ups, internal and external!</p><p><strong>Table of contents</strong></p><div class="contents local topic" id="contents"><ul class="simple"><li><a class="reference internal" href="#installation" id="id1">Installation</a></li><li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li><li><a class="reference internal" href="#usage" id="id3">Usage</a><ul><li><a class="reference internal" href="#connect-with-an-ftp-server" id="id4">Connect with an FTP Server</a><ul><li><a class="reference internal" href="#keep-your-data-safe-through-an-ssh-tunnel" id="id5">Keep your data safe, through an SSH tunnel!</a></li></ul></li><li><a class="reference internal" href="#test-connection" id="id6">Test connection</a><ul><li><a class="reference internal" href="#checks-your-credentials-in-one-click" id="id7">Checks your credentials in one click</a></li></ul></li><li><a class="reference internal" href="#e-mail-on-backup-failure" id="id8">E-mail on backup failure</a><ul><li><a class="reference internal" href="#stay-informed-of-problems-automatically" id="id9">Stay informed of problems, automatically!</a></li></ul></li><li><a class="reference internal" href="#run-backups-when-you-want" id="id10">Run backups when you want</a></li></ul></li><li><a class="reference internal" href="#known-issues-roadmap" id="id11">Known issues / Roadmap</a></li><li><a class="reference internal" href="#bug-tracker" id="id12">Bug Tracker</a></li><li><a class="reference internal" href="#credits" id="id13">Credits</a><ul><li><a class="reference internal" href="#authors" id="id14">Authors</a></li><li><a class="reference internal" href="#contributors" id="id15">Contributors</a></li><li><a class="reference internal" href="#maintainers" id="id16">Maintainers</a></li></ul></li></ul></div><div class="section" id="installation"><h1><a class="toc-backref" href="#id1">Installation</a></h1><p>Before installing this module, you need to execute:</p><pre class="literal-block">pip3 install pysftp==0.2.8</pre></div><div class="section" id="configuration"><h1><a class="toc-backref" href="#id2">Configuration</a></h1><p>Go to <em>Settings -> Database Structure -> Automated Backup</em> tocreate your configurations for each database that you neededto backups.</p></div><div class="section" id="usage"><h1><a class="toc-backref" href="#id3">Usage</a></h1><p>Keep your Odoo data safe with this module. Take automated back-ups,remove them automatically and even write them to an external serverthrough an encrypted tunnel. You can even specify how long local backupsand external backups should be kept, automatically!</p><div class="section" id="connect-with-an-ftp-server"><h2><a class="toc-backref" href="#id4">Connect with an FTP Server</a></h2><div class="section" id="keep-your-data-safe-through-an-ssh-tunnel"><h3><a class="toc-backref" href="#id5">Keep your data safe, through an SSH tunnel!</a></h3><p>Want to go even further and write your backups to an external server?You can with this module! Specify the credentials to the server, specifya path and everything will be backed up automatically. This is donethrough an SSH (encrypted) tunnel, thanks to pysftp, so your data issafe!</p></div></div><div class="section" id="test-connection"><h2><a class="toc-backref" href="#id6">Test connection</a></h2><div class="section" id="checks-your-credentials-in-one-click"><h3><a class="toc-backref" href="#id7">Checks your credentials in one click</a></h3><p>Want to make sure if the connection details are correct and if Odoo canautomatically write them to the remote server? Simply click on the ‘TestSFTP Connection’ button and you will get message telling you ifeverything is OK, or what is wrong!</p></div></div><div class="section" id="e-mail-on-backup-failure"><h2><a class="toc-backref" href="#id8">E-mail on backup failure</a></h2><div class="section" id="stay-informed-of-problems-automatically"><h3><a class="toc-backref" href="#id9">Stay informed of problems, automatically!</a></h3><p>Do you want to know if the database backup succeeded or failed? Subscribe tothe corresponding backup setting notification type.</p></div></div><div class="section" id="run-backups-when-you-want"><h2><a class="toc-backref" href="#id10">Run backups when you want</a></h2><p>From the backups configuration list, press <em>More > Execute backup(s)</em> tomanually execute the selected processes.</p><a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/149/11.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a></div></div><div class="section" id="known-issues-roadmap"><h1><a class="toc-backref" href="#id11">Known issues / Roadmap</a></h1><ul class="simple"><li>On larger databases, it is possible that backups will die due to Odoo serversettings. In order to circumvent this without frivolously changing settings,you need to run the backup from outside of the main Odoo instance. How to dothis is outlined in <a class="reference external" href="https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/">this blog post</a>.</li><li>Backups won’t work if list_db=False is configured in the instance.</li></ul></div><div class="section" id="bug-tracker"><h1><a class="toc-backref" href="#id12">Bug Tracker</a></h1><p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.In case of trouble, please check there if your issue has already been reported.If you spotted it first, help us smashing it by providing a detailed and welcomed<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20auto_backup%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p><p>Do not contact contributors directly about support or help with technical issues.</p></div><div class="section" id="credits"><h1><a class="toc-backref" href="#id13">Credits</a></h1><div class="section" id="authors"><h2><a class="toc-backref" href="#id14">Authors</a></h2><ul class="simple"><li>Yenthe Van Ginneken</li><li>Agile Business Group</li><li>Grupo ESOC Ingenieria de Servicios</li><li>LasLabs</li><li>AdaptiveCity</li></ul></div><div class="section" id="contributors"><h2><a class="toc-backref" href="#id15">Contributors</a></h2><ul class="simple"><li>Yenthe Van Ginneken <<a class="reference external" href="mailto:yenthe.vanginneken@vanroey.be">yenthe.vanginneken@vanroey.be</a>></li><li>Alessio Gerace <<a class="reference external" href="mailto:alessio.gerace@agilebg.com">alessio.gerace@agilebg.com</a>></li><li>Jairo Llopis <<a class="reference external" href="mailto:yajo.sk8@gmail.com">yajo.sk8@gmail.com</a>></li><li>Dave Lasley <<a class="reference external" href="mailto:dave@laslabs.com">dave@laslabs.com</a>></li><li>Andrea Stirpe <<a class="reference external" href="mailto:a.stirpe@onestein.nl">a.stirpe@onestein.nl</a>></li><li>Aitor Bouzas <<a class="reference external" href="mailto:aitor.bouzas@adaptivecity.com">aitor.bouzas@adaptivecity.com</a>></li></ul></div><div class="section" id="maintainers"><h2><a class="toc-backref" href="#id16">Maintainers</a></h2><p>This module is maintained by the OCA.</p><a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a><p>OCA, or the Odoo Community Association, is a nonprofit organization whosemission is to support the collaborative development of Odoo features andpromote its widespread use.</p><p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/auto_backup">OCA/server-tools</a> project on GitHub.</p><p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p></div></div></div></body></html>
|
