You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

117 lines
3.5 KiB

  1. .. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
  2. :target: https://www.gnu.org/licenses/agpl
  3. :alt: License: AGPL-3
  4. ====================
  5. Database Auto-Backup
  6. ====================
  7. A tool for all your back-ups, internal and external!
  8. Installation
  9. ============
  10. Before installing this module, you need to execute::
  11. pip3 install pysftp
  12. Configuration
  13. =============
  14. Go to *Settings -> Database Structure -> Automated Backup* to
  15. create your configurations for each database that you needed
  16. to backups.
  17. Usage
  18. =====
  19. Keep your Odoo data safe with this module. Take automated back-ups,
  20. remove them automatically and even write them to an external server
  21. through an encrypted tunnel. You can even specify how long local backups
  22. and external backups should be kept, automatically!
  23. Connect with an FTP Server
  24. --------------------------
  25. Keep your data safe, through an SSH tunnel!
  26. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  27. Want to go even further and write your backups to an external server?
  28. You can with this module! Specify the credentials to the server, specify
  29. a path and everything will be backed up automatically. This is done
  30. through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
  31. safe!
  32. Test connection
  33. ---------------
  34. Checks your credentials in one click
  35. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36. Want to make sure if the connection details are correct and if Odoo can
  37. automatically write them to the remote server? Simply click on the ‘Test
  38. SFTP Connection’ button and you will get message telling you if
  39. everything is OK, or what is wrong!
  40. E-mail on backup failure
  41. ------------------------
  42. Stay informed of problems, automatically!
  43. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44. Do you want to know if the database backup succeeded or failed? Subscribe to
  45. the corresponding backup setting notification type.
  46. Run backups when you want
  47. -------------------------
  48. From the backups configuration list, press *More > Execute backup(s)* to
  49. manually execute the selected processes.
  50. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  51. :alt: Try me on Runbot
  52. :target: https://runbot.odoo-community.org/runbot/149/11.0
  53. Known issues / Roadmap
  54. ======================
  55. * On larger databases, it is possible that backups will die due to Odoo server
  56. settings. In order to circumvent this without frivolously changing settings,
  57. you need to run the backup from outside of the main Odoo instance. How to do
  58. this is outlined in `this blog post
  59. <https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_.
  60. Bug Tracker
  61. ===========
  62. Bugs are tracked on `GitHub Issues
  63. <https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
  64. check there if your issue has already been reported. If you spotted it first,
  65. help us smash it by providing detailed and welcomed feedback.
  66. Credits
  67. =======
  68. Contributors
  69. ------------
  70. * Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
  71. * Alessio Gerace <alessio.gerace@agilebg.com>
  72. * Jairo Llopis <yajo.sk8@gmail.com>
  73. * Dave Lasley <dave@laslabs.com>
  74. * Andrea Stirpe <a.stirpe@onestein.nl>
  75. Maintainer
  76. ----------
  77. .. image:: https://odoo-community.org/logo.png
  78. :alt: Odoo Community Association
  79. :target: https://odoo-community.org
  80. This module is maintained by the OCA.
  81. OCA, or the Odoo Community Association, is a nonprofit organization whose
  82. mission is to support the collaborative development of Odoo features and
  83. promote its widespread use.
  84. To contribute to this module, please visit https://odoo-community.org.