Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17.0][MIG] auto_backup: Migration to 17.0 #3180

Open
wants to merge 52 commits into
base: 17.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
aa49001
Update english pot file
Yenthe666 Mar 26, 2015
8a528e5
Open FTP session on the last moment possible
archetipo May 11, 2015
2ca4176
[auto_backup] Refactor.
Mar 9, 2016
9ec0858
FIX License type
archetipo Mar 22, 2016
93676c7
[FIX] auto_backup: bad reference to field sftp_private_key (#423)
jabibi May 18, 2016
9985541
[FIX] logger db_backup for pysftp (#419)
bealdav May 26, 2016
663c05c
[FIX] remove en.po that was erroneously created by transbot
sbidoul Aug 15, 2016
5263b60
[MIG] auto_backup: Migrate to v9
lasley Aug 23, 2016
29cce1c
[auto_backup] FIX: failure type notification
Yenthe666 Jan 23, 2017
621c596
[10.0][auto_backup] Menu entry moved (#735)
astirpe Feb 15, 2017
2e03c0e
FIX sftp unlink path (#767)
eLBati Mar 17, 2017
cc52bf1
Fix icon Test SFTP Connection (#825)
astirpe May 1, 2017
a63603a
[11.0][MIG] auto_backup
astirpe Feb 15, 2018
434beb7
[FIX] syntax error in nl.po
sbidoul Jun 17, 2018
fb3af72
Translated using Weblate (Dutch)
JosDeGraeve Jun 18, 2018
5f00668
[FIX] auto_backup: Fix NL translation
pedrobaeza Jun 22, 2018
e0fc25b
auto_backup: allow to change the format of backup (#1333)
foutoucour Aug 10, 2018
5f44deb
[MIG] auto_backup: Migration to 12.0
aitorbouzas Oct 8, 2018
81208b0
Translated using Weblate (Portuguese (Brazil))
Aug 30, 2019
3ef2b4c
Translated using Weblate (Chinese (Simplified))
liweijie0812 Aug 30, 2019
0527ec9
Translated using Weblate (Croatian)
badbole Nov 13, 2019
c9b0209
[IMP] auto_backup: black, isort, prettier
dalonsod Feb 5, 2021
cad2673
[MIG] auto_backup: Migration to 13.0
dalonsod Feb 5, 2021
b640c34
[IMP] auto_backup: black, isort, prettier
SimoneVagile Jul 23, 2021
95fef12
[14.0][MIG]auto_backup
SimoneVagile Mar 11, 2021
807c6d8
[FIX] Tests with mock
SimoneVagile Mar 23, 2021
9bdbf3c
Translated using Weblate (Italian)
primes2h Dec 22, 2021
816f2a5
Translated using Weblate (Catalan)
extrememicro Feb 14, 2022
3b3936c
Translated using Weblate (Spanish (Argentina))
ibuioli Mar 17, 2022
5ff318a
Translated using Weblate (Italian)
rbellanova Mar 17, 2022
4a1cc7d
Translated using Weblate (Croatian)
badbole Aug 22, 2022
5dd97ef
[15][MIG] :tada: Migrate auto_backup
anhvu-sg Sep 21, 2022
8d0aedf
Translated using Weblate (Spanish (Argentina))
ibuioli Oct 9, 2022
49fd083
Translated using Weblate (Italian)
mymage Dec 28, 2022
7a91ead
Translated using Weblate (Italian)
francesco-ooops Dec 30, 2022
b90b5af
Translated using Weblate (Italian)
mymage Jan 1, 2023
4868296
Update translation files
weblate Jan 12, 2023
b1d4654
Translated using Weblate (Spanish (Argentina))
ibuioli Jan 15, 2023
a74b24d
[FIX] Pin cryptography to keep compatibility with Odoo's pyopenssl==1…
StefanRijnhart Jan 23, 2023
302a07d
Translated using Weblate (Italian)
francesco-ooops Mar 9, 2023
32a56df
Translated using Weblate (Italian)
mymage Apr 5, 2023
a1661c4
[IMP] auto_backup: pre-commit stuff
tafaRU Sep 11, 2023
6174eea
[MIG] auto_backup: Migration to 16.0
tafaRU Sep 11, 2023
2ed5e94
[UPD] Update auto_backup.pot
Dec 1, 2023
7f7ad13
Translated using Weblate (Spanish)
Ivorra78 Dec 7, 2023
fb8bf89
Translated using Weblate (Italian)
mymage Dec 24, 2023
d2279a2
[UPD] Update auto_backup.pot
May 24, 2024
407450c
Update translation files
weblate May 24, 2024
798ad05
Translated using Weblate (Italian)
mymage May 28, 2024
5d01d2f
Translated using Weblate (Portuguese (Brazil))
May 29, 2024
829983a
[IMP] auto_backup: pre-commit auto fixes
rpinset Jun 28, 2024
1057955
[MIG] auto_backup: Migration to 17.0
rpinset Jun 28, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 164 additions & 0 deletions auto_backup/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
====================
Database Auto-Backup
====================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:163fe86803c25bd1647c8a149b89b15db756b9f3551c73e29bc93c5d1d31a2ee
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/17.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-17-0/server-tools-17-0-auto_backup
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

A tool for all your back-ups, internal and external!

**Table of contents**

.. contents::
:local:

Installation
============

Before installing this module, you need to execute:

::

pip3 install pysftp==0.2.9

Configuration
=============

Go to *Settings -> Database Structure -> Automated Backup* to create
your configurations for each database that you needed to backups.

Usage
=====

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.

|Try me on Runbot|

.. |Try me on Runbot| image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:target: https://runbot.odoo-community.org/runbot/149/11.0

Known issues / Roadmap
======================

- 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.

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20auto_backup%0Aversion:%2017.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
=======

Authors
-------

* Yenthe Van Ginneken
* Agile Business Group
* Grupo ESOC Ingenieria de Servicios
* LasLabs
* AdaptiveCity

Contributors
------------

- Yenthe Van Ginneken <[email protected]>
- Alessio Gerace <[email protected]>
- Jairo Llopis <[email protected]>
- Dave Lasley <[email protected]>
- Andrea Stirpe <[email protected]>
- Aitor Bouzas <[email protected]>
- Simone Vanin <[email protected]>
- Vu Nguyen Anh <[email protected]>
- Alex Comba <[email protected]>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/17.0/auto_backup>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions auto_backup/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from . import models
28 changes: 28 additions & 0 deletions auto_backup/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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).

{
"name": "Database Auto-Backup",
"summary": "Backups database",
"version": "17.0.1.0.0",
"author": "Yenthe Van Ginneken, "
"Agile Business Group, "
"Grupo ESOC Ingenieria de Servicios, "
"LasLabs, "
"AdaptiveCity, "
"Odoo Community Association (OCA)",
"license": "AGPL-3",
"website": "https://github.com/OCA/server-tools",
"category": "Tools",
"depends": ["mail"],
"data": [
"data/ir_cron.xml",
"data/mail_message_subtype.xml",
"security/ir.model.access.csv",
"view/db_backup_view.xml",
],
"installable": True,
"external_dependencies": {"python": ["pysftp", "cryptography"]},
}
17 changes: 17 additions & 0 deletions auto_backup/data/ir_cron.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="ir_cron_backup_scheduler_0" model="ir.cron">
<field name="name">Backup Scheduler</field>
<field name="user_id" ref="base.user_root" />
<field name="interval_number">1</field>
<field name="interval_type">days</field>
<field name="numbercall">-1</field>
<field
name="nextcall"
eval="(datetime.now() + timedelta(days=1)).strftime('%Y-%m-%d 03:00:00')"
/>
<field name="model_id" ref="model_db_backup" />
<field name="state">code</field>
<field name="code">model.action_backup_all()</field>
</record>
</odoo>
15 changes: 15 additions & 0 deletions auto_backup/data/mail_message_subtype.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="mail_message_subtype_success" model="mail.message.subtype">
<field name="name">Backup Successful</field>
<field name="description">Database backup succeeded.</field>
<field name="res_model">db.backup</field>
<field name="default" eval="False" />
</record>
<record id="mail_message_subtype_failure" model="mail.message.subtype">
<field name="name">Backup Failed</field>
<field name="description">Database backup failed.</field>
<field name="res_model">db.backup</field>
<field name="default" eval="True" />
</record>
</odoo>
Loading
Loading