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.

143 lines
5.2 KiB

  1. =============
  2. MuK Converter
  3. =============
  4. Technical module to provide some utility features and libraries that can be used
  5. in other applications. This module has no direct effect on the running system.
  6. Requirements
  7. =============
  8. The requirements are only to be fulfilled if the module is not used with the IAP service.
  9. unoconv
  10. -------------
  11. Universal Office Converter (unoconv) is a command line tool to convert any
  12. document format that LibreOffice can import to any document format that
  13. LibreOffice can export. It makes use of the LibreOffice's UNO bindings for
  14. non-interactive conversion of documents.
  15. To install unoconv please follow the instructions (`here <https://github.com/dagwieers/unoconv>`_).
  16. Make sure that unoconv can be executed from the console and the conversion
  17. is done correctly.
  18. To set an individual path for the LibreOffice installation, the config
  19. variable ``uno_path`` can be set accordingly in the Odoo config.
  20. Under Windows you should rename the ``unoconv`` file to ``unoconv.py`` and set
  21. the corresponding path for the ``uno_path`` variable. Since it does not work
  22. reliably with the environment variable ``UNO_PATH``.
  23. Installation
  24. ============
  25. To install this module, you need to:
  26. Download the module and add it to your Odoo addons folder. Afterward, log on to
  27. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  28. list by clicking on the "Update Apps List" link. Now install the module by
  29. clicking on the install button.
  30. Another way to install this module is via the package management for Python
  31. (`PyPI <https://pypi.org/project/pip/>`_).
  32. To install our modules using the package manager make sure
  33. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  34. correctly. Then open a console and install the module by entering the following
  35. command:
  36. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  37. The module name consists of the Odoo version and the module name, where
  38. underscores are replaced by a dash.
  39. **Module:**
  40. ``odoo<version>-addon-<module_name>``
  41. **Example:**
  42. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  43. Once the installation has been successfully completed, the app is already in the
  44. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  45. debug mode and update the list by clicking on the "Update Apps List" link. Now
  46. install the module by clicking on the install button.
  47. The biggest advantage of this variant is that you can now also update the app
  48. using the "pip" command. To do this, enter the following command in your console:
  49. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  50. When the process is finished, restart your server and update the application in
  51. Odoo. The steps are the same as for the installation only the button has changed
  52. from "Install" to "Upgrade".
  53. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  54. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  55. For modules licensed under OPL-1, you will receive access data when you purchase
  56. the module. If the modules were not purchased directly from
  57. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  58. with a confirmation of purchase to receive the corresponding access data.
  59. Upgrade
  60. ============
  61. To upgrade this module, you need to:
  62. Download the module and add it to your Odoo addons folder. Restart the server
  63. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  64. clicking on the upgrade button.
  65. If you installed the module using the "pip" command, you can also update the
  66. module in the same way. Just type the following command into the console:
  67. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  68. When the process is finished, restart your server and update the application in
  69. Odoo, just like you would normally.
  70. Configuration
  71. =============
  72. The converter uses a store to avoid the repeated conversion of the same file.
  73. To avoid unnecessary memory consumption, Odoo's AutoVaccum Cron Job empties
  74. the store accordingly. The system parameter ``muk_converter.max_store`` can
  75. be used to set the maximum number of elements that can be in the store after
  76. cleaning. By default, this value is set to 20.
  77. Usage
  78. =============
  79. This module has no direct visible effect on the system. It provides functions
  80. to convert data from one file format to another.
  81. Credits
  82. =======
  83. Contributors
  84. ------------
  85. * Mathias Markl <mathias.markl@mukit.at>
  86. Images
  87. ------------
  88. Some pictures are based on or inspired by the icon set of Font Awesome:
  89. * `Font Awesome <https://fontawesome.com>`_
  90. Author & Maintainer
  91. -------------------
  92. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  93. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  94. We develop custom solutions for your individual needs to help you focus on
  95. your strength and expertise to grow your business.
  96. If you want to get in touch please contact us via mail
  97. (sale@mukit.at) or visit our website (https://mukit.at).