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.

157 lines
5.2 KiB

  1. ====================
  2. Database Auto-Backup
  3. ====================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/auto_backup
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-auto_backup
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. A tool for all your back-ups, internal and external!
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Installation
  29. ============
  30. Before installing this module, you need to execute::
  31. pip3 install pysftp==0.2.8
  32. Configuration
  33. =============
  34. Go to *Settings -> Database Structure -> Automated Backup* to
  35. create your configurations for each database that you needed
  36. to backups.
  37. Usage
  38. =====
  39. Keep your Odoo data safe with this module. Take automated back-ups,
  40. remove them automatically and even write them to an external server
  41. through an encrypted tunnel. You can even specify how long local backups
  42. and external backups should be kept, automatically!
  43. Connect with an FTP Server
  44. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  45. Keep your data safe, through an SSH tunnel!
  46. -------------------------------------------
  47. Want to go even further and write your backups to an external server?
  48. You can with this module! Specify the credentials to the server, specify
  49. a path and everything will be backed up automatically. This is done
  50. through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
  51. safe!
  52. Test connection
  53. ~~~~~~~~~~~~~~~
  54. Checks your credentials in one click
  55. ------------------------------------
  56. Want to make sure if the connection details are correct and if Odoo can
  57. automatically write them to the remote server? Simply click on the ‘Test
  58. SFTP Connection’ button and you will get message telling you if
  59. everything is OK, or what is wrong!
  60. E-mail on backup failure
  61. ~~~~~~~~~~~~~~~~~~~~~~~~
  62. Stay informed of problems, automatically!
  63. -----------------------------------------
  64. Do you want to know if the database backup succeeded or failed? Subscribe to
  65. the corresponding backup setting notification type.
  66. Run backups when you want
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~
  68. From the backups configuration list, press *More > Execute backup(s)* to
  69. manually execute the selected processes.
  70. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  71. :alt: Try me on Runbot
  72. :target: https://runbot.odoo-community.org/runbot/149/11.0
  73. Known issues / Roadmap
  74. ======================
  75. * On larger databases, it is possible that backups will die due to Odoo server
  76. settings. In order to circumvent this without frivolously changing settings,
  77. you need to run the backup from outside of the main Odoo instance. How to do
  78. this is outlined in `this blog post
  79. <https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_.
  80. * Backups won't work if list_db=False is configured in the instance.
  81. Bug Tracker
  82. ===========
  83. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  84. In case of trouble, please check there if your issue has already been reported.
  85. If you spotted it first, help us smashing it by providing a detailed and welcomed
  86. `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**>`_.
  87. Do not contact contributors directly about support or help with technical issues.
  88. Credits
  89. =======
  90. Authors
  91. ~~~~~~~
  92. * Yenthe Van Ginneken
  93. * Agile Business Group
  94. * Grupo ESOC Ingenieria de Servicios
  95. * LasLabs
  96. * AdaptiveCity
  97. Contributors
  98. ~~~~~~~~~~~~
  99. * Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
  100. * Alessio Gerace <alessio.gerace@agilebg.com>
  101. * Jairo Llopis <yajo.sk8@gmail.com>
  102. * Dave Lasley <dave@laslabs.com>
  103. * Andrea Stirpe <a.stirpe@onestein.nl>
  104. * Aitor Bouzas <aitor.bouzas@adaptivecity.com>
  105. Maintainers
  106. ~~~~~~~~~~~
  107. This module is maintained by the OCA.
  108. .. image:: https://odoo-community.org/logo.png
  109. :alt: Odoo Community Association
  110. :target: https://odoo-community.org
  111. OCA, or the Odoo Community Association, is a nonprofit organization whose
  112. mission is to support the collaborative development of Odoo features and
  113. promote its widespread use.
  114. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/auto_backup>`_ project on GitHub.
  115. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.