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.

157 lines
6.0 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
6 years ago
6 years ago
6 years ago
  1. ==============
  2. MuK Thumbnails
  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. FFmpeg
  23. -------------
  24. FFmpeg is a complete, cross-platform solution to record, convert and stream audio and video.
  25. To install FFmpeg please follow the instructions (`here <https://www.ffmpeg.org/download.html>`_).
  26. Ghostscript
  27. -------------
  28. Ghostscript is a suite of software based on an interpreter for Adobe Systems PostScript and
  29. Portable Document Format (PDF) page description languages. Its main purposes are the
  30. rasterization or rendering of such page description language files, for the display or printing
  31. of document pages, and the conversion between PostScript and PDF files.
  32. To install Ghostscript please follow the instructions (`here <https://www.ghostscript.com/download.html>`_).
  33. ImageMagick
  34. -------------
  35. ImageMagick can be used to create, edit, compose, or convert bitmap images. It can read and write
  36. images in a variety of formats (over 200) including PNG, JPEG, GIF, HEIC, TIFF, DPX, EXR, WebP,
  37. Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and
  38. transform images, adjust image colors, apply various special effects, or draw text, lines, polygons,
  39. ellipses and Bezier curves.
  40. To install ImageMagick please follow the instructions (`here <https://www.imagemagick.org/script/download.php>`_).
  41. Installation
  42. ============
  43. To install this module, you need to:
  44. Download the module and add it to your Odoo addons folder. Afterward, log on to
  45. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  46. list by clicking on the "Update Apps List" link. Now install the module by
  47. clicking on the install button.
  48. Another way to install this module is via the package management for Python
  49. (`PyPI <https://pypi.org/project/pip/>`_).
  50. To install our modules using the package manager make sure
  51. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  52. correctly. Then open a console and install the module by entering the following
  53. command:
  54. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  55. The module name consists of the Odoo version and the module name, where
  56. underscores are replaced by a dash.
  57. **Module:**
  58. ``odoo<version>-addon-<module_name>``
  59. **Example:**
  60. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  61. Once the installation has been successfully completed, the app is already in the
  62. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  63. debug mode and update the list by clicking on the "Update Apps List" link. Now
  64. install the module by clicking on the install button.
  65. The biggest advantage of this variant is that you can now also update the app
  66. using the "pip" command. To do this, enter the following command in your 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. The steps are the same as for the installation only the button has changed
  70. from "Install" to "Upgrade".
  71. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  72. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  73. For modules licensed under OPL-1, you will receive access data when you purchase
  74. the module. If the modules were not purchased directly from
  75. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  76. with a confirmation of purchase to receive the corresponding access data.
  77. Upgrade
  78. ============
  79. To upgrade this module, you need to:
  80. Download the module and add it to your Odoo addons folder. Restart the server
  81. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  82. clicking on the upgrade button.
  83. If you installed the module using the "pip" command, you can also update the
  84. module in the same way. Just type the following command into the console:
  85. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  86. When the process is finished, restart your server and update the application in
  87. Odoo, just like you would normally.
  88. Configuration
  89. =============
  90. No additional configuration is needed to use this module.
  91. Usage
  92. =============
  93. This module has no direct visible effect on the system. It provide utility features.
  94. Credits
  95. =======
  96. Contributors
  97. ------------
  98. * Mathias Markl <mathias.markl@mukit.at>
  99. Author & Maintainer
  100. -------------------
  101. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  102. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  103. We develop custom solutions for your individual needs to help you focus on
  104. your strength and expertise to grow your business.
  105. If you want to get in touch please contact us via mail
  106. (sale@mukit.at) or visit our website (https://mukit.at).