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.

133 lines
5.1 KiB

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