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.

120 lines
4.1 KiB

  1. ============
  2. MuK Security
  3. ============
  4. Technical module to provide some utility and security features that can be used
  5. in other applications. This module has no direct effect on the running system.
  6. Installation
  7. ============
  8. To install this module, you need to:
  9. Download the module and add it to your Odoo addons folder. Afterward, log on to
  10. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  11. list by clicking on the "Update Apps List" link. Now install the module by
  12. clicking on the install button.
  13. Another way to install this module is via the package management for Python
  14. (`PyPI <https://pypi.org/project/pip/>`_).
  15. To install our modules using the package manager make sure
  16. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  17. correctly. Then open a console and install the module by entering the following
  18. command:
  19. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  20. The module name consists of the Odoo version and the module name, where
  21. underscores are replaced by a dash.
  22. **Module:**
  23. ``odoo<version>-addon-<module_name>``
  24. **Example:**
  25. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  26. Once the installation has been successfully completed, the app is already in the
  27. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  28. debug mode and update the list by clicking on the "Update Apps List" link. Now
  29. install the module by clicking on the install button.
  30. The biggest advantage of this variant is that you can now also update the app
  31. using the "pip" command. To do this, enter the following command in your console:
  32. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  33. When the process is finished, restart your server and update the application in
  34. Odoo. The steps are the same as for the installation only the button has changed
  35. from "Install" to "Upgrade".
  36. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  37. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  38. For modules licensed under OPL-1, you will receive access data when you purchase
  39. the module. If the modules were not purchased directly from
  40. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  41. with a confirmation of purchase to receive the corresponding access data.
  42. Upgrade
  43. ============
  44. To upgrade this module, you need to:
  45. Download the module and add it to your Odoo addons folder. Restart the server
  46. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  47. clicking on the upgrade button.
  48. If you installed the module using the "pip" command, you can also update the
  49. module in the same way. Just type the following command into the console:
  50. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  51. When the process is finished, restart your server and update the application in
  52. Odoo, just like you would normally.
  53. Configuration
  54. =============
  55. No additional configuration is needed to use this module.
  56. Usage
  57. =============
  58. This module has no direct visible effect on the system. It provide security features.
  59. Credits
  60. =======
  61. Contributors
  62. ------------
  63. * Mathias Markl <mathias.markl@mukit.at>
  64. Images
  65. ------------
  66. Some pictures are based on or inspired by the icon set of Font Awesome:
  67. * `Font Awesome <https://fontawesome.com>`_
  68. Projects
  69. ------------
  70. Parts of the module are based on or inspired by:
  71. * `Suspend Security <https://github.com/OCA/server-backend>`_
  72. Author & Maintainer
  73. -------------------
  74. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  75. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  76. We develop custom solutions for your individual needs to help you focus on
  77. your strength and expertise to grow your business.
  78. If you want to get in touch please contact us via mail
  79. (sale@mukit.at) or visit our website (https://mukit.at).