Browse Source

[MIG] auto_backup: Migration to 12.0

Added test coverage
Added requirements.txt for pysftp
Added in the roadmap the exact version of pysftp for this to work (0.2.8)
Added in the roadmap the problem with list_db=False
Adapted calls to message_post
pull/1384/head
Aitor Bouzas 6 years ago
parent
commit
f6908c7018
  1. 84
      auto_backup/README.rst
  2. 16
      auto_backup/__manifest__.py
  3. 12
      auto_backup/models/db_backup.py
  4. 3
      auto_backup/readme/CONFIGURE.rst
  5. 6
      auto_backup/readme/CONTRIBUTORS.rst
  6. 1
      auto_backup/readme/DESCRIPTION.rst
  7. 4
      auto_backup/readme/INSTALL.rst
  8. 6
      auto_backup/readme/ROADMAP.rst
  9. 46
      auto_backup/readme/USAGE.rst
  10. 512
      auto_backup/static/description/index.html
  11. 6
      auto_backup/tests/test_db_backup.py
  12. 2
      auto_backup/view/db_backup_view.xml
  13. 1
      requirements.txt

84
auto_backup/README.rst

@ -1,19 +1,44 @@
.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: https://www.gnu.org/licenses/agpl
:alt: License: AGPL-3
==================== ====================
Database Auto-Backup Database Auto-Backup
==================== ====================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/12.0/auto_backup
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-auto_backup
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
A tool for all your back-ups, internal and external! A tool for all your back-ups, internal and external!
**Table of contents**
.. contents::
:local:
Installation Installation
============ ============
Before installing this module, you need to execute:: Before installing this module, you need to execute::
pip3 install pysftp
pip3 install pysftp==0.2.8
Configuration Configuration
============= =============
@ -31,10 +56,10 @@ through an encrypted tunnel. You can even specify how long local backups
and external backups should be kept, automatically! and external backups should be kept, automatically!
Connect with an FTP Server Connect with an FTP Server
--------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~
Keep your data safe, through an SSH tunnel! Keep your data safe, through an SSH tunnel!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------------------
Want to go even further and write your backups to an external server? Want to go even further and write your backups to an external server?
You can with this module! Specify the credentials to the server, specify You can with this module! Specify the credentials to the server, specify
@ -43,10 +68,10 @@ through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
safe! safe!
Test connection Test connection
---------------
~~~~~~~~~~~~~~~
Checks your credentials in one click Checks your credentials in one click
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------
Want to make sure if the connection details are correct and if Odoo can Want to make sure if the connection details are correct and if Odoo can
automatically write them to the remote server? Simply click on the ‘Test automatically write them to the remote server? Simply click on the ‘Test
@ -54,16 +79,16 @@ SFTP Connection’ button and you will get message telling you if
everything is OK, or what is wrong! everything is OK, or what is wrong!
E-mail on backup failure E-mail on backup failure
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
Stay informed of problems, automatically! Stay informed of problems, automatically!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------
Do you want to know if the database backup succeeded or failed? Subscribe to Do you want to know if the database backup succeeded or failed? Subscribe to
the corresponding backup setting notification type. the corresponding backup setting notification type.
Run backups when you want Run backups when you want
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~
From the backups configuration list, press *More > Execute backup(s)* to From the backups configuration list, press *More > Execute backup(s)* to
manually execute the selected processes. manually execute the selected processes.
@ -80,38 +105,53 @@ Known issues / Roadmap
you need to run the backup from outside of the main Odoo instance. How to do you need to run the backup from outside of the main Odoo instance. How to do
this is outlined in `this blog post this is outlined in `this blog post
<https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_. <https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_.
* Backups won't work if list_db=False is configured in the instance.
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
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
`feedback <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**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits Credits
======= =======
Authors
~~~~~~~
* Yenthe Van Ginneken
* Agile Business Group
* Grupo ESOC Ingenieria de Servicios
* LasLabs
* AdaptiveCity
Contributors Contributors
------------
~~~~~~~~~~~~
* Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be> * Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
* Alessio Gerace <alessio.gerace@agilebg.com> * Alessio Gerace <alessio.gerace@agilebg.com>
* Jairo Llopis <yajo.sk8@gmail.com> * Jairo Llopis <yajo.sk8@gmail.com>
* Dave Lasley <dave@laslabs.com> * Dave Lasley <dave@laslabs.com>
* Andrea Stirpe <a.stirpe@onestein.nl> * Andrea Stirpe <a.stirpe@onestein.nl>
* Aitor Bouzas <aitor.bouzas@adaptivecity.com>
Maintainers
~~~~~~~~~~~
Maintainer
----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit https://odoo-community.org.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/auto_backup>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

16
auto_backup/__manifest__.py

@ -1,19 +1,19 @@
# © 2004-2009 Tiny SPRL (<http://tiny.be>).
# © 2015 Agile Business Group <http://www.agilebg.com>
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis
# Copyright 2004-2009 Tiny SPRL (<http://tiny.be>).
# Copyright 2015 Agile Business Group <http://www.agilebg.com>
# Copyright 2016 Grupo ESOC Ingenieria de Servicios, S.L.U. - Jairo Llopis
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{ {
"name": "Database Auto-Backup", "name": "Database Auto-Backup",
"summary": "Backups database", "summary": "Backups database",
"version": "11.0.1.0.0",
"author": (
"version": "12.0.1.0.0",
"author":
"Yenthe Van Ginneken, " "Yenthe Van Ginneken, "
"Agile Business Group, " "Agile Business Group, "
"Grupo ESOC Ingeniería de Servicios, "
"Grupo ESOC Ingenieria de Servicios, "
"LasLabs, " "LasLabs, "
"Odoo Community Association (OCA)"
),
"AdaptiveCity, "
"Odoo Community Association (OCA)",
"license": "AGPL-3", "license": "AGPL-3",
"website": "https://github.com/OCA/server-tools/", "website": "https://github.com/OCA/server-tools/",
"category": "Tools", "category": "Tools",

12
auto_backup/models/db_backup.py

@ -1,6 +1,6 @@
# © 2004-2009 Tiny SPRL (<http://tiny.be>).
# © 2015 Agile Business Group <http://www.agilebg.com>
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis
# Copyright 2004-2009 Tiny SPRL (<http://tiny.be>).
# Copyright 2015 Agile Business Group <http://www.agilebg.com>
# Copyright 2016 Grupo ESOC Ingenieria de Servicios, S.L.U. - Jairo Llopis
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
import logging import logging
@ -215,7 +215,7 @@ class DbBackup(models.Model):
_logger.exception("Database backup failed: %s", self.name) _logger.exception("Database backup failed: %s", self.name)
escaped_tb = tools.html_escape(traceback.format_exc()) escaped_tb = tools.html_escape(traceback.format_exc())
self.message_post( # pylint: disable=translation-required self.message_post( # pylint: disable=translation-required
"<p>%s</p><pre>%s</pre>" % (
body="<p>%s</p><pre>%s</pre>" % (
_("Database backup failed."), _("Database backup failed."),
escaped_tb), escaped_tb),
subtype=self.env.ref( subtype=self.env.ref(
@ -224,7 +224,7 @@ class DbBackup(models.Model):
) )
else: else:
_logger.info("Database backup succeeded: %s", self.name) _logger.info("Database backup succeeded: %s", self.name)
self.message_post(_("Database backup succeeded."))
self.message_post(body=_("Database backup succeeded."))
@api.multi @api.multi
def cleanup(self): def cleanup(self):
@ -261,7 +261,7 @@ class DbBackup(models.Model):
_logger.exception("Cleanup of old database backups failed: %s") _logger.exception("Cleanup of old database backups failed: %s")
escaped_tb = tools.html_escape(traceback.format_exc()) escaped_tb = tools.html_escape(traceback.format_exc())
self.message_post( # pylint: disable=translation-required self.message_post( # pylint: disable=translation-required
"<p>%s</p><pre>%s</pre>" % (
body="<p>%s</p><pre>%s</pre>" % (
_("Cleanup of old database backups failed."), _("Cleanup of old database backups failed."),
escaped_tb), escaped_tb),
subtype=self.env.ref("auto_backup.failure")) subtype=self.env.ref("auto_backup.failure"))

3
auto_backup/readme/CONFIGURE.rst

@ -0,0 +1,3 @@
Go to *Settings -> Database Structure -> Automated Backup* to
create your configurations for each database that you needed
to backups.

6
auto_backup/readme/CONTRIBUTORS.rst

@ -0,0 +1,6 @@
* Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
* Alessio Gerace <alessio.gerace@agilebg.com>
* Jairo Llopis <yajo.sk8@gmail.com>
* Dave Lasley <dave@laslabs.com>
* Andrea Stirpe <a.stirpe@onestein.nl>
* Aitor Bouzas <aitor.bouzas@adaptivecity.com>

1
auto_backup/readme/DESCRIPTION.rst

@ -0,0 +1 @@
A tool for all your back-ups, internal and external!

4
auto_backup/readme/INSTALL.rst

@ -0,0 +1,4 @@
Before installing this module, you need to execute::
pip3 install pysftp==0.2.8

6
auto_backup/readme/ROADMAP.rst

@ -0,0 +1,6 @@
* On larger databases, it is possible that backups will die due to Odoo server
settings. In order to circumvent this without frivolously changing settings,
you need to run the backup from outside of the main Odoo instance. How to do
this is outlined in `this blog post
<https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_.
* Backups won't work if list_db=False is configured in the instance.

