# Database Auto-Backup

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

Table of contents

- Installation
- Configuration
- Usage
  - Connect with an FTP Server
    - Keep your data safe, through an SSH tunnel!
  - Test connection
    - Checks your credentials in one click
  - E-mail on backup failure
    - Stay informed of problems, automatically!
  - Run backups when you want
- Known issues / Roadmap
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

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

## 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.
- Backups won’t work if list_db=False is configured in the instance.

## Bug Tracker

Bugs are tracked on GitHub 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.

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 <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>
- Simone Vanin <simone.vanin@agilebg.com>
- Vu Nguyen Anh <vuna2004@gmail.com>
- Alex Comba <alex.comba@agilebg.com>

### Maintainers

This module is maintained by the OCA.

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 project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.