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.

98 lines
2.8 KiB

10 years ago
10 years ago
  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. Automated backups
  4. ===========
  5. A tool for all your back-ups, internal and external!
  6. Installation
  7. ============
  8. Before to install this module, you need to:
  9. instal pysftp via pip.
  10. Configuration
  11. =============
  12. Go to Settings -> Configuration -> Configure Backup
  13. create your configurations for each database that you needed
  14. to backups.
  15. Usage
  16. =====
  17. Keep your Odoo data safe with this module. Take automated back-ups,
  18. remove them automatically and even write them to an external server
  19. through an encrypted tunnel. You can even specify how long local backups
  20. and external backups should be kept, automatically!
  21. Connect with an FTP Server
  22. --------------------------
  23. #### Keep your data safe, through an SSH tunnel!
  24. Want to go even further and write your backups to an external server?
  25. You can with this module! Specify the credentials to the server, specify
  26. a path and everything will be backed up automatically. This is done
  27. through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
  28. safe!
  29. Test connection
  30. ---------------
  31. #### Checks your credentials in one click
  32. Want to make sure if the connection details are correct and if Odoo can
  33. automatically write them to the remote server? Simply click on the ‘Test
  34. SFTP Connection’ button and you will get message telling you if
  35. everything is OK, or what is wrong!
  36. E-mail on backup failure
  37. ------------------------
  38. #### Stay informed of problems, automatically!
  39. Do you want to know if the database backup failed? Check the checkbox 'Auto. E-mail on backup fail' and fill in your e-mail.
  40. Every time a backup fails you will get an e-mail in your mailbox with technical details.
  41. Known issues / Roadmap
  42. ======================
  43. * ...
  44. Bug Tracker
  45. ===========
  46. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  47. In case of trouble, please check there if your issue has already been reported.
  48. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  49. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20auto_backup%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  50. Credits
  51. =======
  52. Contributors
  53. ------------
  54. * Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
  55. * Alessio Gerace <alessio.gerace@agilebg.com>
  56. Maintainer
  57. ----------
  58. .. image:: https://odoo-community.org/logo.png
  59. :alt: Odoo Community Association
  60. :target: https://odoo-community.org
  61. This module is maintained by the OCA.
  62. OCA, or the Odoo Community Association, is a nonprofit organization whose
  63. mission is to support the collaborative development of Odoo features and
  64. promote its widespread use.
  65. To contribute to this module, please visit http://odoo-community.org.