46
auto_backup/readme/USAGE.rst

@ -0,0 +1,46 @@
Keep your Odoo data safe with this module. Take automated back-ups,
remove them automatically and even write them to an external server
through an encrypted tunnel. You can even specify how long local backups
and external backups should be kept, automatically!
Connect with an FTP Server
~~~~~~~~~~~~~~~~~~~~~~~~~~
Keep your data safe, through an SSH tunnel!
-------------------------------------------
Want to go even further and write your backups to an external server?
You can with this module! Specify the credentials to the server, specify
a path and everything will be backed up automatically. This is done
through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
safe!
Test connection
~~~~~~~~~~~~~~~
Checks your credentials in one click
------------------------------------
Want to make sure if the connection details are correct and if Odoo can
automatically write them to the remote server? Simply click on the ‘Test
SFTP Connection’ button and you will get message telling you if
everything is OK, or what is wrong!
E-mail on backup failure
~~~~~~~~~~~~~~~~~~~~~~~~
Stay informed of problems, automatically!
-----------------------------------------
Do you want to know if the database backup succeeded or failed? Subscribe to
the corresponding backup setting notification type.
Run backups when you want
~~~~~~~~~~~~~~~~~~~~~~~~~
From the backups configuration list, press *More > Execute backup(s)* to
manually execute the selected processes.
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:alt: Try me on Runbot
:target: https://runbot.odoo-community.org/runbot/149/11.0

