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.

74 lines
2.4 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. ==========================
  4. Dead man's switch (client)
  5. ==========================
  6. This module is the client part of `dead_mans_switch_server`. It is responsible
  7. of sending the server status updates, which in turn takes action if those
  8. updates don't come in time.
  9. Configuration
  10. =============
  11. After installing this module, you need to fill in the system parameter
  12. ``dead_mans_switch_client.url``. This must be the full URL to the server's
  13. controller, usually of the form ``https://your.server/dead_mans_switch/alive``.
  14. This module attempts to send CPU and RAM statistics to the server. While this
  15. is not mandatory, it's helpful for assessing a server's health. If you want
  16. this, you need to install ``psutil``.
  17. You can also have the number of currently online users logged, but this only
  18. works if the ``bus`` module is installed and longpolling configured correctly.
  19. Usage
  20. =====
  21. This module doesn't have any visible effect on the client.
  22. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  23. :alt: Try me on Runbot
  24. :target: https://runbot.odoo-community.org/runbot/149/9.0
  25. For further information, please visit:
  26. * https://www.odoo.com/forum/help-1
  27. Known issues / Roadmap
  28. ======================
  29. * certificate pinning would be nice
  30. Bug Tracker
  31. ===========
  32. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  33. In case of trouble, please check there if your issue has already been reported.
  34. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  35. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20dead_mans_switch_client%0Aversion:%209.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  36. Credits
  37. =======
  38. Contributors
  39. ------------
  40. * Holger Brunn <hbrunn@therp.nl>
  41. * Jairo Llopis <yajo.sk8@gmail.com>
  42. Maintainer
  43. ----------
  44. .. image:: https://odoo-community.org/logo.png
  45. :alt: Odoo Community Association
  46. :target: https://odoo-community.org
  47. This module is maintained by the OCA.
  48. OCA, or the Odoo Community Association, is a nonprofit organization whose
  49. mission is to support the collaborative development of Odoo features and
  50. promote its widespread use.
  51. To contribute to this module, please visit https://odoo-community.org.