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

  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. To configure this module, you need to:
  13. * go to ...
  14. Usage
  15. =====
  16. Keep your Odoo data safe with this module. Take automated back-ups,
  17. remove them automatically and even write them to an external server
  18. through an encrypted tunnel. You can even specify how long local backups
  19. and external backups should be kept, automatically!
  20. Connect with an FTP Server
  21. --------------------------
  22. #### Keep your data safe, through an SSH tunnel!
  23. Want to go even further and write your backups to an external server?
  24. You can with this module! Specify the credentials to the server, specify
  25. a path and everything will be backed up automatically. This is done
  26. through an SSH (encrypted) tunnel, thanks to pysftp, so your data is
  27. safe!
  28. Test connection
  29. ---------------
  30. #### Checks your credentials in one click
  31. Want to make sure if the connection details are correct and if Odoo can
  32. automatically write them to the remote server? Simply click on the ‘Test
  33. SFTP Connection’ button and you will get message telling you if
  34. everything is OK, or what is wrong!
  35. E-mail on backup failure
  36. ------------------------
  37. #### Stay informed of problems, automatically!
  38. 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.
  39. Every time a backup fails you will get an e-mail in your mailbox with technical details.
  40. Known issues / Roadmap
  41. ======================
  42. * ...
  43. Bug Tracker
  44. ===========
  45. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  46. In case of trouble, please check there if your issue has already been reported.
  47. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  48. `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**>`_.
  49. Credits
  50. =======
  51. Contributors
  52. ------------
  53. * Yenthe Van Ginneken <email.address@example.org>
  54. * Alessio Gerace <alessio.gerace@agilebg.com>
  55. Maintainer
  56. ----------
  57. .. image:: https://odoo-community.org/logo.png
  58. :alt: Odoo Community Association
  59. :target: https://odoo-community.org
  60. This module is maintained by the OCA.
  61. OCA, or the Odoo Community Association, is a nonprofit organization whose
  62. mission is to support the collaborative development of Odoo features and
  63. promote its widespread use.
  64. To contribute to this module, please visit http://odoo-community.org.