512
auto_backup/static/description/index.html

@ -0,0 +1,512 @@
<?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 to
customize 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 terms
dl.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 -&gt; Database Structure -&gt; Automated Backup</em> to
create your configurations for each database that you needed
to 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 server
through an encrypted tunnel. You can even specify how long local backups
and 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, specify
a path and everything will be backed up automatically. This is done
through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
safe!</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 can
automatically write them to the remote server? Simply click on the ‘Test
SFTP Connection’ button and you will get message telling you if
everything 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 to
the 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 &gt; Execute backup(s)</em> to
manually 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 server
settings. In order to circumvent this without frivolously changing settings,
you need to run the backup from outside of the main Odoo instance. How to do
this 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 &lt;<a class="reference external" href="mailto:yenthe.vanginneken&#64;vanroey.be">yenthe.vanginneken&#64;vanroey.be</a>&gt;</li>
<li>Alessio Gerace &lt;<a class="reference external" href="mailto:alessio.gerace&#64;agilebg.com">alessio.gerace&#64;agilebg.com</a>&gt;</li>
<li>Jairo Llopis &lt;<a class="reference external" href="mailto:yajo.sk8&#64;gmail.com">yajo.sk8&#64;gmail.com</a>&gt;</li>
<li>Dave Lasley &lt;<a class="reference external" href="mailto:dave&#64;laslabs.com">dave&#64;laslabs.com</a>&gt;</li>
<li>Andrea Stirpe &lt;<a class="reference external" href="mailto:a.stirpe&#64;onestein.nl">a.stirpe&#64;onestein.nl</a>&gt;</li>
<li>Aitor Bouzas &lt;<a class="reference external" href="mailto:aitor.bouzas&#64;adaptivecity.com">aitor.bouzas&#64;adaptivecity.com</a>&gt;</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 whose
mission is to support the collaborative development of Odoo features and
promote 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>

6
auto_backup/tests/test_db_backup.py

@ -1,6 +1,6 @@
# © 2015 Agile Business Group <http://www.agilebg.com>
# © 2015 Alessio Gerace <alesiso.gerace@agilebg.com>
# © 2016 Grupo ESOC Ingeniería de Servicios, S.L.U. - Jairo Llopis
# Copyright 2015 Agile Business Group <http://www.agilebg.com>
# Copyright 2015 Alessio Gerace <alesiso.gerace@agilebg.com>
# Copyright 2016 Grupo ESOC Ingenieria de Servicios, S.L.U. - Jairo Llopis
# Copyright 2016 LasLabs Inc. # Copyright 2016 LasLabs Inc.
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

2
auto_backup/view/db_backup_view.xml

@ -18,7 +18,7 @@
<field name="backup_format"/> <field name="backup_format"/>
</group> </group>
<div attrs="{'invisible': [('method', '!=', 'sftp')]}"> <div attrs="{'invisible': [('method', '!=', 'sftp')]}">
<div class="bg-warning text-warning">
<div class="bg-warning">
<h3>Warning:</h3> <h3>Warning:</h3>
Use SFTP with caution! This writes files to external servers under the path you specify. Use SFTP with caution! This writes files to external servers under the path you specify.
</div> </div>

1
requirements.txt

@ -2,3 +2,4 @@ raven
openpyxl openpyxl
xlrd xlrd
xlwt xlwt
pysftp
Loading…
Cancel
Save