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.

161 lines
5.1 KiB

  1. =================
  2. MuK Session Store
  3. =================
  4. In a distributed system the filestore based session store of Odoo has the problem that
  5. unwanted session timeouts occur regularly. This module offers two additional options for
  6. the Session Store. Sessions can be stored either in a Redis database or directly in
  7. Postgres. Both options have the advantage that the session information can also be queried
  8. in a distributed system.
  9. Requirements
  10. ============
  11. The requirements are only required if Redis is used as the session store.
  12. Redis
  13. -------------
  14. A interface to the Redis key-value store for Python. To install Redis please follow the
  15. `instructions <https://github.com/andymccurdy/redis-py>`_ or install the library via pip.
  16. ``pip install redis``
  17. Installation
  18. ============
  19. To install this module, you need to:
  20. Download the module and add it to your Odoo addons folder. Afterward, log on to
  21. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  22. list by clicking on the "Update Apps List" link. Now install the module by
  23. clicking on the install button.
  24. Another way to install this module is via the package management for Python
  25. (`PyPI <https://pypi.org/project/pip/>`_).
  26. To install our modules using the package manager make sure
  27. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  28. correctly. Note that for Odoo version 11.0 and later this is not necessary anymore.
  29. Then open a console and install the module by entering the following command:
  30. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  31. The module name consists of the Odoo version and the module name, where
  32. underscores are replaced by a dash.
  33. **Module:**
  34. ``odoo<version>-addon-<module_name>``
  35. **Example:**
  36. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils``
  37. Once the installation has been successfully completed, the app is already in the
  38. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  39. debug mode and update the list by clicking on the "Update Apps List" link. Now
  40. install the module by clicking on the install button.
  41. The biggest advantage of this variant is that you can now also update the app
  42. using the "pip" command. To do this, enter the following command in your console:
  43. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  44. When the process is finished, restart your server and update the application in
  45. Odoo. The steps are the same as for the installation only the button has changed
  46. from "Install" to "Upgrade".
  47. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  48. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  49. For modules licensed under a proprietary license, you will receive the access data after you purchased
  50. the module. If the purchase were made at the Odoo store please contact our `support <support@mukit.at>`_
  51. with a confirmation of the purchase to receive the corresponding access data.
  52. Upgrade
  53. ============
  54. To upgrade this module, you need to:
  55. Download the module and add it to your Odoo addons folder. Restart the server
  56. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  57. clicking on the upgrade button.
  58. If you installed the module using the "pip" command, you can also update the
  59. module in the same way. Just type the following command into the console:
  60. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  61. When the process is finished, restart your server and update the application in
  62. Odoo, just like you would normally.
  63. Configuration
  64. =============
  65. Since this module need to be activated even if no database is selected it should
  66. be loaded right at the server start. This can be done by editing the configuration
  67. file or passing a load parameter to the start script.
  68. Parameter: ``--load=web,muk_session_store``
  69. The following fields can be modified in the config file:
  70. **Store:**
  71. * session_store_database
  72. * session_store_redis
  73. **Postgres:**
  74. * session_store_dbname
  75. * session_store_dbtable
  76. **Redis:**
  77. * session_store_prefix
  78. * session_store_host
  79. * session_store_port
  80. * session_store_dbindex
  81. * session_store_pass
  82. Usage
  83. =====
  84. After setting the parameters, the session store is used automatically.
  85. Credit
  86. ======
  87. Contributors
  88. ------------
  89. * Mathias Markl <mathias.markl@mukit.at>
  90. Images
  91. ------
  92. Some pictures are based on or inspired by the icon set of Font Awesome:
  93. * `Font Awesome <https://fontawesome.com>`_
  94. Projects
  95. --------
  96. Parts of the module are inspired by:
  97. * `PSQL Session Store <https://github.com/it-projects-llc/misc-addons>`_
  98. Author & Maintainer
  99. -------------------
  100. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  101. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  102. We develop custom solutions for your individual needs to help you focus on
  103. your strength and expertise to grow your business.
  104. If you want to get in touch please contact us via `mail <sale@mukit.at>`_
  105. or visit our `website <https://mukit.at>`_.